Admin APIAuth
Sign out
Revokes the session the refresh token belongs to: its refresh tokens stop working and so do access tokens issued for it. Succeeds for unknown or already revoked tokens, so it is safe to retry.
Header Parameters
Idempotency-Key?string
A unique value (e.g. a UUID) per logical request. Retrying with the same key within 24 hours replays the first response instead of repeating the side effect; the replay carries Idempotent-Replayed: true. Reusing a key for a different request is a 422 idempotency_key_reused; retrying while the first is still running is a 409 idempotency_request_in_progress. JSON bodies up to 1 MB.
Length
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
refresh_token*string
The session's current refresh token.
Response Body
application/json
application/json
curl -X POST "https://example.com/auth/logout" \ -H "Content-Type: application/json" \ -d '{ "refresh_token": "string" }'Empty
{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}