Search Organization Users By Organization ID And Roles Search Term
DescriptionSearch all users who have at least one of the specified roles and/or resource.
Search by resource can be exact match or by resource starting with given term. At most one of the filters resource or resourceStartsWith may be provided.
For all users found by these search criteria the result contains all users roles, no matter if they are part of the search criteria or not.
To search by resource starting with given term provide resourceStartsWith.
If resource is empty then unscoped role assignments will be returned.
When role is provided and resource is null all role assignments will be returned.
When filterResults flag is true the result is filtered by search parameters from the request: resource, resourceStartsWith and roles names.
In this case the result contains just the roles that match the search criteria.
Paginated results - by default start index of results is 1 and default number of search results per page is 200.
Searching access restricted to Organization Owners, Read-only operators and Service Owners (for organizations that have access to the service).
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
| Project Admin | ✔️ | ✔️ |
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization.
Query Parameters
Query Parameters
Indicates if the response should be filtered by search parameters from the request: resource, resourceStartsWith and roles names (default: false).
Request Body
{
"excludeRoles": false,
"expandProfile": false,
"includeGroupIdsInRoles": false,
"pageLimit": 0,
"pageStart": 0,
"resource": "string",
"resourceStartsWith": "string",
"rolesSearchTerm": {
"customRoles": [
{
"roleName": "string"
}
],
"orgRoles": [
{
"roleName": "string"
}
],
"serviceRoles": [
{
"serviceDefinitionId": "string",
"serviceRoles": [
{
"roleName": "string"
}
]
}
]
},
"searchType": "EXACT_MATCH",
"userSearchTerm": "string"
}
Indicates if the response should exclude the roles of the user (default: false).
Indicates if the response should be expanded with the user profile (default: false).
Indicates if the inherited roles in the response should indicate group information (default: false).
Maximum number to return in response. Default value is 200.
Start index for querying. Default value is 1.
Resource to search for resource-scoped role assignments.
Resource to search for resource-scoped role assignments starting with given term. This field is deprecated. Consider using “resource” along with “searchType”.
Defines the searching capability of the “resource” field value.
Possible values are: EXACT_MATCH , CONTAINS , STARTS_WITH , ENDS_WITH
The string to be searched within email or firstName or lastName or username. If it contains space separated terms, then the searchTerm is matched against possible firstName and lastName combinations. This search term is case insensitive.
Authentication
Response
Response BodyResponse Body
200 OK
{
"itemsPerPage": 25,
"startIndex": 5,
"totalResults": 2000
}
Number of items per page.
Start index of the results.
Total number of results if available
Errors
At least one role search term must be specified
The user is not authorized to use the API
The user is forbidden to use the API
Organization with this identifier is not found.
The request could not be processed due to a conflict
The user has sent too many requests
An unexpected error has occurred while processing the request
Code Samples
cURL Command
Vendor Extensions
x-required-roles: org_admin,org_owner,project_admin
x-slo-tier: TIER2
