DELETE/auth/logout

Logout

Invalidates the current GMA session. Send the SessionToken obtained from Get Session Token as the x-session-token header. After a successful logout, the token can no longer be used on secured endpoints.

Headers

FieldTypeRequiredPossible valuesDescription
x-session-tokenstringRequired

SessionToken obtained from the Get Session Token endpoint. Required to identify and invalidate the active session.

Response

FieldTypePossible valuesDescription
ResponseCodeinteger200 | 201 | 204 | 301 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 503

API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).

ResponseMessagestringSuccess | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntity

Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.

ResponseDataobjectPlease refer to below example for response body

Empty success envelope. The session has been invalidated.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success"
}

Use the same SessionToken value returned by GET /auth. This endpoint expects the x-session-token header (not session-token).

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose