End OAuth session

Redirects the user to a page where they can log out and revoke the oauth tokens - for a detailed description of input parameters please see the user initiated logout spec

POST/{apiBasePath}/oauth/end_session

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Request body

application/json

id_token_hintstring

client_idstring

post_logout_redirect_uristring

Responses

200A general error response

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

302Redirects the user to the logout page or back to the client app

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

id_token_hintstringclient_idstringpost_logout_redirect_uristring

Request

curl -X POST "/auth/oauth/end_session" \
  -H "Content-Type: application/json" \
  -d '{
  "id_token_hint": "string",
  "client_id": "st-cl-example-client",
  "post_logout_redirect_uri": "https://client.example.com/logoutCallback"
}'

const response = await fetch("/auth/oauth/end_session", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "id_token_hint": "string",
  "client_id": "st-cl-example-client",
  "post_logout_redirect_uri": "https://client.example.com/logoutCallback"
})
});

import requests

response = requests.post(
    "/auth/oauth/end_session",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "id_token_hint": "string",
  "client_id": "st-cl-example-client",
  "post_logout_redirect_uri": "https://client.example.com/logoutCallback"
},
)

Response

{
  "status": "GENERAL_ERROR",
  "message": "string"
}

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

"Not Found"

"Internal Error"