Classes de l’écran d’inscription
Classe de l’écran d’inscription
La classe de l’écran d’inscription fait partie du flux Identifier First Authentication (authentification Identifier First) et recueille le mot de passe de l’identifiant de l’utilisateur. Selon la configuration de votre locataire, cet identifiant peut être une adresse courriel, un numéro de téléphone ou un nom d’utilisateur.
![]() |
Importer et instancier la classe de l’écran d’inscription
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
// SDK Properties return a string, number or boolean
// ex. "login-id"
signupManager.screen.name;
// SDK Methods return an object or array
// ex. { signup: "/signup_url", reset_password: "/reset_password_url"}
signupManager.screenLinks();
Was this helpful?
Propriétés
Les propriétés de la classe de l’écran d’inscription sont :
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>;
};
}
Was this helpful?
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
Was this helpful?
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;
}
Was this helpful?
interface prompt{
name: string;
}
Was this helpful?
interface screen {
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | {
loginLink?: string;
name?: string;
};
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
name: string;
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
Was this helpful?
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
Was this helpful?
interface TransactionMembersOnSignup {
alternateConnections: null | (Connection | EnterpriseConnection)[];
connectionStrategy: null | string;
countryCode: null | string;
countryPrefix: null | string;
currentConnection: null | Connection;
errors: null | Error[];
hasErrors: boolean;
isPasskeyEnabled: boolean;
locale: string;
optionalIdentifiers: null | ("email" | "username" | "phone")[];
requiredIdentifiers: null | ("email" | "username" | "phone")[];
state: string;
usernamePolicy: null | UsernamePolicy;
}
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 UsernamePolicy {
allowedFormats: {
usernameInEmailFormat: boolean;
usernameInPhoneFormat: boolean;
};
maxLength: number;
minLength: number;
}
Was this helpful?
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;
};
}
Was this helpful?
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>
Was this helpful?
Methods
Les méthodes de la classe de l’écran d’inscription sont :
pickCountryCode( options? )
Cette méthode redirige l’utilisateur vers la liste de sélection du code pays, où il peut mettre à jour le préfixe du code pays pour son numéro de téléphone.
import Signup from "@auth0/auth0-acul-js/signup";
const signupManager = new Signup();
signupManager.pickCountryCode();
Was this helpful?
signup( options? )
Cette méthode redirige l’utilisateur vers l’étape suivante du flux d’authentification. Selon la configuration du serveur, cet écran peut inclure des entrées pour un ou plusieurs des éléments suivants : courriel, nom d’utilisateur ou numéro de téléphone. Pour plus de détails, veuillez consulter Identifiants flexibles.
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.signup({
email: 'test@example.com',
password: 'P@$$wOrd123!',
});
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
email |
chaîne | Conditionnellement | Adresse courriel de l’utilisateur. |
phone |
chaîne | Conditionnellement | Numéro de téléphone de l’utilisateur. |
username |
chaîne | Conditionnellement | Nom d’utilisateur de l’utilisateur. |
password |
chaîne | Conditionnellement | Mot de passe de l’utilisateur. |
captcha |
chaîne | Conditionnellement | Code Captcha ou réponse du fournisseur de Captcha. Cette propriété est requise si votre locataire Auth0 a activé la détection des robots. |
[key: string] |
Chaîne | Numéro | Booléen | Non défini | Non | Données supplémentaires collectées auprès de l’utilisateur. Ces données sont accessibles dans le déclencheur d’action pre-user-registration . |
socialSignup( options? )
Cette méthode redirige l’utilisateur vers le fournisseur d’identité sociale ou d’entreprise (IdP) pour l’authentification. Pour plus de détails, veuillez consulter Social Identity Providers (Fournisseurs d’identité sociale) et Enterprise Identity Providers (Fournisseurs d’identité de l’entreprise).
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.federatedSignup({
connection: 'google-oauth2'
});
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
connection |
chaîne | Oui | Identifiant de la connexion. |
[clé: chaîne] |
chaîne | nombre | booléen | non défini | Non | Données supplémentaires collectées auprès de l’utilisateur. |
Classe de l’identifiant de l’écran d’inscription
La classe de l’identifiant de l’écran d’inscription fait partie du flux Identifier First Authentication (Authentification Identifier First) et recueille le mot de passe de l’identifiant de l’utilisateur. Selon la configuration de votre locataire, cet identifiant peut être une adresse courriel, un numéro de téléphone ou un nom d’utilisateur.
![]() |
Importer et instancier la classe de l’identifiant de l’écran d’inscription
import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
// SDK Properties return a string, number or boolean
// ex. "signup-id"
signupIdManager.screen.name;
// SDK Methods return an object or array
// ex. { login: "/login_url"}
signupIdManager.screenLinks();
Was this helpful?
Properties
Les propriétés de la classe de l’identifiant de l’écran d’inscription sont :
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>;
};
}
Was this helpful?
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
Was this helpful?
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;
}
Was this helpful?
interface prompt{
name: string;
}
Was this helpful?
interface screen {
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | Record<string, string>;
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
loginLink: null | string;
name: string;
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
Was this helpful?
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
Was this helpful?
interface transaction {
alternateConnections: null | (Connection | EnterpriseConnection)[];
connectionStrategy: null | string;
countryCode: null | string;
countryPrefix: null | string;
currentConnection: null | Connection;
errors: null | Error[];
hasErrors: boolean;
isPasskeyEnabled: boolean;
locale: string;
optionalIdentifiers: null | ("email" | "username" | "phone")[];
requiredIdentifiers: null | ("email" | "username" | "phone")[];
state: string;
usernamePolicy: null | UsernamePolicy;
}
interface Connection {
metadata?: Record<string, string>;
name: string;
strategy: string;
}
interface EnterpriseConnection {
metadata?: Record<string, string>;
name: string;
options: {
display_name?: string;
icon_url?: string;
show_as_button: boolean;
};
strategy: string;
}
interface UsernamePolicy {
allowedFormats: {
usernameInEmailFormat: boolean;
usernameInPhoneFormat: boolean;
};
maxLength: number;
minLength: number;
}
Was this helpful?
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;
};
}
Was this helpful?
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>
Was this helpful?
Methods
Les méthodes de la classe de l’identifiant de l’écran d’inscription sont :
signup( options? )
Cette méthode redirige l’utilisateur vers l’étape suivante du flux d’authentification. Selon la configuration du serveur, cet écran peut inclure des entrées pour un ou plusieurs des éléments suivants : courriel, nom d’utilisateur ou numéro de téléphone. Pour plus de détails, veuillez consulter Identifiants flexibles.
import SignupId from "@auth0/auth0-acul-js/signup-id";
const signupIdManager = new SignupId();
const { transaction } = signupIdManager;
//get mandatory & optional identifiers required for signup
const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email
const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone
const signupParams = {
email : "testEmail",
phone : "+91923456789"
};
signupIdManager.signup(signupParams);
Was this helpful?
Paramètre | Type | Obligatoire | Description |
---|---|---|---|
email |
chaîne | Conditionnellement | Le courriel de l’utilisateur. |
phone |
chaîne | Conditionnellement | Le numéro de téléphone de l’utilisateur. |
username |
chaîne | Conditionnellement | Le nom d’utilisateur de l’utilisateur. |
captcha |
chaîne | Conditionnellement | Le code captcha ou la réponse du fournisseur captcha. Cette propriété est obligatoire si votre locataire Auth0 a activé la détection de robots. |
[key: string] |
chaîne | nombre | booléen | non défini | Non | Données supplémentaires recueillies auprès de l’utilisateur. Les données sont accessibles dans le déclencheur d’action pre-user-registration . |
socialSignup( options? )
Cette méthode redirige l’utilisateur vers le fournisseur d’identité sociale ou d’entreprise (IdP) pour l’authentification. Pour plus de détails, veuillez consulter Social Identity Providers (Fournisseurs d’identité sociale) et Enterprise Identity Providers (Fournisseurs d’identité de l’entreprise).
import SignupId from "@auth0/auth0-acul-js/signup-id";
const signupIdManager = new SignupId();
const { transaction } = signupIdManager;
//get social connections
const socialConnection = transaction.getAlternateConnections(); //eg: "google-oauth2"
const signupParams = {
connection : socialConnection[0].name, // "google-oauth2"
};
signupIdManager.federatedSignup(signupParams);
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
connection |
chaîne | Oui | Identifiant de la connexion. |
[clé: chaîne] |
chaîne | nombre | booléen | non défini | Non | Données supplémentaires collectées auprès de l’utilisateur. |
Écran d’inscription avec mot de passe
L’écran d’inscription par mot de passe fait partie du flux Identifier First Authentication (Authentification Identifier First) et permet à l’utilisateur de créer un mot de passe pour son profil.
![]() |
Importer et instancier la classe de l’identifiant de l’écran d’inscription
import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
// SDK Properties return a string, number or boolean
// ex. "signup-password"
signupPasswordManager.screen.name;
// SDK Methods return an object or array
// ex. { login: "/login_url", edit_identifier: "/edit_url"}
signupPasswordManager.screenLinks();
Was this helpful?
Properties
Les propriétés de la classe de l’écran inscription par mot de passe sont :
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>;
};
}
Was this helpful?
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
Was this helpful?
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;
}
Was this helpful?
interface prompt{
name: string;
}
Was this helpful?
interface screen {
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | {
email?: string;
phone?: string;
username?: string;
};
editLink: null | string;
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
loginLink: null | string;
name: string;
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
Was this helpful?
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
Was this helpful?
interface transaction {
alternateConnections: null | (Connection | EnterpriseConnection)[];
connectionStrategy: null | string;
countryCode: null | string;
countryPrefix: null | string;
currentConnection: null | Connection;
errors: null | Error[];
hasErrors: boolean;
isPasskeyEnabled: boolean;
locale: string;
optionalIdentifiers: null | ("email" | "username" | "phone")[];
passwordPolicy: null | PasswordPolicy;
requiredIdentifiers: null | ("email" | "username" | "phone")[];
state: string;
}
interface Connection {
metadata?: Record<string, string>;
name: string;
strategy: string;
}
interface EnterpriseConnection {
metadata?: Record<string, string>;
name: string;
options: {
display_name?: string;
icon_url?: string;
show_as_button: boolean;
};
strategy: string;
}
interface PasswordPolicy {
minLength?: number;
policy:
| "low"
| "fair"
| "good"
| "excellent";
}
Was this helpful?
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;
};
}
Was this helpful?
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>
Was this helpful?
Methods
La méthode de classe de l’écran inscription par mot de passe est :
signup( options? )
Cette méthode soumet l’identifiant de l’étape précédente et le mot de passe fourni pour créer le compte de l’utilisateur. Une fois créé, l’utilisateur est dirigé vers l’étape suivante.
signupPasswordManager.signup({
email: <EmailFieldValue>
phone: <PhoneFieldValue>
username: <UsernameFieldValue>
password: ********
});
Was this helpful?
Paramètre | Type | Obligatoire | Description |
---|---|---|---|
captcha |
chaîne | Conditionnellement | Le code captcha ou la réponse du fournisseur captcha. Cette propriété est obligatoire si votre locataire Auth0 a activé la détection de robots. |
email |
chaîne | Conditionnellement | Le courriel de l’utilisateur. |
password |
chaîne | Oui | Le mot de passe de l’utilisateur. |
phone |
chaîne | Conditionnellement | Le numéro de téléphone de l’utilisateur. |
username |
chaîne | Conditionnellement | Le nom d’utilisateur de l’utilisateur. |
[key: string] |
chaîne | nombre | booléen | non défini | Non | Données supplémentaires recueillies auprès de l’utilisateur. Les données sont accessibles dans le déclencheur d’action pre-user-registration . |
Classe de l’écran d’inscription par clé d’identification.
La classe de l’écran d’inscription par clé d’identification fait partie du flux Identifier First Authentication (Authentification Identifier First). Il permet à l’utilisateur de créer une clé d’identification à utiliser comme identifiant d’authentification pour toutes les authentifications ultérieures sur votre application. Veuillez consulter Passkeys (Clés d’identification) pour en savoir plus sur l’utilisation des clés d’identification dans Auth0.
![]() |
Importer et instancier la classe de l’écran d’inscription par clé d’identification
import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment';
const passskeyEnrollmentManager = new PasskeyEnrollment();
// SDK Properties return a string, number or boolean
// ex. "passkey-enrollment"
passskeyEnrollmentManager.screen.name;
// SDK Methods return an object or array
// ex. { back: "/back_url" }
passskeyEnrollmentManager.screenLinks();
Was this helpful?
Properties
Les propriétés de la classe de l’écran d’inscription par clé d’identification sont :
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>;
};
}
Was this helpful?
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
Was this helpful?
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;
}
Was this helpful?
interface prompt{
name: string;
}
Was this helpful?
interface screen {
backLink: null | string;
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | Record<string, string>;
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
loginLink: null | string;
name: string;
publicKey: null | {
authenticatorSelection: {
residentKey: string;
userVerification: string;
};
challenge: string;
pubKeyCredParams: [{
alg: number;
type: string;
}];
rp: {
id: string;
name: string;
};
user: {
displayName: string;
id: string;
name: string;
};
};
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
Was this helpful?
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
Was this helpful?
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;
}
Was this helpful?
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;
};
}
Was this helpful?
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>
Was this helpful?
Methods
Les méthodes de la classe de l’écran d’inscription par clé d’identification sont :
abortPasskeyEnrollment( options? )
Cette méthode envoie l’utilisateur vers l’écran d’inscription par mot de passe pour créer son mot de passe.
// This method does not support any parameters
passkeyEnrollment.abortPasskeyEnrollment();
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
[key: string] |
chaîne | nombre | booléen | non défini | Non | Données facultatives collectées auprès de l’utilisateur. |
continuePasskeyEnrollment( options? )
Créez une clé d’identification et authentifiez l’utilisateur. Après avoir créé la clé d’identification, cette méthode envoie l’utilisateur à redirect_url
.
// This method does not support any parameters
passkeyEnrollment.continuePasskeyEnrollment();
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
[key: string] |
chaîne | nombre | booléen | non défini | Non | Données facultatives collectées auprès de l’utilisateur. |
Classe de l’écran local d’inscription par clé d’identification
La classe de l’écran local d’inscription par clé d’identification fait partie du flux Identifier First Authentication (Authentification Identifier First). Il permet à l’utilisateur de créer une clé d’identification à utiliser comme identifiant d’authentification pour toutes les authentifications ultérieures sur votre application. Veuillez consulter Passkeys (Clés d’identification) pour en savoir plus sur l’utilisation des clés d’identification dans Auth0
![]() |
Importer et instancier la classe de l’écran local d’inscription par clé d’identification
import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local';
const passskeyEnrollmentLocalManager = new PasskeyEnrollmentLocal();
// SDK Properties return a string, number or boolean
// ex. "passkey-enrollment-local"
passskeyEnrollmentLocalManager.screen.name;
// SDK Methods return an object or array
// ex. { back: "/back_url" }
passskeyEnrollmentLocalManager.screenLinks();
Was this helpful?
Properties
Les propriétés de la classe de l’écran local d’inscription par clé d’identification sont :
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>;
};
}
Was this helpful?
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
Was this helpful?
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;
}
Was this helpful?
interface prompt{
name: string;
}
Was this helpful?
interface screen {
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | Record<string, string>;
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
name: string;
publicKey: null | {
authenticatorSelection: {
residentKey: string;
userVerification: string;
};
challenge: string;
pubKeyCredParams: [{
alg: number;
type: string;
}];
rp: {
id: string;
name: string;
};
user: {
displayName: string;
id: string;
name: string;
};
};
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
Was this helpful?
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
Was this helpful?
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;
}
Was this helpful?
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;
};
}
Was this helpful?
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>
Was this helpful?
Methods
Les méthodes de la classe de l’écran local d’inscription par clé d’identification sont :
abortPasskeyEnrollment( options )
Ignorez la création de la clé d’identification et fournissez plutôt un mot de passe. Cette méthode envoie l’utilisateur vers Signup Password Screen (Écran d’inscription par mot de passe) pour créer son mot de passe.
passkeyEnrollment.abortPasskeyEnrollment({
doNotShowAgain: <BooleanFieldValue>
});
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
doNotShowAgain |
booléen | Oui | Indique si l’utilisateur souhaite ou non qu’on lui rappelle de créer à nouveau une clé d’identification après avoir ignoré la création initiale. |
continuePasskeyEnrollment( options? )
Créez une clé d’identification et authentifiez l’utilisateur. Après avoir créé la clé d’identification, cette opération envoie l’utilisateur à la redirect_url
.
// This method does not support any parameters
passkeyEnrollment.continuePasskeyEnrollment();
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
[key: string] |
chaîne | nombre | booléen | non défini | Non | Données facultatives collectées auprès de l’utilisateur. |
Classe de l’écran de défi d'identifiant du téléphone
La classe de l’écran de vérification du numéro de téléphone fait partie du flux Identifier First Authentication (Authentification Identifier First) et vérifie le numéro de téléphone de l’utilisateur avant de lui permettre de s’inscrire. Pour plus de détails, veuillez consulter Activer et configurer les attributs pour les identifiants flexibles.
![]() |
Importer et instancier la classe de l’écran de défi d'identifiant du téléphone
import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
// SDK Properties return a string, number or boolean
// ex. "phone-identifier-challenge"
phoneIdentifierChallengeManager.screen.name;
// SDK Methods return an object or array
// ex. data: { message_type: "text", phone: "+1234567890" };
phoneIdentifierChallengeManager.screenData();
Was this helpful?
Properties
Les propriétés de la classe de l’écran de défi d'identifiant du téléphone sont :
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>;
};
}
Was this helpful?
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
Was this helpful?
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;
}
Was this helpful?
interface prompt{
name: string;
}
Was this helpful?
interface screen {
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | {
messageType?: "text" | "voice";
phone?: string;
};
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
name: string;
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
Was this helpful?
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
Was this helpful?
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;
}
Was this helpful?
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;
};
}
Was this helpful?
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>
Was this helpful?
Methods
Les méthodes de la classe de l’écran de défi d'identifiant du téléphone sont :
resendCode( options? )
Cette méthode envoie un nouveau code OTP à l’adresse courriel fournie à l’étape précédente.
// This method does not support any parameters
phoneIdentifierChallenge.resendCode();
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
[key: string] |
chaîne | nombre | booléen | non défini | Non | Données facultatives collectées auprès de l’utilisateur. |
returnToPrevious( options? )
Cette méthode renvoie l’utilisateur à l’étape précédente.
// This method does not support any parameters
phoneIdentifierChallenge.returnToPrevious();
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
[key: string] |
chaîne | nombre | booléen | non défini | Non | Données facultatives collectées auprès de l’utilisateur. |
submitPhoneChallenge( options )
Cette méthode vérifie le numéro de téléphone fourni et permet à l’utilisateur de continuer à s’inscrire.
phoneIdentifierChallenge.submitPhoneChallenge({
code: "<CodeFieldValue>"
});
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
captcha |
chaîne | Conditionnellement | Le code CAPTCHA ou la réponse du fournisseur de CAPTCHA. Cette propriété est requise si la détection de robots est activée dans votre tenant Auth0. |
code |
chaîne | Oui | Le code OTP envoyé au numéro de téléphone. |
[key: string] |
chaîne | nombre | booléen | indéfini | Non | Données facultatives recueillies de l’utilisateur. |
Classe de l’écran d’inscription à l'identifiant du téléphone
La classe de l’écran d’inscription à la vérification du numéro de téléphone fait partie du flux Identifier First Authentication (Authentification Identifier First) et permet à l’utilisateur de sélectionner une méthode pour vérifier son numéro de téléphone avant de poursuivre le processus d’inscription. Pour plus de détails, veuillez consulter Activer et configurer les attributs pour les identifiants flexibles.
![]() |
Importer et instancier de l’écran d’inscription à l'identifiant du téléphone
import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();
// SDK Properties return a string, number or boolean
// ex. "phone-identifier-enrollment"
phoneIdentifierEnrollmentManager.screen.name;
// SDK Methods return an object or array
// ex. { phone_number: "+1234567890" }
phoneIdentifierEnrollmentManager.screenData();
Was this helpful?
Properties
Les propriétés de la classe de l’écran d’inscription à l'identifiant du téléphone sont :
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>;
};
}
Was this helpful?
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
Was this helpful?
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;
}
Was this helpful?
interface prompt{
name: string;
}
Was this helpful?
interface screen {
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | {
messageType?: "text" | "voice";
phone?: "string";
};
editIdentifierLink: null | string;
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
name: string;
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
Was this helpful?
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
Was this helpful?
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;
}
Was this helpful?
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;
};
}
Was this helpful?
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>
Was this helpful?
Methods
Les méthodes de la classe de l’écran d’inscription à l'identifiant du téléphone sont :
continuePhoneEnrollment( options )
Envoyez un code de mot de passe à usage unique via la méthode choisie par l’utilisateur au numéro de téléphone fourni à l’étape précédente.
phoneIdentifierChallenge.continuePhoneEnrollment({
type: "text" | "voice"
});
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
type |
chaîne | Oui | Valeurs possibles : text or voice |
[clé: chaîne] |
chaîne | nombre | booléen | non défini | Non | Données optionnelles collectées auprès de l’utilisateur. |
returnToPrevious( options? )
Cette méthode renvoie l’utilisateur à l’étape précédente.
// This method does not support any parameters
phoneIdentifierChallenge.returnToPrevious();
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
[key: string] |
chaîne | nombre | booléen | non défini | Non | Données facultatives collectées auprès de l’utilisateur. |
Classe de l’écran de défi de l’identifiant de l’adresse courriel
La classe de l’écran de vérification de l’adresse courriel fait partie du flux Identifier First Authentication (Authentification Identifier First) et vérifie l’adresse courriel de l’utilisateur avant de lui permettre de s’inscrire. Pour plus de détails, veuillez consulter Activer et configurer les attributs pour les identifiants flexibles.
![]() |
Importer et instancier la classe de l’écran de l'identifiant de l’adresse courriel :
import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
// SDK Properties return a string, number or boolean
// ex. "email-identifier-challenge"
emailIdentifierChallengeManager.screen.name;
// SDK Methods return an object or array
// ex. { email: "someone@example.com" }
emailIdentifierChallengeManager.screenData();
Was this helpful?
Properties
Les propriétés de la classe de l’écran de vérification de l'identifiant de l’adresse courriel sont :
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>;
};
}
Was this helpful?
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
Was this helpful?
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;
}
Was this helpful?
interface prompt{
name: string;
}
Was this helpful?
interface screen{
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | {
email?: string;
messageType?: string;
};
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
name: string;
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
Was this helpful?
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
Was this helpful?
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;
}
Was this helpful?
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;
};
}
Was this helpful?
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>
Was this helpful?
Methods
Les méthodes de la classe de l’écran de l'identifiant de l’adresse courriel :
resendCode( options? )
Cette méthode envoie un nouveau code OTP à l’adresse courriel fournie à l’étape précédente.
// This method does not support any parameters
emailIdentifierChallenge.resendCode();
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
[key: string] |
chaîne | nombre | booléen | non défini | Non | Données facultatives collectées auprès de l’utilisateur. |
returnToPrevious( options? )
Cette méthode renvoie l’utilisateur à l’étape précédente.
// This method does not support any parameters
emailIdentifierChallenge.returnToPrevious();
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
[key: string] |
chaîne | nombre | booléen | non défini | Non | Données facultatives collectées auprès de l’utilisateur. |
submitEmailChallenge( options? )
Cette méthode vérifie l’adresse courriel fournie et permet à l’utilisateur de continuer à s’inscrire.
emailIdentifierChallenge.submitEmailChallenge({
code: <CodeFieldValue>
});
Was this helpful?
Paramètre | Type | Requis | Description |
---|---|---|---|
captcha |
chaîne | Conditionnellement | Le code CAPTCHA ou la réponse du fournisseur de CAPTCHA. Cette propriété est requise si la détection de robots est activée dans votre tenant Auth0. |
code |
chaîne | Oui | Le code OTP envoyé à l'adresse courriel. |
[key: string] |
chaîne | nombre | booléen | indéfini | Non | Données supplémentaires recueillies de l’utilisateur. |