Get Organization Users By Organization ID
DescriptionGet response encapsulating organization users.
Fetched page is according to the page start and page limit passed as optional parameters.
Optionally provide “serviceDefinitionId” to filter users having access to a service. Organization Members are permitted to see only basic user information. Organization owners and read-only administrators will see also organization and service roles of the users and userProfile if expandProfile is passed.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Member | ✔️ | ✔️ |
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization.
Query Parameters
Query Parameters
Indicates if the response should exclude the user roles; the value is ignored, only the existence of parameter is checked.
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.
Maximum number of users to return in response
Specifies the index that the set of results will begin with
Service definition id used to filter users having access to the service.
Authentication
Response
Response BodyResponse Body
200 OK
{
"nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15",
"prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
"totalResults": 2000
}
Relative path to next page if exists. Not returned for POST requests.
Relative path to previous page if exists. Not returned for POST requests.
Total number of results if available.
Errors
The user is not authorized to use the API
The user is forbidden to use the API
Organization not found | Service not found
The user has sent too many requests
An unexpected error has occurred while processing the request
