get https://{application_vanity_domain}/api/v1/logout
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 a user out by extracting the session ID from the auth session cookie and deleting their auth session. Auth session cookies are tied to tenant vanity domains, so it's important that the correct tenant vanity domain is used in the request in order to ensure that the session gets deleted properly.
The end result of this API is an HTTP 302 redirect. The redirect destination rules apply in the order listed as follows:
- Redirect to the value of the
redirect_url
query param, if provided. - Redirect to the client's
loginUrl
, if a client ID is provided and the client has a login URL configured. - Otherwise, redirect to the application
loginUrl
.