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

Get Nested Enterprise Groups From Custom Group By Organization ID And Group ID

Description

Get nested enterprise groups from custom group

Access Policy

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

Request

Request

URL

URL


get
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/groups
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: SIMPLE Explode:false

string
groupId Required

Unique identifier of the group.

Parameter Serialization Style: SIMPLE Explode:false

Query Parameters

Query Parameters

integer
pageLimit Optional

Specifies the maximum results per page for every call.

Parameter Serialization Style: FORM Explode:true

integer
pageStart Optional

Specifies the index that the set of results will begin with

Parameter Serialization Style: FORM Explode:true

string
searchTerm Optional

Search criteria: the string to be search within the group display name

Parameter Serialization Style: FORM Explode:true

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PagedResponseGroupDto 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.


array of GroupDto
results Optional

Partial list of returned results.


integer as int32
totalResults Optional

Total number of results if available.

Errors

Errors

CspErrorResponse
400

Group not part of the organization


CspErrorResponse
401

The user is not authorized to use the API


CspErrorResponse
403

The user is forbidden to use the API


CspErrorResponse
404

Organization with this identifier is not found. | Group with this identifier is not found.


CspErrorResponse
429

The user has sent too many requests


CspErrorResponse
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}/groups/{groupId}/groups


Feedback

Was this page helpful?