MfaWebAuthnRoamingChallengeMembers

MfaWebAuthnRoamingChallengeMembers

Example

export interface MfaWebAuthnRoamingChallengeMembers extends BaseMembers {
  /**
   * Propriétés et données propres à l'écran, y compris les options de défi WebAuthn.
   * @type {ScreenMembersOnMfaWebAuthnRoamingChallenge}
   */
  screen: ScreenMembersOnMfaWebAuthnRoamingChallenge;

  /**
   * Lance le défi WebAuthn en appelant `navigator.credentials.get()` avec les
   * options fournies dans `screen.data.publicKeyChallengeOptions`.
   * En cas de succès, soumet les informations d'identification résultantes à Auth0 avec `action: "default"`.
   * Si `navigator.credentials.get()` échoue avec une erreur d'API WebAuthn connue (comme `NotAllowedError`),
   * cette méthode appellera `reportWebAuthnError` en interne pour en informer Auth0.
   *
   * @param {VerifySecurityKeyOptions} [options] - Paramètres facultatifs pour le processus de vérification,
   * tels que `rememberDevice` et d'autres options personnalisées.
   * @returns {Promise<void>} Une promesse qui se résout lorsque la tentative de vérification est soumise.
   *                          Elle ne retourne pas directement de données, car une opération réussie entraîne généralement une redirection.
   * @throws {Error} Génère une erreur si `screen.data.publicKeyChallengeOptions` est absent,
   *                 si `navigator.credentials.get()` échoue avec une erreur inattendue,
   *                 ou si la soumission du formulaire à Auth0 échoue.
   *
   * @example
   * ```typescript
   * // En supposant que 'sdk' est une instance de MfaWebAuthnRoamingChallenge
   * try {
   *   await sdk.verify({ rememberDevice: true });
   *   // En cas de succès, Auth0 gère la redirection.
   * } catch (error) {
   *   console.error("Échec de la vérification de la clé de sécurité :", error);
   *   // Vérifiez sdk.transaction.errors pour les messages de validation côté serveur si la page se recharge.
   * }
   * ```
   */
  verify(options?: VerifySecurityKeyOptions): Promise<void>;

  /**
   * Signale une erreur d'API WebAuthn spécifique à Auth0.
   * Cette méthode doit être utilisée si `navigator.credentials.get()` échoue d'une façon que
   * `verify()` ne gère pas automatiquement, ou si le développeur souhaite signaler explicitement
   * une erreur avant de tenter une autre action.
   * Elle soumet les détails de l'erreur avec `action: "showError::{errorDetails}"`.
   *
   * @param {ReportWebAuthnErrorOptions} options - Contient l'objet `error` avec `name` et `message`
   * provenant de l'API WebAuthn, ainsi que toute autre option personnalisée.
   * @returns {Promise<void>} Une promesse qui se résout lorsque le rapport d'erreur est soumis.
   * @throws {Error} Génère une erreur si la soumission du formulaire échoue.
   *
   * @example
   * ```typescript
   * // En supposant que 'sdk' est une instance de MfaWebAuthnRoamingChallenge
   * // Et que webAuthnError est un objet d'erreur provenant d'un appel échoué à navigator.credentials.get().
   * try {
   *   await sdk.reportWebAuthnError({
   *     error: { name: webAuthnError.name, message: webAuthnError.message }
   *   });
   * } catch (submitError) {
   *   console.error("Échec du signalement de l'erreur WebAuthn :", submitError);
   * }
   * ```
   */
  reportWebAuthnError(options: ReportWebAuthnErrorOptions): Promise<void>;

  /**
   * Permet à l'utilisateur de se soustraire au défi WebAuthn et de sélectionner une méthode d'AMF différente.
   * Cette action soumet `action: "pick-authenticator"` à Auth0, ce qui devrait diriger
   * l'utilisateur vers un écran de sélection de facteur d'AMF.
   *
   * @param {TryAnotherMethodOptions} [options] - Paramètres personnalisés facultatifs pour la requête.
   * @returns {Promise<void>} Une promesse qui se résout lorsque l'action est soumise.
   * @throws {Error} Génère une erreur si la soumission du formulaire échoue.
   *
   * @example
   * ```typescript
   * // En supposant que 'sdk' est une instance de MfaWebAuthnRoamingChallenge
   * try {
   *   await sdk.tryAnotherMethod();
   *   // En cas de succès, Auth0 gère la redirection vers la sélection d'AMF.
   * } catch (error) {
   *   console.error("Échec du changement de méthode d'AMF :", error);
   * }
   * ```
   */
  tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>;
}

