Domain name for API request: organization.tencentcloudapi.com.
This API is used to query the permission configuration list.
A maximum of 20 requests can be initiated per second for this API.
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: ListRoleConfigurations. |
Version | Yes | String | Common Params. The value used for this API: 2021-03-31. |
Region | No | String | Common Params. This parameter is not required. |
ZoneId | Yes | String | Space ID. |
NextToken | No | String | Token for querying the next page of returned results. During use of the API for the first time, NextToken is not needed. When you call the API for the first time, if the total number of returned data entries exceeds the MaxResults limit, the data is truncated and only MaxResults data entries are returned. Meanwhile, the return parameter IsTruncated is true and a NextToken is returned. You can use the NextToken returned last time to continue calling the API with other request parameters unchanged, to query the truncated data. You can use this method for multiple queries until IsTruncated is false, indicating that all data has been queried. |
MaxResults | No | Integer | Maximum number of data entries per page. Value range: 1-100. Default value: 10. |
Filter | No | String | Filter criterion, case-insensitive. Currently, only RoleConfigurationName is supported, and only eq (Equals) and sw (Starts With) are supported. For example, Filter = "RoleConfigurationName, sw test" indicates querying all access configurations with names starting with test; Filter = "RoleConfigurationName, eq TestRoleConfiguration" indicates querying the access configuration with the name TestRoleConfiguration. |
FilterTargets.N | No | Array of Integer | Check whether the member account has been configured with permissions. If configured, return IsSelected: true; otherwise, return false. |
PrincipalId | No | String | UserId of the authorized user or GroupId of the authorized user group, which must be set together with the input parameter FilterTargets. |
Parameter Name | Type | Description |
---|---|---|
TotalCounts | Integer | Total number of data entries that meet the request parameter conditions. |
MaxResults | Integer | Maximum number of data entries per page. |
IsTruncated | Boolean | Whether the returned result is truncated. Valid values: true: truncated; false: not truncated. |
NextToken | String | Token for querying the next page of returned results. Note: This parameter is displayed only when IsTruncated is true. |
RoleConfigurations | Array of RoleConfiguration | Permission configuration list. |
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. |
This example shows you how to query the permission configuration list.
POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListRoleConfiguration
<Common request parameters>
{
"ZoneId": "z-s9h39sdn2",
"NextToken": "sisndpmfisdnlk",
"MaxResults": 10,
"Filter": "RoleConfigurationName eqTestRoleConfiguration"
}
{
"Response": {
"TotalCounts": 20,
"MaxResults": 10,
"IsTruncated": true,
"NextToken": "3si2ns92ns82bos",
"RoleConfigurations": [
{
"RoleConfigurationId": "rc-s2ns92ns***",
"RoleConfigurationName": "test",
"Description": "this is role configuration",
"SessionDuration": 900,
"RelayState": "https://console.tencentcloud.com",
"CreateTime": "2019-01-01 12:12:12",
"UpdateTime": "2019-01-01 12:12:12"
}
],
"RequestId": "e297543a-80de-4039-83c8-9d324545"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.DBOperationError | SQL execution error. |
FailedOperation.IdentityCenterNotOpen | The CIC service is not enabled. |
FailedOperation.ZoneIdNotExist | The user zoneId of the CIC service does not exist. |
InvalidParameter.NextTokenInvalid | Invalid nextToken. |
InvalidParameter.ParamError | Parameter error. |
Was this page helpful?