Interface ClearSessionParameters

Parameters for sending to the Auth0 logout endpoint.

interface ClearSessionParameters {
    federated?: boolean;
    returnToUrl?: string;
}

Properties

federated? returnToUrl?

Properties

Optional federated

federated?: boolean

If true, the user will be signed out of any connected identity providers in addition to their Auth0 session.

Default

false

See

https://auth0.com/docs/authenticate/login/logout/log-users-out-of-idps

Optional returnToUrl

returnToUrl?: string

Specify a custom redirect URL to be used. Normally, you wouldn't need to call this method manually as the default value is autogenerated for you.

If you are using this, ensure a proper redirect URL is constructed in the following format Android: {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback iOS: {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback

If you have useLegacyCallbackUrl set to true then the redirect URL should in the format Android: {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback iOS: {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc