GET
/
v1
/
users
{
  "users": [
    {
      "name": "<string>",
      "state": "STATE_UNSPECIFIED",
      "email": "<string>",
      "title": "<string>",
      "userType": "USER_TYPE_UNSPECIFIED",
      "mfaEnabled": true,
      "mfaSecret": "<string>",
      "recoveryCodes": [
        "<string>"
      ],
      "phone": "<string>",
      "profile": {
        "lastLoginTime": "2023-11-07T05:31:56Z",
        "lastChangePasswordTime": "2023-11-07T05:31:56Z",
        "source": "<string>"
      }
    }
  ],
  "nextPageToken": "<string>"
}

Query Parameters

​
pageSize
integer

The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 10 users will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUsers must match the call that provided the page token.

​
showDeleted
boolean

Show deleted users if specified.

​
filter
string

Filter is used to filter users returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filter:

  • name: the user name, support "==" and ".matches()" operator.
  • email: the user email, support "==" and ".matches()" operator.
  • user_type: the type, check UserType enum for values, support "==", "in [xx]", "!(in [xx])" operator.
  • state: check State enum for values, support "==" operator.
  • project: the project full name in "projects/{id}" format, support "==" operator.

For example: name == "ed" name.matches("ed") email == "ed@bytebase.com" email.matches("ed") user_type == "SERVICE_ACCOUNT" user_type in ["SERVICE_ACCOUNT", "USER"] !(user_type in ["SERVICE_ACCOUNT", "USER"]) state == "DELETED" project == "projects/sample-project" You can combine filter conditions like: name.matches("ed") && project == "projects/sample-project" (name == "ed" || email == "ed@bytebase.com") && project == "projects/sample-project"

Response

200
application/json

OK

The response is of type object.