> ## Documentation Index > Fetch the complete documentation index at: https://docs.paulsjob.ai/llms.txt > Use this file to discover all available pages before exploring further. # Log out > ### **Logout API Documentation** #### **API Overview** - **Name:** Logout API - **Description:** This API endpoint allows users to log out by invalidating their session or token. - **Method:** `Delete` - **Endpoint URL:** `/v1/logout` ### **Authentication** - **Authentication Required:** Yes - The user must be authenticated (i.e., must include a valid token) to successfully log out. ### **Request** #### **HTTP Method:** - `Delete` #### **URL:** - `/v1/logout` #### **Headers:** | Header Name | Description | Required | Example | | --- | --- | --- | --- | | `Authorization` | Bearer token used to authenticate the user | Yes | `Bearer` | | `Content-Type` | The content type of the request | No | `application/json` | **Note:** The token should be passed in the `Authorization` header as a Bearer token. #### **Request Body:** No request body is necessary for this endpoint. ### **Responses** #### **Success Response:** - **Status Code:** `200 OK` If the logout is successful, the response confirms that the user has been logged out. ## OpenAPI ````yaml delete /v1/logout openapi: 3.0.0 info: title: Pauls Job Public Endpoints description: >- #### **Description:** This API provides a comprehensive suite of endpoints for managing user authentication, session control, and other key functionalities within the application for Pauls Job. The endpoints are designed to ensure secure and efficient communication between clients and the server, offering robust access control mechanisms through token-based authentication. #### **Key Features:** - **Authentication:** Allows users to securely log in using their credentials and receive a token for accessing protected resources. - **Session Management:** Provides a logout mechanism to securely end user sessions and invalidate tokens. - **Error Handling:** Clear and descriptive error messages ensure that issues such as invalid credentials, expired tokens, or missing parameters are easily identifiable. This API is built with a focus on security and ease of use, making it essential for integrating user authentication and session management into applications while maintaining a high standard of data protection. version: 1.0.0 servers: - url: https://api.hyrd.de security: [] tags: - name: Users description: >- #### **Description:** The folder contains the foundational information and essential API endpoints for starting with the authentication and session management of the application. This includes the critical login and logout functionalities, which are necessary for users to authenticate and manage their sessions securely. #### **APIs Included:** 1. **Login API**: Allows users to log in by providing their credentials and receive an authentication token. 2. **Logout API**: Enables users to log out by invalidating the token and ending their session. These endpoints are designed to facilitate secure access control and session handling, making them an essential starting point for any interaction with the platform's protected resources. - name: General - name: Company - name: Company > Candidate - name: Company > Api Integrations paths: /v1/logout: delete: tags: - Users summary: Log out description: >- ### **Logout API Documentation** #### **API Overview** - **Name:** Logout API - **Description:** This API endpoint allows users to log out by invalidating their session or token. - **Method:** `Delete` - **Endpoint URL:** `/v1/logout` ### **Authentication** - **Authentication Required:** Yes - The user must be authenticated (i.e., must include a valid token) to successfully log out. ### **Request** #### **HTTP Method:** - `Delete` #### **URL:** - `/v1/logout` #### **Headers:** | Header Name | Description | Required | Example | | --- | --- | --- | --- | | `Authorization` | Bearer token used to authenticate the user | Yes | `Bearer` | | `Content-Type` | The content type of the request | No | `application/json` | **Note:** The token should be passed in the `Authorization` header as a Bearer token. #### **Request Body:** No request body is necessary for this endpoint. ### **Responses** #### **Success Response:** - **Status Code:** `200 OK` If the logout is successful, the response confirms that the user has been logged out. parameters: - name: Authorization in: header schema: type: string example: Bearer {{Bearer Token}} responses: '200': description: OK headers: Date: schema: type: string example: Wed, 27 Mar 2024 12:08:43 GMT Content-Type: schema: type: string example: application/json; charset=utf-8 Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Frame-Options: schema: type: string example: SAMEORIGIN X-XSS-Protection: schema: type: integer example: '0' X-Content-Type-Options: schema: type: string example: nosniff X-Download-Options: schema: type: string example: noopen X-Permitted-Cross-Domain-Policies: schema: type: string example: none Referrer-Policy: schema: type: string example: strict-origin-when-cross-origin Set-Cookie: schema: type: string example: >- _interslice_session=w%2FKBLc7%2FQz2rwj%2BBciWaZy36quGaI9d3S2zfML%2BQ7ro8W1eY%2BQwPvy%2BeC8HzSjjqsNUzSI%2BB7QxFgQAjp08m9%2BUHfdE96FDNyw27Awii2EKiXUCgO3W0rSwu627KnV0j09%2BxQpTcPiQQEwfSlVwZ1D4FNJYvd5aWopc5XyGcbtCpBICR7Ie4R3hCpA%3D%3D--l6ZTb%2BKPAwv9n2Ci--mhnvIWMgTysmz0HjFORCJA%3D%3D; path=/; HttpOnly; SameSite=Lax ETag: schema: type: string example: W/"0cb859d39dbb161bffef86ac71f21443" Cache-Control: schema: type: string example: max-age=0, private, must-revalidate X-Request-Id: schema: type: string example: d7d56f2a86b29c58641e422d780e517e X-Runtime: schema: type: number example: '0.006202' vary: schema: type: string example: Origin Strict-Transport-Security: schema: type: string example: max-age=15724800; includeSubDomains content: application/json: schema: type: object example: message: logged out successfully status: 200 ````