Get Sub Organizations By Organization Id Using GET

Get sub-organizations of the specified parent organization.

Access Policy

Role	User Accounts	Service Accounts (Client Credentials Applications)
Organization Admin	✔️	❌
Organization Owner	✔️	❌

Request

URI

GET

https://{api_host}/csp/gateway/am/api/orgs/{orgId}/sub-orgs

COPY

Path Parameters

string

orgId

Required

Unique identifier (GUID) of the organization.

Query Parameters

string

tag

Optional

Filter results by organization tag

Authentication

This operation uses the following authentication methods.

Bearer

Responses

201

Created

Returns PagedResponseOrganizationDto of type(s) application/json

{
    "nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15",
    "prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
    "results": [
        {
            "auditLogsInstanceId": "string",
            "displayName": "string",
            "enforceUserApiTokenMfa": false,
            "isMfaRequired": false,
            "language": "string",
            "locale": "string",
            "maxAllowedAuthExemptedUserCount": 0,
            "metadata": {
                "metadata": "string"
            },
            "name": "string",
            "parentRefLink": "string",
            "refLink": "string",
            "status": "string",
            "trustedOrgs": [
                {
                    "id": "string"
                }
            ],
            "type": "string"
        }
    ],
    "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.

array of OrganizationDto

results

Optional

Partial list of returned results.

integer As int32 As int32

totalResults

Optional

Total number of results if available.

400

Missing required parameters or invalid parameters in request body returns a 400 (bad request) status code

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

404

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message