DocumentationAPI reference

Rust · 0.1.0

Batch Get Users

POST /api/v1/users:batchGet

UserService · UserService_BatchGetUsers

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

Anonymous calls are allowed only when the instance permits public access. Authenticated calls remain subject to resource visibility and operation-specific filtering.

Batch usernames, not resource names

Provide at most 100 nonempty usernames in usernames. Empty entries are discarded, duplicates are collapsed in the result, and only active matching users are returned. Result order is the server's order, not necessarily request order. Missing names do not create placeholder entries.

Request

BatchGetUsers returns active users by usernames.

POST/api/v1/users:batchGet

Parameters

No path or query parameters are declared.

Request body

Required

application/json · BatchGetUsersRequest

Responses

200 · OK

application/json · BatchGetUsersResponse

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": "BatchGetUsers returns active users by usernames.",
  "operationId": "UserService_BatchGetUsers",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/BatchGetUsersRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/BatchGetUsersResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}