List Organizations
| Description | Lists all sub-orgs related to a root org id (paginated) |
| HTTP Method | /v1/identity/organizations/{organization_id}/orgunits |
| HTTP Path | GET |
| Associated Scope(s) | identity.organizations |
Request Path Parameters (If Any)
| Name | Type | Description |
|---|---|---|
| organization_id | string | Root Org UUID. |
Request Query/Body Parameters (If Any)
| Name | Type | Description |
|---|---|---|
| limit | int | Limit on the number of records to return. |
| pageToken | string | If a previous response included a page_token it can be passed in here so that the next page of records can be returned. |
Response Fields (If Any)
| Name | Type | Description |
|---|---|---|
| organizations | array | Array of entities.OrgUnit (sub-organizations). |
| limit | int | Requested limit on the number of records to return. |
| pageToken | int | Token to be passed to the next request so the next page of records can be returned. |
| totalResults | int | The total number of results returned by the list or query operation. The value may be larger than the number of resources returned, such as when returning a single page of results where multiple pages are available. |
Endpoint Specific Errors (Standard API Errors are defined here)
| Http Status Code | Code | Message |
|---|---|---|
| 400 | bad_request | A bad request like “non-existent orgID” |
| 401 | unauthorized | No authentication provided, or invalid auth credentials, or missing scopes, etc. |