Querying Organization Policy Delivery Info

Function

This API is used to query the organization policy delivery info of each 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, no identity policy-based permission required for calling this API.

URI

GET /v3/{project_id}/organization-policies/{organization_policy_id}/policy-detail

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
organization_policy_id	Yes	String	Definition Organizational policy ID. Constraints N/A Range 32 hexadecimal digits (UUID format) Default Value N/A
project_id	Yes	String	Definition Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
policies	Array of OrganizationPolicyStatus objects	Organization policy deployment status list
count	Integer	Definition Members who have received the organizational policy. Range An integer greater than or equal to 0
limit	Integer	Definition Number of records displayed on each page. Range A positive integer
offset	Integer	Definition Offset where the query starts. Range An integer greater than or equal to 0

**Table 4** OrganizationPolicyStatus
Parameter	Type	Description
policy_id	String	Definition Policy ID. Range 32 hexadecimal digits (UUID format)
domain_id	String	Definition Account ID. Range 32 hexadecimal digits (UUID format)
project_id	String	Definition Project ID. Range 32 hexadecimal digits (UUID format)
status	String	Organization policy deployment status. The value can be syncing, updating, deleting, available, or error. syncing: The organization policy is being synchronized with other organizational policies. updating: The organization policy is being updated. deleting: The organization policy is being deleted. available: The organization policy is available. No operations are performed on the organization policy. error: The organization policy has failed to deploy correctly.

Example Requests

Querying the organization policy delivery info of each account

GET https://{endpoint}/v3/{project_id}/organization-policies/{organization_policy_id}/policy-detail

GET https://{endpoint}/v3/{project_id}/organization-policies/{organization_policy_id}/policy-detail

Example Responses

Status code: 200

{
  "policies" : [ {
    "policy_id" : "680032b4-493f-4486-81ab-1d068c92da6b",
    "domain_id" : "0ab4d110dc00d5ba0f5ac0103d5ebf60",
    "project_id" : "ab994a04599c4c46a1e946c328b55ee2",
    "status" : "available"
  }, {
    "policy_id" : "556d25b7-f3c7-4f61-a096-be74bb797056",
    "domain_id" : "0ab4d110dc00d5ba0f5ac0103d5ebf60",
    "project_id" : "c5a1f68f1c664c9189c2cc2956138b9a",
    "status" : "available"
  } ],
  "count" : 2,
  "limit" : 1000,
  "offset" : 0
}