Search all the users (Paginated and w/ Filter)
GET /users/search
Operation id: UserService_SearchUsers
Description
Permission Level: Read
Tags: UserService
Parameters
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
excludeTenantIds | array | No | List of tenant IDs to exclude. Required: false |
fieldMask | string | No | FieldMask to control what fields are to be returned, if empty assumes everything, Required: false Valid path names are names of each field in the SearchUserResponse proto |
genericFilter | string | No | Generic filter for user fields (userId, userFirstName, userLastName, email, location, workspace) If it contains a whitespace, it splits the text and filter by both words, Required: false |
pageSize | integer (int32) | No | Requested size of the next page of data. If not set, the default page size is 10, Required: false. |
pageToken | string | No | MongoDB Field, describes the encoded page token for page traversal, Required: false |
roleId | string | No | role id. restrict results to users within this role, Required: false |
scope | string | No | scope of the users to list, Required: false |
sortField | array | No | List of sort fields, valid values: userId, firstName, lastName, email, batchId, or lastUpdated Default: userId, Required: false |
sortType | string | No | Sort Type for the results, Default: ASC, Required: false |
specificFilter.email | string | No | |
specificFilter.firstName | string | No | |
specificFilter.lastName | string | No | |
specificFilter.licenseDomain | string | No | The domain of the license |
specificFilter.location | string | No | |
specificFilter.selectedDepartments | array | No | The selected departments of the user |
specificFilter.userId | string | No | |
specificFilter.workspaceName | string | No | The workspace name of the Workspace entity |
specificFilter.workspaceType | string | No | The workspace type of the Workspace entity |
specificFilterQueryType | string | No | ENUM to switch the specific_filter.first_name and specific_filter.last_name params from AND to OR, Default: AND, Required: false. |
tenantIds | array | No | List of Tenants of the users, Required: false |
userStatus | string | No | User status in the selected scope |
workspace | string | No | users workspace, Required: false |
Security
- Authorization (apiKey)
- Bearer token
Responses
200 — A successful response.
Content type: application/json
default — An unexpected error response.
Content type: application/json
Response models
200 — A successful response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
users | array | No | |
nextPageToken | string | No |
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"roles": {
"type": "array",
"description": "The user's roles. Includes nested roles. Flat list. Read only.",
"items": {
"type": "object"
}
},
"workspaces": {
"type": "array",
"items": {
"type": "object"
}
},
"location": {
"type": "string"
},
"enabledScopes": {
"type": "object",
"description": "Scopes and status (enable, disable) for a user. Scope is optional. Typically applications will always pass their scope, but it is optional for admin purposes."
},
"primarySite": {
"type": "string"
},
"selectedDepartments": {
"type": "array",
"items": {
"type": "string"
}
},
"middleName": {
"type": "string"
},
"platformId": {
"type": "string"
},
"status": {
"type": "string"
},
"licenses": {
"type": "array",
"items": {
"type": "object"
}
},
"attributes": {
"type": "array",
"items": {
"type": "object"
}
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"siteMapping": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"nextPageToken": {
"type": "string"
}
}
}
default — An unexpected error response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer (int32) | No | |
message | string | No | |
details | array | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
}
}
}
}
}