Help Center/ Organizations/ API Reference/ APIs/ Managing Policies/ Attaching a Policy to an Entity
Updated on 2024-10-21 GMT+08:00
View PDF
Share

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.

URI

POST https://{endpoint}/v1/organizations/policies/{policy_id}/attach

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

policy_id

Yes

String

Unique ID of the policy.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

entity_id

Yes

String

Unique ID of the root, OU, or account.

Response Parameters

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.

Parent topic: Managing Policies