Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Indexable

[key: string]: any

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

Index

Properties

Optional acr_values

acr_values: string

Optional audience

audience: string

The default audience to be used for requesting API access.

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

Optional id_token_hint

id_token_hint: string

Previously issued ID Token.

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 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'.