Querying Pre-attachment Status Details of a Permission Set

Function

This API is used to query the pre-attachment status details of a permission set based on the request ID. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/instances/{instance_id}/permission-sets/provisioning-status/{request_id}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Globally unique ID of an IAM Identity Center instance.
request_id	Yes	String	Unique ID of a request.

Request Parameters

**Table 2** Parameters in the request header
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. Maximum length: 2048

Response Parameters

Status code: 200

**Table 3** Parameters in the response body
Parameter	Type	Description
permission_set_provisioning_status	Object	Authorization details of a permission set.

**Table 4** permission_set_provisioning_status
Parameter	Type	Description
account_id	String	Unique ID of a specified account.
created_date	String	Date when a permission set was created.
failure_reason	String	Failure cause.
permission_set_id	String	Unique ID of a permission set.
request_id	String	Unique ID of a request. Minimum length: 36 Maximum length: 36
status	String	Authorization status of a permission set. Enumerated value: IN_PROGRESS FAILED SUCCEEDED

Status code: 400

**Table 5** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of a request.
encoded_authorization_message	String	Encrypted error message.

Status code: 403

**Table 6** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of a request.
encoded_authorization_message	String	Encrypted error message.

Status code: 404

**Table 7** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of a request.
encoded_authorization_message	String	Encrypted error message.

Example Request

Querying the pre-attachment status details of a permission set based on the request ID

GET https://{hostname}/v1/instances/{instance_id}/permission-sets/provisioning-status/{request_id}

Example Response

Status code: 200

Successful

{
  "permission_set_provisioning_status" : {
    "account_id" : "5146d03d8aaaaaaaaaaaabbae60620a5",
    "created_date" : "1677175760379",
    "failure_reason" : "",
    "permission_set_id" : "ps-8603aaaaaaaa14bd",
    "request_id" : "a1177591c8c7c49238e60563d34cad92",
    "status" : "SUCCEEDED"
  }
}