Site Home
API Reference
LoginTry for Free

Logout

get
https://{application_vanity_domain}/api/v1/logout
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

↪️

Redirect Required

Your application will need to redirect to this endpoint instead of making a direct API call.

🏢

Tenant Vanity Domain Required

When calling this API you need to use the vanity domain of the tenant that the user is logging out of.

Logs out the user by extracting the session ID from the auth session cookie and deleting the corresponding session.

Auth session cookies are scoped to tenant vanity domains, so the request must use the correct tenant vanity domain to ensure the session is properly deleted.

The API response is an HTTP 302 redirect, where the redirect location is determined by the following rules in the order listed:

  1. Redirects to the redirect_url query parameter, if provided.
  2. Redirects to the client's loginUrl, if a client ID is provided and the client has a configured login URL.
  3. Otherwise, redirects to the application's loginUrl.
Query Params
string
length between 1 and 26

ID of the client that initiated the logout request. If provided, the login URL from the client (if defined) will be used when resolving the final redirect URL.

uri
length between 1 and 2000

If provided, the Logout Endpoint will redirect to this URL after the logout operation has completed. Note, the redirect URL must be registered on the application before it can be used in the redirect_url query parameter.

string
length between 1 and 512

If provided, the value will be appended as a state query parameter to the resolved redirect URL. This can be used to transfer state between the Logout Endpoint and the resolved redirect endpoint.

Cookie Params
Responses

Updated about 1 month ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated about 1 month ago