Help Center/ IAM Identity Center/ API Reference/ API/ Account Assignment Management/ Querying Details about the Account Assignment Creation Status
Updated on 2025-08-21 GMT+08:00

Querying Details about the Account Assignment Creation Status

Function

This API is used to query details about the account assignment creation status of a specified IAM Identity Center instance 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}/account-assignments/creation-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

account_assignment_creation_status

Object

Status object for the account assignment creation operation.

Table 4 account_assignment_creation_status

Parameter

Type

Description

created_date

Long

Creation date.

failure_reason

String

Failure cause.

permission_set_id

String

Unique ID of a permission set.

principal_id

String

Unique ID of a principal (for example, a user or group) in IAM Identity Center.

principal_type

String

Principal type of an operation.

Enumerated value:

  • USER
  • GROUP

request_id

String

Unique ID of a request.

status

String

Authorization status of a permission set.

Enumerated value:

  • IN_PROGRESS
  • FAILED
  • SUCCEEDED

target_id

String

Unique ID of a target principal.

target_type

String

Principal type.

Enumerated value:

  • ACCOUNT

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 details about the account assignment creation status of a specified IAM Identity Center instance based on the request ID

GET https://{hostname}/v1/instances/{instance_id}/account-assignments/creation-status/{request_id}

Example Response

Status code: 200

Successful

{
  "account_assignment_creation_status" : {
    "created_date" : 1677175760379,
    "failure_reason" : "",
    "permission_set_id" : "ps-8603aaaaaaaa14bd",
    "principal_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "principal_type" : "USER",
    "request_id" : "9238e6aaaaaaaaaaaaaaaaaaaa4cad92",
    "status" : "IN_PROGRESS",
    "target_id" : "5146d03d8aaaaaaaaaaaabbae60620a5",
    "target_type" : "ACCOUNT"
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.