@auth0/auth0-acul-react - v1.7.0
    Preparing search index...

    Type Alias LoginPayloadOptions

    LoginPayloadOptions: LoginIdentifierOptions & {
        password: string;
        captcha?: string;
        identifierType?: IdentifierType;
        phoneCountryCode?: string;
        [key: string]: string | number | boolean | undefined;
    }

    Options for performing login operations

    Type Declaration

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

      Any additional custom options

    • password: string

      The password for authentication

    • Optionalcaptcha?: string

      Optional captcha value if required

    • OptionalidentifierType?: IdentifierType

      What identifier holds — typically from screen.data.activeIdentifierType. Omit to submit untyped.

    • OptionalphoneCountryCode?: string

      ISO 3166-1 alpha-2 country for a phone identifier, from a code in countryCodes.available. Required with identifierType: 'phone'. The dial code is prefixed server-side, so pass the national number — unparenthesized, as (201) 555-0123 is submitted unprefixed. Omitting the country submits untyped, leaving the server to resolve one.

    The identifier is described by LoginIdentifierOptions.