tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ListPermissionPoliciesInRoleConfiguration

Last updated: 2024-08-26 11:25:38

1. API Description

Domain name for API request: organization.tencentcloudapi.com.

This API is used to obtain the policy list in permission configurations.

A maximum of 20 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: ListPermissionPoliciesInRoleConfiguration.
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.
RoleConfigurationId Yes String Permission configuration ID.
RolePolicyType No String Permission policy type. Valid values: System: system policy, namely the CAM system policy reused; Custom: custom policy, namely the custom policy prepared according to the CAM permission policy syntax and structure.
Filter No String Search by policy name.

3. Output Parameters

Parameter Name Type Description
TotalCounts Integer Total number of permission policies.
RolePolicies Array of RolePolicie Permission policy 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.

4. Example

Example1 Obtaining the Policy List in Permission Configurations

This example shows you how to obtain the policy list in permission configurations.

Input Example

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

{
    "ZoneId": "z-d83js823n",
    "RoleConfigurationId": "rc-s93jw3ns",
    "RolePolicyType": "System"
}

Output Example

{
    "Response": {
        "TotalCounts": 20,
        "RolePolicies": [
            {
                "RolePolicyName": "adminPolciy",
                "RolePolicyType": "System",
                "RolePolicyDocument": "",
                "AddTime": "2020-01-01 12:12:12"
            }
        ],
        "RequestId": "e297543a-80de-4039-83c8-9d324545"
    }
}

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

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
FailedOperation.IdentityCenterNotOpen The CIC service is not enabled.
FailedOperation.ZoneIdNotExist The user zoneId of the CIC service does not exist.
InvalidParameter.RoleConfigurationNotExist The permission configuration does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy