[{"label":"Latest (v1.0)","version":"latest"}]
csp
Get Sub Organizations By Organization ID
DescriptionGet sub-organizations of the specified parent organization.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ❌ |
| Organization Owner | ✔️ | ❌ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/sub-orgs
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
SIMPLE Explode:false
Query Parameters
Query Parameters
string
tag
Optional
Filter results by organization tag
Parameter Serialization Style:
FORM Explode:true
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created
Returns
PagedResponseOrganizationDto
of type application/json
{
"nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15",
"prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
"totalResults": 2000
}
string
nextLink
Optional
Relative path to next page if exists. Not returned for POST requests.
string
prevLink
Optional
Relative path to previous page if exists. Not returned for POST requests.
integer as int32
totalResults
Optional
Total number of results if available.
Errors
CspErrorResponse
400
Missing required parameters or invalid parameters in request body returns a 400 (bad request) status code
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
The user is forbidden to use the API
CspErrorResponse
404
The requested resource could not be found
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl https://{api_host}/csp/gateway/am/api/orgs/{orgId}/sub-orgs
[{"label":"Latest (v1.0)","version":"latest"}]
csp
On This Page
Organization Operations
post
post
delete
