Search for Users

Learn about searching for users.

Search for users

EndpointMethod
v2/usersGET

This request searches for users.

Query parameters

ParameterDetailsDescription
isDisabledbooleanSearch for enabled vs disabled users.
usernamestringThe username of the user to get.
passwordExpirationDateMinimumdateSearch for users with a password expiration date greater than or equal to the specified date.
passwordExpirationDateMaximumdateSearch for users with a password expiration date less than or equal to the specified date.
roleUUIDstringSearch for users with specific role UUID.
partitionUUIDstringSearch 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"
  }
]