Interface LoginMembers

Login screen members interface extending base members

interface LoginMembers {
    branding: BrandingMembers;
    client: ClientMembers;
    organization: OrganizationMembers;
    prompt: PromptMembers;
    tenant: TenantMembers;
    user: UserMembers;
    untrustedData: UntrustedDataMembers;
    getErrors(): Error[];
    changeLanguage(options: LanguageChangeOptions): Promise<void>;
    screen: ScreenMembersOnLogin;
    transaction: TransactionMembersOnLogin;
    login(payload: LoginPayloadOptions): Promise<void>;
    federatedLogin(payload: FederatedLoginPayloadOptions): Promise<void>;
    pickCountryCode(payload?: CustomOptions): Promise<void>;
    googleOneTap(payload: GoogleOneTapOptions): Promise<void>;
    getLoginIdentifiers(): IdentifierType[] | null;
}

Hierarchy (View Summary)

BaseMembers
- LoginMembers

Index

Properties

branding client organization prompt tenant user untrustedData screen transaction

Methods

getErrors changeLanguage login federatedLogin pickCountryCode googleOneTap getLoginIdentifiers

Properties

branding

branding: BrandingMembers

client

client: ClientMembers

organization

organization: OrganizationMembers

prompt

prompt: PromptMembers

tenant

tenant: TenantMembers

user

user: UserMembers

untrustedData

untrustedData: UntrustedDataMembers

screen

screen: ScreenMembersOnLogin

transaction

transaction: TransactionMembersOnLogin

Methods

getErrors

getErrors(): Error[]
Returns Error[]
Inherited from BaseMembers.getErrors
- Defined in packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:32

changeLanguage

changeLanguage(options: LanguageChangeOptions): Promise<void>
Parameters
- options: LanguageChangeOptions
Returns Promise<void>
Inherited from BaseMembers.changeLanguage
- Defined in packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:33

login(payload: LoginPayloadOptions): Promise<void>
Performs login with username/password
Parameters
- payload: LoginPayloadOptions
  The login options
Returns Promise<void>
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:81

federatedLogin

federatedLogin(payload: FederatedLoginPayloadOptions): Promise<void>
Performs login with social provider
Parameters
- payload: FederatedLoginPayloadOptions
  The social login options
Returns Promise<void>
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:86

pickCountryCode

pickCountryCode(payload?: CustomOptions): Promise<void>
Picks country code for phone number input
Parameters
- Optionalpayload: CustomOptions
  Optional custom options
Returns Promise<void>
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:91

googleOneTap

googleOneTap(payload: GoogleOneTapOptions): Promise<void>
Submits a Google One Tap credential to complete authentication
Parameters
- payload: GoogleOneTapOptions
  The Google ID token returned by the GSI SDK
Returns Promise<void>
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:96

getLoginIdentifiers

getLoginIdentifiers(): IdentifierType[] | null
Gets the active identifier types for the login screen

Returns IdentifierType[] | null
An array of active identifier types or null if none are active

Utility Feature
- Defined in packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:102