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 Recovery Code Challenge screen class The MFA
Import and instantiate the MFA Recovery Code Challenge screen class:
import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge' ; const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge ();
Properties The MFA Recovery Code 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 | 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 Recovery Code Challenge screen class methods are:
continue( options ?) This method continues the MFA Recovery Code Challenge flow.
import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge' ; const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge (); mfaRecoveryCodeChallenge . continue ({ code: '123456' , });
Parameter Type Required Description codestring Yes The code entered by the user. [key: string]string | number | boolean | undefined No Optional data collected from user.
tryAnotherMethod( options ?) This method asks the user to try another challenge.
import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge' ; const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge (); mfaRecoveryCodeChallenge . tryAnotherMethod ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected from user.
MFA Recovery Code Challenge New Code screen class The MFA Recovery Code Challenge New Code screen class provides methods associated with the mfa-recovery-code-challenge-new-code screen. This screen displays the MFA recovery code for safe keeping.
Import and instantiate the MFA Recovery Code Challenge New Code screen class:
import MfaRecoveryCodeChallengeNewCode from '@auth0/auth0-acul-js/mfa-recovery-code-challenge-new-code' ; const mfaRecoveryCodeChallengeNewCode = new MfaRecoveryCodeChallengeNewCode ();
Properties The MFA Recovery Code Challenge New Code 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 | { textCode : string }; 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 Recovery Code Challenge New Code screen class methods is:
continue( options? ) This method confirms that the user has saved the new recovery code and continues the authentication flow.
const screenManager = new MfaRecoveryCodeChallengeNewCode (); // Assuming a checkbox 'confirmSaved' is checked by the user if ( confirmSaved ) { try { await screenManager . continue ({ customData: 'optionalValue' }); } catch ( err ) { // Handle errors, potentially check screenManager.transaction.errors console . error ( "Confirmation failed:" , err ); } } else { // Prompt user to confirm saving the code }
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected from user.
MFA Recovery Code Enrollment screen class The MFA Recovery Code Enrollment screen class provides methods associated with the mfa-recovery-code-enrollment screen. This screen displays the MFA recovery code for safe keeping.
Import and instantiate the MFA Recovery Code Enrollment screen class:
import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment' ; const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment ();
Properties The MFA Recovery Code Enrollment 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 | { textCode : string ; }; 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 Recovery Code Enrollment screen class methods is:
continue( options? ) This method declares that the user has confirmed that they saved their recovery code and continues to the next screen in the authentication flow.
import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment' ; const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment (); // Declare that the user saved the recovery code await mfaRecoveryCodeEnrollment . continue ();
Parameter Type Required Description isCodeCopiedboolean Yes The user confirms to have copied the recovery code. [key: string]string | number | boolean | undefined No Optional data collected from user.
