LoginOptions

Example

export interface LoginOptions {
  username?: string;
  identifier?: string;
  identifierType?: IdentifierType;
  phoneCountryCode?: string;
  captcha?: string;
  [key: string]: string | number | boolean | undefined;
}

Indexable

[key: string]: string | number | boolean | undefined

Properties

string

The identifier to login with — email, username, or phone, depending on identifierType. Optional if username is supplied; if both are given, identifier wins.

IdentifierType

What identifier (or username) holds. Typically read from screen.data.activeIdentifierType. Omit to submit the identifier untyped.

string

The ISO 3166-1 alpha-2 country for a phone identifier, from a code in countryCodes.available. Required when identifierType is phone. Pass the national number — the dial code is prefixed server-side.

string

The user’s identifier, under its original spelling. Optional if identifier is supplied — required otherwise.

auth0-acul-js

auth0-acul-react

auth0-android

auth0-php

Indexable

Properties

​Indexable

​Properties

Indexable

Properties