Documentation Index Fetch the complete documentation index at: https://auth0-dr-923.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Classe d’écran Défi-réponse de la MFA par SMS
La classe d’écran Défi-réponse de la MFA par SMS fournit des méthodes associées à l’écran mfa-sms-challenge.
Importez et instanciez la classe d’écran Défi-réponse de la MFA par SMS :
import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge' ;
const mfaSmsChallenge = new MfaSmsChallenge ();
// SDK Properties return a string, number or boolean
// ex. "login-id"
mfaSmsChallenge . screen . name ;
// SDK Methods return an object or array
await mfaSmsChallenge . continueMfaSmsChallenge ({
code: '123456' ,
rememberBrowser: true ,
});
Propriétés
Propriétés de la classe d’écran Défi-réponse de la MFA par SMS :
image de marque
client
organisation
invite
écran
locataire
transaction
untrustedData
utilisateur
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 | {
phone_number ?: 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 >
Méthodes
Propriétés de la classe d’écran Défi-réponse de la MFA par SMS :
continueMfaSmsChallenge( options ?)
Cette méthode soumet le code de vérification saisi et l’option rememberBrowser.
import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge' ;
const mfaSmsChallenge = new MfaSmsChallenge ();
await mfaSmsChallenge . continueMfaSmsChallenge ({
code: '123456' ,
rememberBrowser: true ,
});
Parameter Type Required Description codechaîne Oui Le code saisi par l’utilisateur. rememberBrowserbooléen Non Mémoriser la configuration du navigateur de l’utilisateur. [key: string]chaîne | nombre | booléen | non défini Non Données facultatives collectées auprès de l’utilisateur.
getACall( options ?)
Cette méthode permet d’envoyer le code de vérification par appel vocal.
import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge' ;
const mfaSmsChallenge = new MfaSmsChallenge ();
await mfaSmsChallenge . getACall ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected to user.
pickSms( options ?)
Cette méthode permet à l’utilisateur de sélectionner une configuration SMS différente, le cas échéant.
import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge' ;
const mfaSmsChallenge = new MfaSmsChallenge ();
await mfaSmsChallenge . pickSms ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected to user.
resendCode( options ?)
Cette méthode renvoie le code SMS.
import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge' ;
const mfaSmsChallenge = new MfaSmsChallenge ();
await mfaSmsChallenge . resendCode ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected to user.
tryAnotherMethod( options ?)
Cette méthode soumet l’action pour essayer une autre méthode de MFA.
import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge' ;
const mfaSmsChallenge = new MfaSmsChallenge ();
await mfaSmsChallenge . tryAnotherMethod ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected to user.
Classe d’écran Inscription MFA par SMS
La classe d’écran Inscription MFA par SMS fournit des méthodes associées à l’écran mfa-sms-challenge.
Importez et instanciez la classe d’écran Inscription MFA par SMS :
import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment' ;
const mfaSmsEnrollment = new MfaSmsEnrollment ();
// SDK Properties return a string, number or boolean
// ex. "login-id"
mfaSmsEnrollment . screen . name ;
// SDK Methods return an object or array
await mfaSmsEnrollment . pickCountryCode ();
Propriétés
Propriétés de la classe d’écran Défi-réponse MFA par SMS :
image de marque
client
organisation
invite
écran
locataire
transaction
untrustedData
utilisateur
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 | { phone ?: 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 >
Méthodes
Propriétés de la classe d’écran Défi-réponse MFA par SMS :
continueEnrollment( options ?)
Cette méthode poursuit le processus d’inscription par SMS avec le numéro de téléphone fourni.
import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment' ;
const mfaSmsEnrollment = new MfaSmsEnrollment ();
await mfaSmsEnrollment . continueEnrollment ({ phone: '1234567890' });
Parameter Type Required Description captchachaîne Conditionnellement Le code captcha ou la réponse du fournisseur de captcha. phonechaîne Non Le numéro de téléphone saisi par l’utilisateur. [key: string]chaîne | nombre | booléen | non défini Non Données facultatives collectées auprès de l’utilisateur.
pickCountryCode( options ?)
Cette méthode gère l’action de sélection d’un code pays pour l’inscription par SMS.
import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment' ;
const mfaSmsEnrollment = new MfaSmsEnrollment ();
await mfaSmsEnrollment . pickCountryCode ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected to user.
tryAnotherMethod( options ?)
Cette méthode gère l’action qui consiste à essayer une autre méthode de MFA.
import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment' ;
const mfaSmsEnrollment = new MfaSmsEnrollment ();
await mfaSmsEnrollment . tryAnotherMethod ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected to user.
Classe d’écran Liste MFA par SMS
La classe d’écran Liste MFA par SMS fournit des méthodes associées à l’écran mfa-sms-list.
Importez et instanciez la classe d’écran Liste MFA par SMS :
import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list' ;
const mfaSmsList = new MfaSmsList ();
// SDK Properties return a string, number or boolean
// ex. "login-id"
mfaSmsList . screen . name ;
// SDK Methods return an object or array
// ex. { signup: "/signup_url", reset_password: "/reset_password_url"}
await mfaSmsList . backAction ();
Propriétés
Propriétés de la classe d’écran Liste MFA par SMS :
image de marque
client
organisation
invite
écran
locataire
transaction
untrustedData
utilisateur
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 >
Méthodes
Propriétés de la classe d’écran Défi-réponse MFA par SMS :
backAction( options ?)
Cette méthode permet à l’utilisateur de revenir à l’écran précédent.
import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list' ;
const mfaSmsList = new MfaSmsList ();
await mfaSmsList . backAction ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected to user.
selectPhoneNumber( options ?)
Cette méthode permet à l’utilisateur de sélectionner un numéro de téléphone dans la liste des numéros de téléphone inscrits.
import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list' ;
const mfaSmsList = new MfaSmsList ();
await mfaSmsList . selectPhoneNumber ({
index: 0 // for demonstration we are selecting the first index
});
Parameter Type Required Description indexnuméro Oui L’index du numéro de téléphone à sélectionner. [key: string]chaîne | numéro | booléen | non défini Non Données facultatives collectées auprès de l’utilisateur.
Classe d’écran Indicatifs de pays MFA
La classe d’écran Indicatifs de pays MFA permet aux utilisateurs de sélectionner un indicatif de pays pour la vérification MFA par numéro de téléphone.
Importez et instanciez la classe d’écran Indicatifs de pays MFA
import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes' ;
const mfaCountryCodesManager = new MfaCountryCodes ();
// SDK Properties return a string, number or boolean
// ex. "login-id"
mfaCountryCodesManager . screen . name ;
// SDK Methods return an object or array
// ex. { signup: "/signup_url", reset_password: "/reset_password_url"}
await mfaCountryCodesManager . selectCountryCode ({
action: 'selection-action::US1'
});
Propriétés
Propriétés de la classe d’écran Indicatifs de pays MFA :
image de marque
client
organisation
invite
écran
locataire
transaction
untrustedData
utilisateur
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 | { phone_prefixes : PhonePrefix []; };
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 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 >
Méthodes
Propriétés de la classe d’écran Indicatifs de pays MFA :
goBack( options ?)
Cette méthode renvoie l’utilisateur à l’écran précédent.
import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes' ;
const mfaCountryCodes = new MfaCountryCodes ();
await mfaCountryCodes . goBack ();
Parameter Type Required Description [key: string]string | number | boolean | undefined No Optional data collected to user.
selectCountryCode( options ?)
Cette méthode permet à l’utilisateur de sélectionner un indicatif de pays.
import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes' ;
const mfaCountryCodes = new MfaCountryCodes ();
// Get the available country codes and phone prefixes
const { screen } = mfaCountryCodes ;
const { phone_prefixes } = screen . data
const { country_code , phone_prefix } = phone_prefixes [ 0 ]
await mfaCountryCodes . selectCountryCode ({
country_code: 'US' ,
phone_prefix: '+1' ,
});
Parameter Type Required Description country_codechaîne Oui Indicatif pays à sélectionner. phone_prefixchaîne Oui Préfixe téléphonique à sélectionner. [key: string]chaîne | nombre | booléen | non défini Non Données facultatives collectées auprès de l’utilisateur.