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.
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
-
-
-
-
URI
GET /v1/organizations/create-account-status
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
states |
No |
Array of strings |
List of one or more states that you want to include in the response. If this parameter is not present, all requests are included in the response. It can be in_progress, succeeded, or failed. |
|
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 |
Pagination marker. |
Request 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
|
Parameter |
Type |
Description |
|---|---|---|
|
create_account_statuses |
Array of CreateAccountStatusDto objects |
List of objects with details about the requests. |
|
page_info |
PageInfoDto object |
Pagination information. |
|
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 |
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: This phone number has reached the maximum account registration 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 financial association between the master account and member accounts. Error 0000: System error. |
|
failure_detail_msg |
failure_detail_msg object |
Detailed reason why the request fails. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
Transparently Transmitting Error Codes |
|
encoded_authorization_message |
String |
Transparently Transmitting Authentication Failure Information |
|
Parameter |
Type |
Description |
|---|---|---|
|
next_marker |
String |
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. |
|
current_count |
Integer |
Number of items returned on the current page. |
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" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
"state" : "in_progress",
"failure_reason" : "string"
} ],
"page_info" : {
"next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
"current_count" : 100
}
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Successful |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.