Querying Account Creation Requests in Specified State

Function

This API is used to query the account creation requests in the specified state for an organization. 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.

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, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

organizations:createAccountStatuses:list

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
organizations:createAccountStatuses:list	List	-	-	-	-

URI

GET /v1/organizations/create-account-status

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
states	No	Array of strings	Definition List of one or more states that you want to include in the response. If this parameter is not present, all items are included in the response. It can be in_progress, succeeded, or failed. Constraints N/A Range 0 to 3 states Enumerated values: in_progress, succeeded, and failed. Default Value No default value
limit	No	Integer	Maximum number of results on the page. If the limit is not specified, the default value is 1,000.
marker	No	String	Definition Pagination marker. Constraints N/A Range The value must comply with the regular expression ^[A-Za-z0-9+/=-_.]+$. The value contains 4 to 400 characters. Default Value No default value

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Definition Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Constraints N/A Range The value contains 0 to 32,768 characters. Default Value No default value

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
create_account_statuses	Array of CreateAccountStatusDto objects	Definition List of objects with details about the requests. Constraints Mandatory Range None Default Value None
page_info	PageInfoDto object	Definition Pagination information. Constraints N/A Range N/A Default Value No default value

**Table 4** CreateAccountStatusDto
Parameter	Type	Description
account_id	String	Definition Unique ID of the newly created account if any. Constraints Mandatory Range The value must comply with the regular expression ^[\w-]+$. The value contains a maximum of 64 characters. Default Value No default value
account_name	String	Definition Account name. Constraints Mandatory Range The value must comply with the regular expression ^[a-zA-Z][0-9a-zA-Z_-]+$. The value contains a maximum of 64 characters. Default Value No default value
completed_at	String	Definition Date and time when the account was created and the request was completed. Constraints Mandatory Range The value must be in ISO 8601 format. Default Value No default value
created_at	String	Definition Date and time when the CreateAccount request was made. Constraints Mandatory Range The value must be in ISO 8601 format. Default Value No default value
id	String	Definition Unique ID of a request. You can get this value from the response to the initial CreateAccount request. Constraints Mandatory Range The value must comply with the regular expression ^car-[0-9a-z]{8,32}$. The value contains a maximum of 36 characters. Default Value No default value
state	String	Definition Status of the asynchronous request for creating an account. The value can be in_progress, succeeded, or failed. Constraints Mandatory Range The value contains 1 to 64 characters. Default Value No default value
failure_reason	String	Definition Reason for a request failure.error.1000 Failed to query the user identity information.error.2000 Failed to create the account.error.2001 Account name conflict.error.3000 Failed to create the resource account.error.3001 The number of accounts that can be registered with the mobile number exceeds the maximum limit.error.4000 Failed to create the birth token.error.5000 Failed to create the service-linked agency.error.6000 Failed to create the agency.error.6001 Failed to query the permission information.error.6002 Failed to bind the permission information.error.7000 Failed to associate the master account with member accounts for unified accounting.error.7001 Too many real-name authentication records.error.7002 Failed to query the unified accounting association between the master account and member accounts.error.0000 System error. Constraints N/A Range Enumerated values: error.1000, error.2000, error.2001, error.3000, error.3001, error.4000, error.5000, "error.6000, error.6001, error.6002, error.7000, error.7001, error.7002, and error.0000. Default Value** No default value
failure_detail_msg	failure_detail_msg object	Definition Detailed cause of a request failure. Constraints N/A Range N/A Default Value No default value

**Table 5** failure_detail_msg
Parameter	Type	Description
error_msg	String	Definition Transparent transmission error code. Constraints None Range None Default Value None
encoded_authorization_message	String	Definition Failure information of transparent authentication. Constraints None Range None Default Value None

**Table 6** PageInfoDto
Parameter	Type	Description
next_marker	String	Definition Marker for the next set of results. If present, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the next_marker response element comes back as null. Constraints Mandatory Range The value must comply with the regular expression ^[A-Za-z0-9+/=-_]+$. Default Value No default value
current_count	Integer	Definition Number of records returned on this page. Constraints N/A Range The value ranges from 1 to 2000. Default Value No default value

Example Requests

Querying account creation requests in the specified state

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

Example Responses

Status code: 200

Successful

{
  "create_account_statuses" : [ {
    "account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
    "account_name" : "paas_iam_573331",
    "completed_at" : "2022-08-24T06:41:15Z",
    "created_at" : "2022-08-24T06:41:15Z",
    "id" : "car-awjp43m7bz3b8jgy5v61jrfwakt3og8",
    "state" : "in_progress"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}