Logout
POST
/web/v1/system/auth/logout JWTRequired Gateway Headers
All API requests require gateway headers. See Required Headers for the complete list. In local/test environments, you must also include Cloudflare simulation headers (CF-Connecting-IP, Cf-Ray, cf-ipcountry).
Logs the authenticated user out by terminating the current session and invalidating the associated tokens.
Required Headers
| Header | Example Value | Description |
|---|---|---|
| Content-Type | application/json | Request content type |
| Accept | application/json | Expected response type |
| X-Client-Hash | Client device fingerprint | |
| Accept-Language | en, zh, zh-Hant, ja, vi | Response language (default: en) |
| Authorization | Bearer | JWT access token |
Request Parameters
No request parameters required.
Request Example
No request body required.
Success Response
Success 200
{
"version": "2.0.0",
"timestamp": 1711929600000,
"success": true,
"code": "2000",
"message": "SUCCESS",
"data": {
"success": true,
"terminatedSessions": 1
}
}| Field | Type | Description |
|---|---|---|
success | boolean | Whether the logout operation completed successfully |
terminatedSessions | integer | Number of sessions that were terminated by this logout |
Error Responses
Internal Server Error 500
{
"success": false,
"code": "SYSTEM.INTERNAL_ERROR",
"message": "Missing authentication context"
}Notes
- Terminates the current session and invalidates the associated tokens.
- The
terminatedSessionsfield in the response indicates how many sessions were ended. - Rate limited to 10 requests per default window (
@RateLimit(limit=10)).