SearchUsersByRolesRequest

SearchUsersByRolesRequest
SearchUsersByRolesRequest

Search users by roles and/or resource.

JSON Example 
{
    "expandProfile": false,
    "rolesSearchTerm": {
        "serviceRoles": [
            {
                "serviceRoles": [
                    {
                        "roleName": "string"
                    }
                ],
                "serviceDefinitionId": "string"
            }
        ],
        "orgRoles": [
            {
                "roleName": "string"
            }
        ],
        "customRoles": [
            {
                "roleName": "string"
            }
        ]
    },
    "resource": "string",
    "resourceStartsWith": "string",
    "searchType": "string",
    "pageLimit": 0,
    "pageStart": 0,
    "userSearchTerm": "string",
    "includeGroupIdsInRoles": false,
    "excludeRoles": false
}
boolean
expandProfile
Optional

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

RolesSearchTermDto
rolesSearchTerm
Optional

Defines the roles properties which are used for search.

string
resource
Optional
Constraints: minLength: 0 maxLength: 200

Resource to search for resource-scoped role assignments.

string
resourceStartsWith
Optional
Constraints: minLength: 0 maxLength: 200

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

string
searchType
Optional

Defines the searching capability of the "resource" field value.

Possible values are : EXACT_MATCH, CONTAINS, STARTS_WITH, ENDS_WITH,
integer As int32 As int32
pageLimit
Optional
Constraints: maximum: 200

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

integer As int32 As int32
pageStart
Optional
Constraints: minimum: 1

Start index for querying. Default value is 1.

string
userSearchTerm
Optional
Constraints: minLength: 0 maxLength: 120

The string to be searched within email or firstName or lastName or username.Max search length is 120 characters. If it contains space separated terms, then the searchTerm is matched against possible firstName and lastName combinations. This search term is case insensitive.

boolean
includeGroupIdsInRoles
Optional

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

boolean
excludeRoles
Optional

Indicates if the response should exclude the roles of the user (default: false).

Parameter To