Rust · 0.1.0

List User Settings

GET /api/v1/users/{user}/settings

UserService · UserService_ListUserSettings

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

Owner-only: the user named in the path must be the authenticated caller. Instance administrator status does not allow acting on another account here.

Small collection without pagination

The current implementation returns the whole permitted collection and leaves nextPageToken empty. The protocol's pageSize/pageToken inputs do not split this collection. PAT listing exposes metadata only, never previously created token values.

Public setting keys are limited

The exposed setting keys are GENERAL, TAGS and WEBHOOKS. Account token/session storage is not exposed as a setting. WEBHOOKS is read-only here; manage it through the dedicated webhook operations. Missing GENERAL settings are projected with defaults.

Request

ListUserSettings returns a list of user settings.

GET/api/v1/users/{user}/settings

Parameters

Name / location	Type / requirement	Description
`user` path	string Required	The user id.
`pageSize` query	integer (int32) Not marked required in OpenAPI	Optional. The maximum number of settings to return. The service may return fewer than this value. If unspecified, at most 50 settings 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 `ListUserSettings` call. Provide this to retrieve the subsequent page.

Request body

No request body is declared.

Responses

200 · OK

application/json · ListUserSettingsResponse

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": "ListUserSettings returns a list of user settings.",
  "operationId": "UserService_ListUserSettings",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "pageSize",
      "in": "query",
      "description": "Optional. The maximum number of settings to return.\n The service may return fewer than this value.\n If unspecified, at most 50 settings 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 `ListUserSettings` call.\n Provide this to retrieve the subsequent page.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListUserSettingsResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}