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.
URI
GET https://{endpoint}/v1/organizations/accounts
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
parent_id |
No |
String |
Unique ID of the parent node (root OU or another OU). |
with_register_contact_info |
No |
Boolean |
Whether to return email addresses and mobile numbers associated with the account. If True is returned, the maximum number of entries allowed is 200. |
limit |
No |
Integer |
Maximum number of results on a page. |
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 |
---|---|---|
accounts |
Array of AccountDto objects |
List of accounts in an organization. |
page_info |
PageInfoDto object |
Pagination information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Unique ID of an account. |
urn |
String |
Uniform resource name of the account. |
join_method |
String |
How an account joined an organization. |
status |
String |
Account status. It can be active, suspended, or pending_closure. |
joined_at |
String |
Date when an account joined an organization. |
name |
String |
Account name. |
mobile_phone |
String |
Mobile number. |
intl_number_prefix |
String |
Prefix of a mobile number. |
|
String |
Email address associated with the account. |
description |
String |
Description. |
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
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" : "null,", "intl_number_prefix" : "null,", "email" : null } ], "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.