Memos

List Users

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

GET
/api/users

Query Parameters

pageSize?integer

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.

Formatint32
pageToken?string

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

filter?string

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

showDeleted?boolean

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

Response Body

application/json

application/json

curl -X GET "https://example.com/api/users"
{  "users": [    {      "name": "string",      "username": "string",      "displayName": "string",      "email": "string",      "avatarUrl": "string",      "description": "string",      "password": "string",      "role": "ROLE_UNSPECIFIED",      "state": "STATE_UNSPECIFIED",      "createTime": "2019-08-24T14:15:22Z",      "updateTime": "2019-08-24T14:15:22Z"    }  ],  "nextPageToken": "string"}