Help Center/ Organizations/ API Reference/ APIs/ Managing Accounts/ Querying Account Creation Status

Updated on 2024-11-05 GMT+08:00

View PDF

Querying Account Creation Status

Function

This API is used to query the status of the asynchronous request to create an account. This API can be called only from the organization's management account or a delegated administrator account.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET https://{endpoint}/v1/organizations/create-account-status/{create_account_status_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
create_account_status_id	Yes	String	ID value that uniquely identifies a CreateAccount request.

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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
create_account_status	CreateAccountStatusDto object	States of CreateAccount requests for an organization.

**Table 4** CreateAccountStatusDto
Parameter	Type	Description
account_id	String	Unique ID of the newly created account if any.
account_name	String	Account name.
completed_at	String	Date and time when the account was created and the request was completed.
created_at	String	Date and time when the CreateAccount request was made.
id	String	Unique ID of a request. You can get this value from the response to the initial CreateAccount request.
state	String	Status of the asynchronous request for creating an account.
failure_reason	String	Reason for a request failure.

Example Requests

Querying account creation status

GET https://{endpoint}/v1/organizations/create-account-status/{create_account_status_id}

Example Responses

Status code: 200

Successful

{
  "create_account_status" : {
    "account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
    "account_name" : "paas_iam_573331",
    "completed_at" : "2022-08-24T06:41:15Z",
    "created_at" : "2022-08-24T06:41:15Z",
    "id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
    "state" : "in_progress",
    "failure_reason" : "string"
  }
}