Listing Entities in an Organization
Function
This API is used to list all the entities (roots, OUs, and 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. You can filter entities you want to view by specifying the parent OU ID and child OU ID.
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/entities
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
parent_id |
No |
String |
Unique ID of the parent node (root OU or another OU). |
child_id |
No |
String |
Unique ID of the child node (OU). |
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 |
---|---|---|
entities |
Array of EntityDto objects |
List of roots, OUs, and accounts in an organization. |
page_info |
PageInfoDto object |
Pagination information. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Name of the entity. |
id |
String |
Unique ID of the entity. |
type |
String |
Entity type. It can be account, organizational_unit, or root. |
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 entities in an organization
GET https://{endpoint}/v1/organizations/entities
Example Responses
Status code: 200
Successful
{ "entities" : [ { "name" : ">Xm0g]]sW9KS2]kJ<bToX>1wu?S-?63MH]Of^D8CwZn\\L2qak7nd<h5IkFlp^Nc5", "id" : "r-1ipjropk1htpbwsd9v06faef6ls48o", "type" : "account" } ], "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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot