Logout and revoke the current token

Overview

Revokes the token used to make the call. Only that token: other devices signed in to the same account keep working.

Controller: App\Http\Controllers\Api\V1\Auth\AuthController::logout()
Route name: api.v1.auth.logout

Type: Bearer Token
Header: Authorization: Bearer {token}

Method: POST
Path: /api/v1/auth/logout
Content-Type: application/json

No parameters and no body.

{
  "success": true,
  "status": "success",
  "message": "Successfully logged out"
}

There is no data key: the envelope omits it entirely when the payload is null.

{
  "success": false,
  "status": "error",
  "message": "Unauthenticated"
}

message is one of Unauthenticated (no token supplied), Invalid token (malformed or unknown), Token expired.

The token row is deleted, not flagged. Reusing it afterwards returns 401 immediately.

To sign out every device, use the privacy screen in the web application, or change the password: both revoke the account's other tokens.