Listing Accounts in an Organization

Function

This API is used to list all the accounts in an organization. It can be called only from the organization's management account or from a member account that is a delegated administrator for a cloud service. If a parent OU is specified, this API will return a list of all the accounts contained in the specified parent OU.

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:accounts:list

List

-

-

-

-

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

URI

GET /v1/organizations/accounts

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
parent_id	No	String	Definition Unique ID of a parent node (root or OU). Constraints N/A Range The value must comply with the regular expression ^(?:r-[0-9a-z]{4,32}\|ou-[0-9a-z]{8,32})$. The value contains a maximum of 100 characters. Default Value No default value
with_register_contact_info	No	Boolean	Definition Whether to return email addresses and mobile numbers associated with the account. If this parameter is set to True, the maximum value of limit is 200. Constraints Mandatory Range Boolean value: true or false Default Value None
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
accounts	Array of AccountDto objects	Definition List of accounts in an organization. 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** AccountDto
Parameter	Type	Description
id	String	Definition Unique ID of an account. 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
urn	String	Definition Uniform resource name of an account. Constraints Mandatory Range The value contains 1 to 1,500 characters. Default Value No default value
join_method	String	Definition How an account joined an organization. The value can be invited (an account can be invited to join an organization) or created (an account can be directly created in an organization). Constraints Mandatory Range The value contains 1 to 64 characters. Default Value No default value
status	String	Definition Account status. It can be active, suspended, or pending_closure. Constraints Mandatory Range The value contains 1 to 64 characters. Default Value No default value
joined_at	String	Definition Date when an account joined an organization. Constraints Mandatory Range The value must be in ISO 8601 format. Default Value No default value
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
mobile_phone	String	Definition Mobile number. Constraints None Range The value must comply with the regular expression ^1[3456789]\d{9}$. The value contains 1 to 32 characters. Default Value None
intl_number_prefix	String	Definition Prefix of a mobile number. Constraints None Range The value contains 1 to 10 characters. Default Value None
email	String	Definition Email address associated with the account. Constraints None Range The value must comply with the regular expression ^[\s][\w+=.#\|!&-]+@[\w.-]+.[\w]+[\s]$. The value contains 1 to 64 characters. Default Value None
description	String	Definition Description. Constraints N/A Range The value contains 0 to 128 characters. Default Value No default value

**Table 5** 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

Listing Accounts in an Organization

GET https://{endpoint}/v1/organizations/accounts

Example Responses

Status code: 200

Successful.

{
  "accounts" : [ {
    "id" : "05261f923e80d3890f33c0056e9b3f80",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:account:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/05261f923e80d3890f33c0056e9b3f80",
    "join_method" : "invited",
    "joined_at" : "2022-08-24T06:41:15Z",
    "name" : "paas_iam_573331",
    "status" : "active",
    "mobile_phone" : "18700000000",
    "intl_number_prefix" : "0086",
    "email" : "test@example.com"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}