Logout OAuth user

Logs out the user and revokes the access/refresh tokens based on the id_token_hint passed to the end_session endpoint

POST/{apiBasePath}/oauth/logout

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Request body

application/json

logoutChallengestringrequired

Responses

200Accepts the logout request specified by the challenge and gets where the user should be redirected to

One of:

object

frontendRedirectTostring

The URL to redirect the user to

generalErrorResponse

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

400OAuth2 specific error response

errorstring

The OAuth2 error code

error_descriptionstring

Human readable error description

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the user

Bodyapplication/json

logoutChallengestring*

Request

curl -X POST "/auth/oauth/logout" \
  -H "Content-Type: application/json" \
  -d '{
  "logoutChallenge": "string"
}'

const response = await fetch("/auth/oauth/logout", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "logoutChallenge": "string"
})
});

import requests

response = requests.post(
    "/auth/oauth/logout",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "logoutChallenge": "string"
},
)

Response

{
  "frontendRedirectTo": "https://auth.example.com/auth/oauth/logout?logoutChallenge=1234567890"
}

{
  "error": "invalid_request",
  "error_description": "Unsupported grant type: password"
}

"Not Found"

"Internal Error"