Help Center> Organizations> API Reference> API> Managing Policies> Detaching a Policy from an Entity
Updated on 2024-03-15 GMT+08:00

Detaching a Policy from an Entity

Function

This API is used to detach a policy from a root, OU, or account. It can be called only from the organization's management account.

URI

POST /v1/organizations/policies/{policy_id}/detach

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

policy_id

Yes

String

Unique ID of the policy.

Maximum: 130

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.

Minimum: 1

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

entity_id

Yes

String

Unique ID of the root, OU, or account.

Maximum: 100

Response Parameters

None

Example Requests

Detaching a policy from an entity

POST https://{hostname}/v1/organizations/policies/{policy_id}/detach

{
  "entity_id" : "ou-g0odxxnfw"
}

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.