[{"label":"Latest (v1.0)","version":"latest"}]
csp

SearchUsersByRolesRequest

Search users by roles and/or resource.


Properties

boolean
expandProfile Optional

Indicates if the response should be expanded with the user profile (default: false).


boolean
includeGroupIdsInRoles Optional

Indicates if the inherited roles in the response should indicate group information (default: false).


integer as int32
pageLimit Optional

Maximum number to return in response. Default value is 200.


integer as int32
pageStart Optional

Start index for querying. Default value is 1.


string
resource Optional

Resource to search for resource-scoped role assignments.


string
resourceStartsWith Optional

Resource to search for resource-scoped role assignments starting with given term. This field is deprecated. Consider using “resource” along with “searchType”.


rolesSearchTerm Optional

Defines the roles properties which are used for search.


string
searchType Optional

Defines the searching capability of the “resource” field value.

Possible values are: EXACT_MATCHCONTAINSSTARTS_WITHENDS_WITH


string
userSearchTerm Optional

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

{
	"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"
}
[{"label":"Latest (v1.0)","version":"latest"}]
csp
Parameter To

Search Organization Users By Organization ID And Roles Search Term

Feedback

Was this page helpful?