[{"label":"Latest (v1.0)","version":"latest"}]
csp

Get Sub Organizations By Organization ID

Description

Get sub-organizations of the specified parent organization.

Access Policy

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

Request

Request

URL

URL


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

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response 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",
	"results": [
		{
			"auditLogsInstanceId": "string",
			"displayName": "string",
			"enforceUserApiTokenMfa": false,
			"isMfaRequired": false,
			"language": "string",
			"locale": "string",
			"maxAllowedAuthExemptedUserCount": 0,
			"metadata": {
				"key": "string"
			},
			"name": "string",
			"parentRefLink": "string",
			"refLink": "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
totalResults Optional

Total number of results if available.

Errors

Errors

400

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


401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

The requested resource could not be found


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?