Skip to content
Authrim

End a Direct Auth managed browser session.

POST
/api/v1/auth/direct/logout
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/v1/auth/direct/logout \
  --header 'Content-Type: application/json' \
  --data '{ "client_id": "client_123", "revoke_tokens": false }'

Invalidates the current Direct Auth session when present, optionally revokes associated device secrets according to logout_scope, and clears Direct Auth cookies. Guest resume credentials are revoked before session invalidation. If session retrieval or revocation fails, returns 503 and preserves cookies for retry.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
client_id
string
revoke_tokens
boolean
logout_scope
string
Example 
{
  "client_id": "client_123",
  "revoke_tokens": false
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
success
required
boolean
message
required
string
Example 
{
  "success": true,
  "message": "Logged out successfully"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

503

Section titled “503 ”

Logout could not complete. Retry with the same cookies.

Media type application/json
object
error
required
string
Allowed value: logout_unavailable
Example 
{
  "error": "logout_unavailable"
}