Search for Users
Learn about searching for users.
Search for users
Endpoint | Method |
---|---|
v2/users | GET |
This request searches for users.
Query parameters
Parameter | Details | Description |
---|---|---|
isDisabled | boolean | Search for enabled vs disabled users. |
username | string | The username of the user to get. |
passwordExpirationDateMinimum | date | Search for users with a password expiration date greater than or equal to the specified date. |
passwordExpirationDateMaximum | date | Search for users with a password expiration date less than or equal to the specified date. |
roleUUID | string | Search for users with specific role UUID. |
partitionUUID | string | Search for users in this partition. |
Sample response- Search for users
[
{
"uuid": "37f038e2-22ec-4e5b-93f4-f065bea65542",
"username": "[email protected]",
"email": "[email protected]",
"fullName": "Joe Smith",
"isDisabled": true,
"passwordExpirationDisabled": false,
"defaultPartition": {
"uuid": "37f038e2-22ec-4e5b-93f4-f065bea65542",
"name": "Vertex Cloud"
},
"partitionRoles": [
{
"partition": {
"uuid": "37f038e2-22ec-4e5b-93f4-f065bea65542",
"name": "Vertex Cloud"
},
"roles": [
{
"uuid": "37f038e2-22ec-4e5b-93f4-f065bea65542",
"sourceId": 1,
"name": "User Role Name",
"description": "User Role Description"
}
]
}
],
"passwordExpirationDate": "2020-01-01",
"isSSOUser": false,
"isServiceAccount": false,
"locale": "en_US"
}
]
Updated 3 months ago