tencent cloud

Cloud Access Management

DocumentationCloud Access ManagementAPI DocumentationRole APIsAttachRolePolicy

AttachRolePolicy

Download
Focus Mode
Font Size
Last updated: 2026-05-14 21:02:00

1. API Description

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

This API (AttachRolePolicy) is used to associate a policy with a role.

A maximum of 3 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: AttachRolePolicy.
Version Yes String Common Params. The value used for this API: 2019-01-16.
Region No String Common Params. This parameter is not required.
PolicyId No Integer Policy ID. Either PolicyId or PolicyName must be entered
AttachRoleId No String Role ID, used to specify a role. Input either AttachRoleId or AttachRoleName
AttachRoleName No String Role name, used to specify a role. Input either AttachRoleId or AttachRoleName
PolicyName No String Policy name. Either PolicyId or PolicyName must be entered

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 Associating a permissions policy with a role

Input Example

https://cam.intl.tencentcloudapi.com/?Action=AttachRolePolicy
&PolicyId=1
&AttachRoleId=4611686018427397905
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "0b55ef5b-36b1-4649-8bb9-1aca465f17fb"
    }
}

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.OrganizationPolicyOperateError
InternalError.SystemError Internal error.
InvalidParameter.AttachmentFull Limit on number of authorization object associated policies in the principal field reached.
InvalidParameter.ParamError Invalid input parameter.
InvalidParameter.PolicyIdNotExist Policy ID does not exist.
InvalidParameter.PolicyNameError PolicyName field invalid.
InvalidParameter.RoleNotExist Role does not exist.
InvalidParameter.VersionError Version field of policy document invalid.
Previous Topic: UpdateRoleDescriptionNext Topic: CreateRole

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback