Get Users In Group Within Organization By Organization Id And Group Id Using GET
Get users in group within organization. Optionally filtered by given firstName, lastName or email with 'contains' match. Optionally filter the users by using onlyDirectUsers with true to return only direct users and not return the users from nested groups.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Unique identifier (GUID) of the organization.
Unique identifier of the group.
Specifies the index that the set of results will begin with
Specifies the maximum results per page for every call.
The first name of the user.
The last name of the user.
The email address of the user.
Indicates if the response should be filter by direct users. If true, only direct users will be returned.
Indicates if the response should be expanded with the user profile; the value is ignored, only the existence of parameter is checked.
OK
{
"prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
"results": [
{
"firstName": "string",
"lastName": "string",
"userProfile": {
"locale": "string",
"language": "string",
"alternativeEmail": "string"
},
"userId": "string",
"email": "string",
"acct": "string",
"domain": "string",
"accessible": false,
"username": "string",
"idpId": "string"
}
],
"totalResults": 2000,
"nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15"
}Relative path to previous page if exists. Not returned for POST requests.
Partial list of returned results.
Total number of results if available.
Relative path to next page if exists. Not returned for POST requests.
Group not part of the organization
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user is not authorized to use the API
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user is forbidden to use the API
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
Organization with this identifier is not found. | Group with this identifier is not found.
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user has sent too many requests
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
An unexpected error has occurred while processing the request
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/users