Rust · 0.1.0

List Users

GET /api/v1/users

UserService · UserService_ListUsers

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Requires an instance administrator. A normal authenticated account cannot perform this operation.

Administrative list behavior

Pagination is supported. The only supported filter shape is username equality with a nonempty string, for example username == "alice". The declared showDeleted flag does not create a separate trash view. Results include stored users according to the endpoint's fixed ordering.

Request

ListUsers returns a list of users.

GET/api/v1/users

Parameters

Name / location	Type / requirement	Description
`pageSize` query	integer (int32) Not marked required in OpenAPI	Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
`pageToken` query	string Not marked required in OpenAPI	Optional. A page token, received from a previous `ListUsers` call. Provide this to retrieve the subsequent page.
`filter` query	string Not marked required in OpenAPI	Optional. Filter to apply to the list results. Example: "username == 'steven'" Supported operators: == Supported fields: username
`showDeleted` query	boolean Not marked required in OpenAPI	Optional. If true, show deleted users in the response.

Request body

No request body is declared.

Responses

200 · OK

application/json · ListUsersResponse

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition

{
  "tags": [
    "UserService"
  ],
  "description": "ListUsers returns a list of users.",
  "operationId": "UserService_ListUsers",
  "parameters": [
    {
      "name": "pageSize",
      "in": "query",
      "description": "Optional. The maximum number of users to return.\n The service may return fewer than this value.\n If unspecified, at most 50 users will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000.",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "description": "Optional. A page token, received from a previous `ListUsers` call.\n Provide this to retrieve the subsequent page.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "description": "Optional. Filter to apply to the list results.\n Example: \"username == 'steven'\"\n Supported operators: ==\n Supported fields: username",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "showDeleted",
      "in": "query",
      "description": "Optional. If true, show deleted users in the response.",
      "schema": {
        "type": "boolean"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListUsersResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}