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

{
    "prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
    "results": [
        {
            "language": "string",
            "displayName": "string",
            "name": "string",
            "maxAllowedAuthExemptedUserCount": 0,
            "customerId": "string",
            "refLink": "string",
            "type": "string",
            "parentRefLink": "string",
            "locale": "string",
            "trustedOrgs": [
                {
                    "displayName": "string",
                    "id": "string",
                    "trustType": "string"
                }
            ],
            "enforceUserApiTokenMfa": false,
            "trusteeOrgs": [
                {
                    "displayName": "string",
                    "id": "string",
                    "trustType": "string"
                }
            ],
            "auditLogsInstanceId": "string",
            "metadata": {
                "metadata": "string"
            },
            "isMfaRequired": false,
            "status": "string"
        }
    ],
    "totalResults": 2000,
    "nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15"
}

string

prevLink

Optional

Relative path to previous page if exists. Not returned for POST requests.

array of object

results

Optional

Partial list of returned results.

integer As int32 As int32

totalResults

Optional

Total number of results if available.

string

nextLink

Optional

Relative path to next page if exists. Not returned for POST requests.

400

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

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

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

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

404

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

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

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/sub-orgs

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

201 Response Body

Errors

Organization Operations

GET

Get Sub Organizations By Organization Id Using GET

POST

Activate Organization Refresh Tokens Using POST

Deprecated

GET

Get Organization Roles By Organization Id Using GET

POST

Search Organization Users By Organization Id And Roles Search Term Using POST

GET

Get Users In Organization By Organization Id And User Search Term Using GET

Deprecated

DELETE

Revoke User Invitation By Organization Id And User Invitation Id Using DELETE

GET

Get User Invitation By Organization Id And User Invitation Id Using GET

POST

Deactivate Organization Refresh Tokens With Api Token Path Using POST

POST

Assign Roles To Clients On Organization Using POST

DELETE

Remove Clients From Organization By Organization Id Using DELETE

GET

Get Organization Clients By Organization Id Using GET

POST

Deactivate Organization Refresh Tokens Using POST

Deprecated

PATCH

Update Organization By Organization Id Using PATCH

GET

Get Organization By Id Using GET

DELETE

Remove Users From Organization By Organization Id Using DELETE

GET

Get Organization Users By Organization Id Using GET

POST

Activate Organization Refresh Tokens With Api Token Path Using POST

POST

Invite Users Using POST

GET

Get Organization Invitations By Organization Id Using GET

POST

Link Org To Idp Using POST

DELETE

Delete Organization Idp Registration Using DELETE

GET

Get Org Linked Idp Details Using GET

GET

Get Groups In Organizations By Organization Id And Group Search Term Using GET