/auth/logout

POST /auth/logout

Logout of your current user session

Invalidates the current user session and clears authentication data

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Try it out

Output:

Responses

Description

Logout successful

{
  "message": "Logged out successfully"
}

Description

Unauthorized - not authenticated

{
  "error": "string",
  "status": 0,
  "message": "string"
}

Description

Internal server error

{
  "error": "string",
  "status": 0,
  "message": "string"
}

References

#/components/schemas/Error

OpenAPI
TypeScript

type: object
properties:
  error:
    type: string
    description: Error message
  status:
    type: integer
    description: HTTP status code
  message:
    type: string
    description: Detailed error message
description: Error response object
required:
  - error

|
export interface Error {
  /** Error message */
  error: string;
  /** HTTP status code */
  status?: number;
  /** Detailed error message */
  message?: string;
}

Route Source Code

Check out the source code for this route entrypoint here: /auth/logout/route.ts

Or the swagger.yaml spec this documentation was generated from: /auth/logout/swagger.yaml