Propriétés

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembersOnMfaWebAuthnRoamingChallenge

Propriétés et données propres à l’écran, y compris les options du défi WebAuthn.

tenant · TenantMembers

transaction · TransactionMembers

untrustedData · UntrustedDataMembers

user · UserMembers

Méthodes

reportWebAuthnError · Promise<void>

Signale à Auth0 une erreur précise de l’API WebAuthn. Cette méthode doit être utilisée si navigator.credentials.get() échoue d’une façon que verify() ne gère pas automatiquement, ou si le développeur veut signaler explicitement une erreur avant de tenter une autre action. Elle soumet les détails de l’erreur avec action: "showError::{errorDetails}".

Une promesse qui se résout lorsque le signalement de l’erreur est soumis.

Lève

Lève une erreur si la soumission du formulaire échoue.

Example

// En supposant que 'sdk' est une instance de MfaWebAuthnRoamingChallenge
// Et que webAuthnError est un objet d’erreur provenant d’un appel échoué à navigator.credentials.get().
try {
  await sdk.reportWebAuthnError({
    error: { name: webAuthnError.name, message: webAuthnError.message }
  });
} catch (submitError) {
  console.error("Failed to report WebAuthn error:", submitError);
}

Show Paramètres

options · MfaWebAuthnRoamingChallengeReportErrorOptions

Contient l’objet error avec name et message de l’API WebAuthn, ainsi que toute autre option personnalisée.

Propriétés

error · WebAuthnErrorDetails

L’objet d’erreur de l’API WebAuthn à signaler.

tryAnotherMethod · Promise<void>

Permet à l’utilisateur de renoncer au défi WebAuthn et de sélectionner une autre méthode d’AMF. Cette action soumet action: "pick-authenticator" à Auth0, ce qui devrait diriger l’utilisateur vers un écran de sélection du facteur d’AMF.

Une promesse qui se résout lorsque l’action est soumise.

Lève

Lève une erreur si la soumission du formulaire échoue.

Example

// En supposant que 'sdk' est une instance de MfaWebAuthnRoamingChallenge
try {
  await sdk.tryAnotherMethod();
  // En cas de succès, Auth0 gère la redirection vers la sélection AMF.
} catch (error) {
  console.error("Failed to switch MFA method:", error);
}

Show Paramètres

options? · MfaWebAuthnRoamingChallengeTryAnotherMethodOptions

Paramètres personnalisés facultatifs pour la requête.

verify · Promise<void>

Lance le défi WebAuthn en appelant navigator.credentials.get() avec les options fournies dans screen.data.publicKeyChallengeOptions. Si l’opération réussit, les informations d’identification obtenues sont soumises à Auth0 avec action: "default". Si navigator.credentials.get() échoue avec une erreur connue de l’API WebAuthn (comme NotAllowedError), cette méthode appelle reportWebAuthnError en interne pour en informer Auth0.

Une promesse qui se résout lorsque la tentative de vérification est soumise. Elle ne retourne pas directement de données, puisqu’une opération réussie entraîne généralement une redirection.

Lève

Lève une erreur si screen.data.publicKeyChallengeOptions est absent, si navigator.credentials.get() échoue avec une erreur inattendue, ou si la soumission du formulaire à Auth0 échoue.

Example

// En supposant que 'sdk' est une instance de MfaWebAuthnRoamingChallenge
try {
  await sdk.verify({ rememberDevice: true });
  // En cas de succès, Auth0 gère la redirection.
} catch (error) {
  console.error("Security key verification failed:", error);
  // Vérifiez sdk.transaction.errors pour les messages de validation côté serveur si la page se recharge.
}

Show Paramètres

options? · VerifySecurityKeyOptions

Paramètres facultatifs du processus de vérification, comme rememberDevice et d’autres options personnalisées.

Propriétés

rememberDevice? · boolean

Facultatif. Si true, tente de mémoriser le navigateur pour les prochains défis d’AMF. Correspond au champ de formulaire rememberBrowser.