---
title: "End the client's session."
method: POST
path: "/v1/auth/logout"
tags: ["auth"]
---

# End the client's session.

`POST /v1/auth/logout`

## Request

- Base URL: `https://api.pronto.stream` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pronto.stream/v1/auth/logout`
- Auth: none required

End the client's session.

## Request body

- LogoutRequest
  - `metadata` Metadata
    - `aiConfidence` number, double
    - `attributes` object
    - `categories` string[]
    - `causationId` string
    - `channel` string
    - `correlationId` string
    - `dataClassification` string
    - `embeddingId` string
    - `extrasJson` string, byte
    - `gamificationState` string
    - `globalContext` GlobalContext
      - `actorType` string
      - `auditContext` string
      - `deviceId` string
      - `ipAddress` string
      - `jurisdiction` string
      - `organizationId` string
      - `regulatedEntityRef` string
      - `roleId` string
      - `sessionId` string
      - `source` string
      - `userAgent` string
      - `userId` string
    - `idempotencyKey` string
    - `jurisdictionTags` string[]
    - `knowledgeGraph` string
    - `legalBasisCode` string
    - `locale` string
    - `payloadHash` string
    - `policySnapshotRef` string
    - `processedAt` string, date-time
    - `reasonCode` string
    - `requestId` string
    - `requestedAt` string, date-time
    - `retentionClass` string
    - `routeKey` string
    - `signatureRef` string
    - `sourceChannel` string
    - `sourceQueue` string
    - `sourceRef` string
    - `sourceService` string
    - `spanId` string
    - `tags` string[]
    - `tenantRegion` string
    - `traceId` string
    - `validityPeriod` ValidityPeriod
      - `effectiveFrom` string
      - `effectiveTo` string
  - `refreshToken` string

## Response `200`

Successful response

- LogoutResponse
  - `metadata` Metadata
    - `aiConfidence` number, double
    - `attributes` object
    - `categories` string[]
    - `causationId` string
    - `channel` string
    - `correlationId` string
    - `dataClassification` string
    - `embeddingId` string
    - `extrasJson` string, byte
    - `gamificationState` string
    - `globalContext` GlobalContext
      - `actorType` string
      - `auditContext` string
      - `deviceId` string
      - `ipAddress` string
      - `jurisdiction` string
      - `organizationId` string
      - `regulatedEntityRef` string
      - `roleId` string
      - `sessionId` string
      - `source` string
      - `userAgent` string
      - `userId` string
    - `idempotencyKey` string
    - `jurisdictionTags` string[]
    - `knowledgeGraph` string
    - `legalBasisCode` string
    - `locale` string
    - `payloadHash` string
    - `policySnapshotRef` string
    - `processedAt` string, date-time
    - `reasonCode` string
    - `requestId` string
    - `requestedAt` string, date-time
    - `retentionClass` string
    - `routeKey` string
    - `signatureRef` string
    - `sourceChannel` string
    - `sourceQueue` string
    - `sourceRef` string
    - `sourceService` string
    - `spanId` string
    - `tags` string[]
    - `tenantRegion` string
    - `traceId` string
    - `validityPeriod` ValidityPeriod
      - `effectiveFrom` string
      - `effectiveTo` string
  - `revoked` boolean

## Other responses

- `400`: Bad request
- `500`: Internal server error

---

[API](https://skmtc.dev/pronto/apis/pronto-api.md) · [All operations](https://skmtc.dev/pronto/apis/pronto-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pronto/apis/pronto-api/revisions/f1f239f2adc8?raw)