Updated on 2025-12-24 GMT+08:00

Attaching an Identity Policy to an Agency or Trust Agency

Function

This API is used to attach a specified identity policy to a specified agency or trust agency.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

iam:agencies:attachPolicyV5

Permission_management

agency *

g:ResourceTag/<tag-key>

-

-

-

iam:PolicyURN

URI

POST /v5/policies/{policy_id}/attach-agency

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

policy_id

Yes

String

Identity policy ID. The value contains 1 to 64 characters, including only letters, digits, and hyphens (-).

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

agency_id

Yes

String

Agency or trust agency ID. The value contains 1 to 64 characters, including only letters, digits, and hyphens (-).

Response Parameters

Status code: 200

Successful

Status code: 403

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Request ID.

encoded_authorization_message

String

Encrypted authentication failure information, which can be decrypted using the STS5 decryption API.

Status code: 404

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Request ID.

Status code: 409

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Request ID.

Example Requests

Attaching a specified identity policy to agency xxx

POST https://{endpoint}/v5/policies/{policy_id}/attach-agency

{
  "agency_id" : "xxx"
}

Example Responses

None

Status Codes

Status Code

Description

200

Successful

403

Forbidden

404

Not found

409

Conflict

Error Codes

See Error Codes.