Interface AuthorizationParams

interface AuthorizationParams {
    acr_values?: string;
    audience?: string;
    connection?: string;
    display?: "page" | "popup" | "touch" | "wap";
    experiment_id?: string;
    id_token_hint?: string;
    invitation?: string;
    login_hint?: string;
    max_age?: string | number;
    organization?: string;
    prompt?: "none" | "login" | "consent" | "select_account";
    redirect_uri?: string;
    scope?: string;
    screen_hint?: string;
    segment_id?: string;
    session_transfer_token?: string;
    ui_locales?: string;
    variation_id?: string;
    [key: string]: any;
}

Indexable

[key: string]: any

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

Properties

acr_values? audience? connection? display? experiment_id? id_token_hint? invitation? login_hint? max_age? organization? prompt? redirect_uri? scope? screen_hint? segment_id? session_transfer_token? ui_locales? variation_id?

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 experiment_id

experiment_id?: string

Forces a specific Experiment Center variant for this /authorize request instead of letting Auth0 assign one via its hash. Use together with variation_id.

Pass per-call (on loginWithRedirect/loginWithPopup) rather than at client construction time so the override does not bleed into silent prompt=none token-renewal calls, where Experiment Center does not run.

Testing: drive from test automation (e.g. Cypress/Playwright) with IDs from a CI environment variable against a staging tenant. Do not hard-code this in shipped app code.

Production: pass the variant decision from a feature-flag tool (e.g. LaunchDarkly) that has already decided which variant the user should see for this request.

Optional id_token_hint

id_token_hint?: string

Previously issued ID Token.

Optional invitation

invitation?: string

The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.

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.

This currently only affects the classic Lock experience.

Optional max_age

max_age?: string | number

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

Optional organization

organization?: string

The organization to log in to.

This will specify an organization parameter in your user's login request.

  • If you provide an Organization ID (a string with the prefix org_), it will be validated against the org_id claim of your user's ID Token. The validation is case-sensitive.
  • If you provide an Organization Name (a string without the prefix org_), it will be validated against the org_name claim of your user's ID Token. The validation is case-insensitive. To use an Organization Name you must have "Allow Organization Names in Authentication API" switched on in your Auth0 settings dashboard. More information is available on the Auth0 documentation portal

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.

This defaults to profile email if not set. If you are setting extra scopes and require profile and email to be included then you must include them in the provided scope.

Note: The openid scope is always applied regardless of this setting.

Optional screen_hint

screen_hint?: string

Provides a hint to Auth0 as to what flow should be displayed. The default behavior is to show a login page but you can override this by passing 'signup' to show the signup page instead.

This only affects the New Universal Login Experience.

Optional segment_id

segment_id?: string

An optional segment identifier to pass alongside experiment_id and variation_id when forcing a variant.

Optional session_transfer_token

session_transfer_token?: string

Session transfer token from a native application for Native to Web SSO. When sessionTransferTokenQueryParamName is set, this is automatically extracted from the specified URL query parameter if present.

See

https://auth0.com/docs/authenticate/single-sign-on/native-to-web

Optional ui_locales

ui_locales?: string

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

Optional variation_id

variation_id?: string

The variation to force within the experiment identified by experiment_id. Auth0 uses this value instead of computing an assignment for the current request. The override applies to this request only; the next login without these params reverts to normal server-side assignment.

Settings

Member Visibility

Theme

On This Page

acr_valuesaudienceconnectiondisplayexperiment_idid_token_hintinvitationlogin_hintmax_ageorganizationpromptredirect_uriscopescreen_hintsegment_idsession_transfer_tokenui_localesvariation_id