SearchUsersByRolesRequest
Search users by roles and/or resource.
Properties
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.
JSON Example
{
"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"
}
Parameter To
Search Organization Users By Organization ID And Roles Search Term
