DocumentationAPI reference

Rust · 0.1.0

Sign Out

POST /api/v1/auth/signout

AuthService · AuthService_SignOut

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 authenticated, active account. Instance policy and the operation-specific checks below still apply.

Sign-out is not PAT revocation

No request body is needed. With session access authentication and a matching refresh cookie, the stored refresh session is removed and the cookie cleared. The endpoint does not delete a PAT used to call it. Revoke integration tokens through DeletePersonalAccessToken.

Successful response

This operation has no resource to return. The Rust REST transport serializes protobuf Empty as HTTP 200 with JSON {}. The empty success-schema area in the generated contract is intentional, not missing request instructions.

Request

SignOut terminates the user's authentication. Revokes the refresh token and clears the authentication cookie.

POST/api/v1/auth/signout

Parameters

No path or query parameters are declared.

Request body

No request body is declared.

Responses

200 · OK

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": [
    "AuthService"
  ],
  "description": "SignOut terminates the user's authentication.\n Revokes the refresh token and clears the authentication cookie.",
  "operationId": "AuthService_SignOut",
  "responses": {
    "200": {
      "description": "OK",
      "content": {}
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}