Skip to main content

Interface: ExtraLoginOptions

Hierarchy​

  • BaseLoginOptions

    ↳ ExtraLoginOptions

Properties​

acr_values​

• Optional acr_values: string

Inherited from​

BaseLoginOptions.acr_values

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:81

audience​

• Optional audience: string

The default audience to be used for requesting API access.

Inherited from​

BaseLoginOptions.audience

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:91

client_id​

• Optional client_id: string

The Client ID found on your Application settings page

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:109

connection​

• Optional 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.

Inherited from​

BaseLoginOptions.connection

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:97

display​

• Optional display: string

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

Inherited from​

BaseLoginOptions.display

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:50

domain​

• Optional domain: string

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

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:105

id_token_hint​

• Optional id_token_hint: string

Previously issued ID Token.

Inherited from​

BaseLoginOptions.id_token_hint

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:72

isVerifierIdCaseSensitive​

• Optional isVerifierIdCaseSensitive: boolean

Whether the verifier id field is case sensitive

Default Value

true

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:132

leeway​

• Optional 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.

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:123

login_hint​

• Optional 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.

Inherited from​

BaseLoginOptions.login_hint

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:80

max_age​

• Optional 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 re-authenticated.

Inherited from​

BaseLoginOptions.max_age

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:63

prompt​

• Optional prompt: string

  • 'none': do not prompt user for login or consent on re-authentication
  • 'login': prompt user for re-authentication
  • 'consent': prompt user for consent before processing request
  • 'select_account': prompt user to select an account

Inherited from​

BaseLoginOptions.prompt

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:57

redirect_uri​

• Optional 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.

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:117

scope​

• Optional scope: string

The default scope to be used on authentication requests. The defaultScope defined in the Auth0Client is included along with this scope

Inherited from​

BaseLoginOptions.scope

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:87

ui_locales​

• Optional ui_locales: string

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

Inherited from​

BaseLoginOptions.ui_locales

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:68

verifierIdField​

• Optional verifierIdField: string

The field in jwt token which maps to verifier id

Defined in​

node_modules/@web3auth/react-native-sdk/node_modules/@toruslabs/openlogin-utils/dist/types/interfaces.d.ts:127