Documentation Index Fetch the complete documentation index at: https://docs-staging-quickstart-revamp.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
MFA Email Challenge screen class The MFA
Import and instantiate the MFA Email Challenge screen class:
import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge' ; const mfaEmailChallengeManager = new MfaEmailChallenge (); // SDK Properties return a string, number or boolean // ex. "login-id" mfaDetectBrowserCapabilitiesManager . screen . name ; // SDK Methods return an object or array // ex. { signup: "/signup_url", reset_password: "/reset_password_url"} await mfaEmailChallenge . continue ({ code: '123456' , rememberDevice: true });
Properties The MFA Email Challenge screen class properties are:
branding
client
organization
prompt
screen
tenant
transaction
untrustedData
user
interface branding { settings : null | BrandingSettings ; themes : null | BrandingThemes ; } interface BrandingSettings { colors ?: { pageBackground ?: string | { angleDeg : number ; end : string ; start : string ; type : string ; }; primary ?: string ; }; faviconUrl ?: string ; font ?: { url : string ;}; logoUrl ?: string ; } interface BrandingThemes { default : { borders : Record < string , string | number | boolean >; colors : Record < string , string >; displayName : string ; fonts : Record < string , string | boolean | object >; pageBackground : Record < string , string >; widget : Record < string , string | number >; }; }
interface client { description : null | string ; id : string ; logoUrl : null | string ; name : string ; metadata : null | {[ key : string ] : string ;}; }
interface organization { branding : null | { colors ?: { pageBackground ?: string ; primary ?: string ; }; logoUrl ?: string ; }; displayName : null | string ; id : null | string ; metadata : null | {[ key : string ] : string ;}; name : null | string ; usage : null | string ; }
interface prompt { name : string ; }
interface screen { captcha : null | CaptchaContext ; captchaImage : null | string ; captchaProvider : null | string ; captchaSiteKey : null | string ; data : null | { email : string ; remember_device ?: boolean ; }; isCaptchaAvailable : boolean ; links : null | Record < string , string >; name : string ; texts : null | Record < string , string >; } interface CaptchaContext { image ?: string ; provider : string ; siteKey ?: string ; }
interface tenant { enabledFactors : null | string []; enabledLocales : null | string []; friendlyName : null | string ; name : null | string ; }
interface transaction { alternateConnections : null | ( Connection | EnterpriseConnection )[]; connectionStrategy : null | string ; countryCode : null | string ; countryPrefix : null | string ; currentConnection : null | Connection ; errors : null | Error []; hasErrors : boolean ; locale : string ; state : string ; } interface Connection { metadata ?: Record < string , string >; name : string ; strategy : string ; } interface EnterpriseConnection { metadata ?: Record < string , string >; name : string ; options : { displayName ?: string ; iconUrl ?: string ; showAsButton : boolean ; }; strategy : string ; }
interface untrustedData { authorizationParams : null | { login_hint ?: string ; screen_hint ?: string ; ui_locales ?: string ; [ key : `ext- ${ string } ` ] : string ; }; submittedFormData : null | { [ key : string ] : | string | number | boolean | undefined ; }; }
interface user { appMetadata : null | {[ key : string ] : string ;}; email : null | string ; enrolledDevices : null | ShortEntity < "device" >[]; enrolledEmails : null | ShortEntity < "email" >[]; enrolledFactors : null | string []; enrolledPhoneNumbers : null | ShortEntity < "phoneNumber" >[]; id : null | string ; organizations : null | { branding : undefined | { logoUrl : undefined | string ;}; displayName : undefined | string ; organizationId : undefined | string ; organizationName : undefined | string ; }[]; phoneNumber : null | string ; picture : null | string ; userMetadata : null | {[ key : string ] : string ;}; username : null | string ; } ShortEntity < Key > : { id: number ; } & Record < Key , string >
Methods The MFA Email Challenge screen class method are:
continue( options ?) This method continues with the email challenge using the provided code.
import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge' ; const mfaEmailChallenge = new MfaEmailChallenge (); await mfaEmailChallenge . continue ({ code: '123456' , rememberDevice: true });
Parameter Type Required Description codestring yes Code entered by user. rememberDeviceboolean No Remember user’s device. [key: string]string | number | boolean | undefined No Optional data collected from user.
pickEmail( options ?) This method allows the user to select other emails, if available.
import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge' ; const mfaEmailChallenge = new MfaEmailChallenge (); await mfaEmailChallenge . pickEmail ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected from user.
resendCode( options ?) This method resends email code.
import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge' ; const mfaEmailChallenge = new MfaEmailChallenge (); await mfaEmailChallenge . resendCode ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected from user.
tryAnotherMethod( options ?) This method allows the user to select another MFA option.
import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge' ; const mfaEmailChallenge = new MfaEmailChallenge (); await mfaEmailChallenge . tryAnotherMethod ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected from user.
MFA Email List screen class The MFA Email List screen class allows users to select an enrolled email address for MFA.
Import and instantiate the MFA Email List screen class:
import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list' ; const mfaEmailList = new MfaEmailList (); // SDK Properties return a string, number or boolean // ex. "login-id" mfaEmailList . screen . name ; // SDK Methods return an object or array await mfaEmailList . selectMfaEmail ({ index: 0 // for demonstration we are selecting the first index });
Properties The MFA Email List screen class properties are:
branding
client
organization
prompt
screen
tenant
transaction
untrustedData
user
interface branding { settings : null | BrandingSettings ; themes : null | BrandingThemes ; } interface BrandingSettings { colors ?: { pageBackground ?: string | { angleDeg : number ; end : string ; start : string ; type : string ; }; primary ?: string ; }; faviconUrl ?: string ; font ?: { url : string ;}; logoUrl ?: string ; } interface BrandingThemes { default : { borders : Record < string , string | number | boolean >; colors : Record < string , string >; displayName : string ; fonts : Record < string , string | boolean | object >; pageBackground : Record < string , string >; widget : Record < string , string | number >; }; }
interface client { description : null | string ; id : string ; logoUrl : null | string ; name : string ; metadata : null | {[ key : string ] : string ;}; }
interface organization { branding : null | { colors ?: { pageBackground ?: string ; primary ?: string ; }; logoUrl ?: string ; }; displayName : null | string ; id : null | string ; metadata : null | {[ key : string ] : string ;}; name : null | string ; usage : null | string ; }
interface prompt { name : string ; }
interface screen { captcha : null | CaptchaContext ; captchaImage : null | string ; captchaProvider : null | string ; captchaSiteKey : null | string ; data : null | Record < string , | string | boolean | PasskeyCreate | string [] | PhonePrefix []> | Record < string , string []>>; isCaptchaAvailable : boolean ; links : null | Record < string , string >; name : string ; texts : null | Record < string , string >; } interface CaptchaContext { image ?: string ; provider : string ; siteKey ?: string ; } interface PhonePrefix { country : string ; country_code : string ; phone_prefix : string ; } interface PasskeyCreate { public_key : { authenticatorSelection : { residentKey : string ; userVerification : string ; }; challenge : string ; pubKeyCredParams : [{ alg : number ; type : string }]; rp : { id : string ; name : string }; user : { displayName : string ; id : string ; name : string }; }; }
interface tenant { enabledFactors : null | string []; enabledLocales : null | string []; friendlyName : null | string ; name : null | string ; }
interface transaction { alternateConnections : null | ( Connection | EnterpriseConnection )[]; connectionStrategy : null | string ; countryCode : null | string ; countryPrefix : null | string ; currentConnection : null | Connection ; errors : null | Error []; hasErrors : boolean ; locale : string ; state : string ; } interface Connection { metadata ?: Record < string , string >; name : string ; strategy : string ; } interface EnterpriseConnection { metadata ?: Record < string , string >; name : string ; options : { displayName ?: string ; iconUrl ?: string ; showAsButton : boolean ; }; strategy : string ; }
interface untrustedData { authorizationParams : null | { login_hint ?: string ; screen_hint ?: string ; ui_locales ?: string ; [ key : `ext- ${ string } ` ] : string ; }; submittedFormData : null | { [ key : string ] : | string | number | boolean | undefined ; }; }
interface user { appMetadata : null | {[ key : string ] : string ;}; email : null | string ; enrolledDevices : null | ShortEntity < "device" >[]; enrolledEmails : null | ShortEntity < "email" >[]; enrolledFactors : null | string []; enrolledPhoneNumbers : null | ShortEntity < "phoneNumber" >[]; id : null | string ; organizations : null | { branding : undefined | { logoUrl : undefined | string ;}; displayName : undefined | string ; organizationId : undefined | string ; organizationName : undefined | string ; }[]; phoneNumber : null | string ; picture : null | string ; userMetadata : null | {[ key : string ] : string ;}; username : null | string ; } ShortEntity < Key > : { id: number ; } & Record < Key , string >
Methods The MFA Email List screen class method are:
goBack( options ?) This method allows the user to navigate to previous screen.
import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list' ; const mfaEmailList = new MfaEmailList (); await mfaEmailList . goBack ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected from user.
selectMfaEmail( options ?) This method allows the user to select from a list of enrolled email address.
import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list' ; const mfaEmailList = new MfaEmailList (); await mfaEmailList . selectMfaEmail ({ index: 0 // for demonstration we are selecting the first index });
Parameter Type Required Description indexnumber Yes The index of the email address to select. [key: string]string | number | boolean | undefined No Optional data collected from user.
