Attaching a Policy to an Entity
Function
This API is used to attach a policy to a root, OU, or individual account. It can be called only from the organization's management account.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
organizations:policies:attach
Write
policy *
g:ResourceTag/<tag-key>
-
-
account
g:ResourceTag/<tag-key>
ou
g:ResourceTag/<tag-key>
root
g:ResourceTag/<tag-key>
URI
POST /v1/organizations/policies/{policy_id}/attach
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| policy_id | Yes | String | Definition Unique ID of a policy. Constraints Mandatory Range The value must comply with the regular expression ^p-[0-9a-zA-Z_]{8,128}$. The value contains a maximum of 130 characters. Default Value No default value |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Security-Token | No | String | Definition Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Constraints N/A Range The value contains 0 to 32,768 characters. Default Value No default value |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| entity_id | Yes | String | Definition Unique ID of the root, OU, or account. Constraints Mandatory Range The value must comply with the regular expression ^(?:r-[0-9a-z]{4,32}|[\w-]+|ou-[0-9a-z]{8,32})$. The value contains a maximum of 100 characters. Default Value None |
Response Parameters
Status code: 200
Successful.
None
Example Requests
Attaching a policy to an entity
POST https://{endpoint}/v1/organizations/policies/{policy_id}/attach
{
"entity_id" : "ou-g0odxxnfw"
} Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | Successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot