Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0-feat-authentication-api-migration.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

GET /v2/logout Use this endpoint to logout a user. If you want to navigate the user to a specific URL after the logout, set that URL at the returnTo parameter. The URL should be included in the appropriate Allowed Logout URLs list:
  • If the client_id parameter is included, the returnTo URL must be listed in the Allowed Logout URLs set at the application level. To learn more, read Log Users Out of Applications.
  • If the client_id parameter is NOT included, the returnTo URL must be listed in the Allowed Logout URLs set at the tenant level. To learn more, read Log Users Out of Auth0.
  • If the client_id parameter is included and the returnTo URL is NOT set, the server returns the user to the first Allowed Logout URLs set in the Dashboard. To learn more, read Log Users Out of Applications.

Remarks

  • Logging the user out of their identity provider is not common practice, so think about the user experience before you use the federated query string parameter.
  • The sample auth0.js script uses the library version 8. If you are using auth0.js version 7, please see this reference guide.

Learn More

Parameters

client_id
string
The client_id of your application.
returnTo
string
required
URL to redirect the user after the logout.
federated
string
Add this query string parameter to the logout URL, to log the user out of their identity provider.

Response

StatusDescription
200Successfully logged out
400Bad request, possibly due to missing required parameters