Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • LogoutOptions

Index

Properties

Optional client_id

client_id: string

The client_id of your application.

If this property is not set, then the client_id that was used during initialization of the SDK is sent to the logout endpoint.

If this property is set to null, then no client ID value is sent to the logout endpoint.

Read more about how redirecting after logout works

Optional federated

federated: boolean

When supported by the upstream identity provider, forces the user to logout of their identity provider and from Auth0. This option cannot be specified along with the localOnly option. Read more about how federated logout works at Auth0

Optional localOnly

localOnly: boolean

When true, this skips the request to the logout endpoint on the authorization server, effectively performing a "local" logout of the application. No redirect should take place, you should update local logged in state. This option cannot be specified along with the federated option.

Optional returnTo

returnTo: string

The URL where Auth0 will redirect your browser to after the logout.

Note: If the client_id parameter is included, the returnTo URL that is provided must be listed in the Application's "Allowed Logout URLs" in the Auth0 dashboard. However, if the client_id parameter is not included, the returnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.

Read more about how redirecting after logout works