USusememos
UserService

GET /api/users

Changed on

ListUsers lists users in every state. Only admins may call it.

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

pageSizeinteger

Optional. The maximum number of users to return. The service may return fewer. If unspecified, at most 50 users are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

pageTokenstring

Optional. A page token from a previous call. Provide it to retrieve the next page.

filterstring

Optional. A CEL filter on the users. Only username == '<username>' is supported. Example: "username == 'steven'"

showDeletedboolean

Optional. Currently ignored; the list includes users in every state.

Response

OK

nextPageTokenstring

A token to retrieve the next page. Empty when there are no more pages.

Changes