Get Paginated Org Users Info 1
Use these APIs instead:
- /cloudapi/1.0.0/users
- /cloudapi/1.0.0/users/{{userUrn}}/preferences
- /scim/v2/Groups
Get response encapsulating organization users.
Fetched page is according to the page start and page limit passed as optional parameters. Defaults to page size of 20 and start from the first page. Note that pageStart is 1-based index.
We are currently not supporting the optional serviceDefinitionId which is to filter users having access to a service in CSP.
Access Policy
| Role | Access |
|---|---|
| Platform operator | ✔️ |
| Organization Owner | ✔️ |
| Organization Member | ✔️ |
| Service Account (Whitelisted Client) | ❌ |
Unique identifier (GUID) of the organization.
Service definition id used to filter users having access to the service.
Specifies the index that the set of results will begin with.
Specifies the maximum results per page for every call.
Indicates if the response should be expanded with the user profile, the value is ignored, only the existence of parameter is checked.
Indicates if the inherited roles in the response should indicate group information, the value is ignored, only the existence of parameter is checked.
OK
{
"results": [
{
"user": {
"username": "string",
"firstName": "string",
"lastName": "string",
"domain": "string",
"idpId": "string",
"accessible": false,
"acct": "string",
"email": "string",
"userId": "string",
"userProfile": {
"locale": "string",
"language": "string"
}
},
"orgId": "string",
"organizationRoles": [
{
"id": "string",
"name": "string",
"membershipType": "string",
"expiresAt": "string",
"displayName": "string",
"orgId": "string",
"groups": [
{
"id": "string",
"displayName": "string",
"domain": "string",
"usersCount": 0,
"groupType": "string"
}
],
"groupIds": [
"string"
]
}
],
"serviceRoles": [
{
"serviceRoles": [
{
"id": "string",
"name": "string",
"membershipType": "string",
"expiresAt": "string",
"resource": "string",
"groups": [
{
"id": "string",
"displayName": "string",
"domain": "string",
"usersCount": 0,
"groupType": "string"
}
],
"groupIds": [
"string"
]
}
],
"serviceDefinitionId": "string"
}
]
}
],
"nextLink": "string",
"prevLink": "string",
"totalResults": 0
}The list of results.
URL to the next page of results.
URL to the previous page of result.
The total number of results on all pages.
The user is not authorized to use the API.
"PagedResponseExpandedTypedUser Object"The list of results.
URL to the next page of results.
URL to the previous page of result.
The total number of results on all pages.
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/users