tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AddPermissionPolicyToRoleConfiguration

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

1. API Description

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

This API is used to add policies to 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: AddPermissionPolicyToRoleConfiguration.
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 Yes 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. Only the system policy is supported at the early stage, and the custom policy will be supported later.
RolePolicyNames.N No Array of String Permission policy name, which includes up to 20 policies, each containing up to 32 characters.
RolePolicies.N No Array of PolicyDetail Policy details.
CustomPolicyDocument No String Custom policy content, which contains up to 4096 characters. When RolePolicyType is Inline, this parameter must be configured. For details, see the permission policy syntax and structure.

3. Output Parameters

Parameter Name Type Description
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 Adding Policies to Permission Configurations

This example shows you how to add policies to permission configurations.

Input Example

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

{
    "ZoneId": "z-29wm2iwn",
    "RoleConfigurationId": "rc-aiwmsiw",
    "RolePolicyType": "System",
    "RolePolicyNames": [
        "TestPolicy"
    ],
    "CustomPolicyDocument": ""
}

Output Example

{
    "Response": {
        "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.CustomPolicyOverUpperLimit Custom policies bound to the permission configuration exceed the upper limit.
FailedOperation.DBOperationError SQL execution error.
FailedOperation.IdentityCenterNotOpen The CIC service is not enabled.
FailedOperation.SystemPolicyOverUpperLimit System policies bound to the permission configuration exceed the upper limit.
FailedOperation.ZoneIdNotExist The user zoneId of the CIC service does not exist.
InvalidParameter.BindPolicyNameNotAllowed The permission configuration cannot be bound to this policy.
InvalidParameter.ParamError Parameter error.
InvalidParameter.PolicyDocumentEmpty The custom policy content cannot be empty.
InvalidParameter.PolicyNameAlreadyExists The policy name already exists.
InvalidParameter.PolicyNameSizeOverUpperLimit The policy name exceeds the length limit.
InvalidParameter.RoleConfigurationNotExist The permission configuration does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy