DescribeUserRoleList

Last updated: 2025-11-13 21:02:40

DescribeUserRoleList

Last updated: 2025-11-13 21:02:40

1. API Description

Domain name for API request: bi.intl.tencentcloudapi.com.

This API is used to obtain the user role list.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeUserRoleList.
Version	Yes	String	Common Params. The value used for this API: 2022-01-05.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
PageNo	Yes	Integer	Page number.
PageSize	Yes	Integer	Number of pages.
AllPage	No	Boolean	All page numbers.
UserType	No	String	0: enterprise user. 1: visitor. If left blank, it indicates all users.
Keyword	No	String	Keyword for fuzzy search.
ProjectId	No	String	Project ID.
IsOnlyBindAppUser	No	Boolean	Whether to only obtain users bound to the WeCom app.

3. Output Parameters

Parameter Name	Type	Description
ErrorInfo	ErrorInfo	Custom error information object. Note: This field may return null, indicating that no valid values can be obtained.
Extra	String	Extension description information (providing more exception messages for auxiliary judgment). Note: This field may return null, indicating that no valid values can be obtained.
Data	UserRoleListData	Data. Note: This field may return null, indicating that no valid values can be obtained.
Msg	String	Message. Note: This field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Viewing User Information List

This example shows you how to view the user information list.

Input Example

POST / HTTP/1.1
Host: bi.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserRoleList
<Common request parameters>

{
    "PageNo": 1982493789748932,
    "PageSize": 1982493789748932,
    "AllPage": false,
    "UserType": "UserType",
    "Keyword": "Keyword",
    "ProjectId": "ProjectId",
    "IsOnlyBindAppUser": false
}

Output Example

{
    "Response": {
        "ErrorInfo": {
            "ErrorTip": "",
            "ErrorLevel": "INFO",
            "DocLink": "",
            "FAQ": "",
            "ReservedField": ""
        },
        "Extra": "",
        "Data": {
            "Total": 0,
            "TotalPages": 0,
            "List": [
                {
                    "Id": 1,
                    "RoleList": [
                        {
                            "RoleName": "Enterprise administrator",
                            "RoleId": 0,
                            "ProjectId": 0,
                            "ProjectName": "Test project",
                            "ScopeType": 0,
                            "ModuleCollection": "datasource"
                        }
                    ],
                    "RoleIdList": [
                        1
                    ],
                    "UserId": "10210",
                    "UserName": "zhangsan",
                    "CorpId": "30310",
                    "Email": "123***@qq.com",
                    "CreatedUser": "zhangsan",
                    "CreatedAt": "2020-09-22 00:00:00",
                    "UpdatedUser": "zhangsan",
                    "UpdatedAt": "2020-09-22 00:00:00",
                    "LastLogin": "2020-09-22T00:00:00+00:00",
                    "Status": 0,
                    "PhoneNumber": "86312***212",
                    "AreaCode": "086",
                    "RootAccount": true,
                    "CorpAdmin": true,
                    "AppUserId": "2102",
                    "AppUserAliasName": "zhangsan",
                    "AppUserName": "zhangsan",
                    "InValidateAppRange": true
                }
            ]
        },
        "Msg": "Successful",
        "RequestId": ""
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError.Internal	Internal error.
MissingParameter.MissingParam	The required parameter is missing.
UnauthorizedOperation.Authorize	Permission error.
UnauthorizedOperation.Inactive	User is not enabled.
UnauthorizedOperation.UserNotExist	The user does not exist.
UnsupportedOperation.BIError	Default business exception.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud