[{"label":"Latest (v1.0)","version":"latest"}]
csp
Get Organization Groups By Organization ID
DescriptionGet groups of a specific 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}/groups
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
SIMPLE Explode:false
Query Parameters
Query Parameters
string
groupId
Optional
Unique identifier of the group.
Parameter Serialization Style:
FORM Explode:true
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
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
PagedResponseExpandedGroupDto
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
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.
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}/groups
[{"label":"Latest (v1.0)","version":"latest"}]
csp
