• Public
  • Public/Protected
  • All


  • BaseLoginOptions
    • Auth0ClientOptions


[key: string]: any

If you need to send custom parameters to the Authorization Server, make sure to use the original parameter name.



Optional acr_values

acr_values: string

Optional audience

audience: string

The default audience to be used for requesting API access.


client_id: string

The Client ID found on your Application settings page

Optional connection

connection: string

The name of the connection configured for your application. If null, it will redirect to the Auth0 Login Page and show the Login Widget.

Optional display

display: "page" | "popup" | "touch" | "wap"
  • 'page': displays the UI with a full page view
  • 'popup': displays the UI with a popup window
  • 'touch': displays the UI in a way that leverages a touch interface
  • 'wap': displays the UI with a "feature phone" type interface


domain: string

Your Auth0 account domain such as 'example.auth0.com', 'example.eu.auth0.com' or , 'example.mycompany.com' (when using custom domains)

Optional id_token_hint

id_token_hint: string

Previously issued ID Token.

Optional issuer

issuer: string

The issuer to be used for validation of JWTs, optionally defaults to the domain above

Optional leeway

leeway: number

The value in seconds used to account for clock skew in JWT expirations. Typically, this value is no more than a minute or two at maximum. Defaults to 60s.

Optional login_hint

login_hint: string

The user's email address or other identifier. When your app knows which user is trying to authenticate, you can provide this parameter to pre-fill the email box or select the right session for sign-in.

Optional max_age

max_age: string | number

Maximum allowable elasped time (in seconds) since authentication. If the last time the user authenticated is greater than this value, the user must be reauthenticated.

Optional prompt

prompt: "none" | "login" | "consent" | "select_account"
  • 'none': do not prompt user for login or consent on reauthentication
  • 'login': prompt user for reauthentication
  • 'consent': prompt user for consent before processing request
  • 'select_account': prompt user to select an account

Optional redirect_uri

redirect_uri: string

The default URL where Auth0 will redirect your browser to with the authentication result. It must be whitelisted in the "Allowed Callback URLs" field in your Auth0 Application's settings. If not provided here, it should be provided in the other methods that provide authentication.

Optional scope

scope: string

The default scope to be used on authentication requests. openid profile email is always added to all requests.

Optional ui_locales

ui_locales: string

The space-separated list of language tags, ordered by preference. For example: 'fr-CA fr en'.