ResetPasswordMfaWebAuthnPlatformChallengeMembers

ResetPasswordMfaWebAuthnPlatformChallengeMembers

Example

export interface ResetPasswordMfaWebAuthnPlatformChallengeMembers extends BaseMembers {
  /**
   * Accès aux propriétés et données propres à l'écran 'reset-password-mfa-webauthn-platform-challenge'.
   * @type {ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge}
   */
  screen: ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge;

  /**
   * Lance le défi de plateforme WebAuthn en appelant `navigator.credentials.get()`
   * à l'aide des options de défi fournies dans `screen.publicKey`.
   * En cas de réussite, soumet l'assertion d'accréditation résultante à Auth0 avec `action: "default"`.
   *
   * @param {ContinueWithPasskeyOptions} [options] - Paramètres facultatifs pour le processus de vérification,
   * tels que `rememberDevice` (si `screen.showRememberDevice` est true) et d'autres options personnalisées.
   * @returns {Promise<void>} Une promesse qui se résout lorsque la tentative de vérification est soumise.
   *                          Une opération réussie entraîne généralement une redirection.
   * @throws {Error} Génère une erreur si `screen.publicKey` est manquant,
   *                 si `navigator.credentials.get()` échoue (p. ex., annulation par l'utilisateur `NotAllowedError`),
   *                 ou si la soumission du formulaire à Auth0 échoue. Si `navigator.credentials.get()` échoue
   *                 avec une `DOMException`, il est recommandé d'intercepter cette erreur et d'appeler `reportBrowserError`.
   *
   * @example
   * ```typescript
   * // En supposant que 'sdk' est une instance de ResetPasswordMfaWebAuthnPlatformChallenge
   * try {
   *   await sdk.continueWithPasskey({
   *     rememberDevice: true // si l'utilisateur a coché la case et que sdk.screen.showRememberDevice est true
   *   });
   *   // En cas de réussite, Auth0 gère la redirection.
   * } catch (error) {
   *   console.error("Platform authenticator verification failed:", error);
   *   // S'il s'agit d'une erreur de l'API WebAuthn (DOMException), la signaler
   *   if (error instanceof DOMException && error.name && error.message) {
   *     await sdk.reportBrowserError({ error: { name: error.name, message: error.message } });
   *   }
   *   // Vérifier sdk.transaction.errors pour les messages de validation côté serveur si la page se recharge.
   * }
   * ```
   */
  continueWithPasskey(options?: ContinueWithPasskeyOptions): Promise<void>;

  /**
   * Signale une erreur côté navigateur survenue lors de l'appel d'API `navigator.credentials.get()`.
   * Utilisé pour informer Auth0 de problèmes tels que l'annulation par l'utilisateur, le délai d'attente ou le matériel non pris en charge.
   * Soumet les détails de l'erreur avec `action: "showError::{errorDetailsJsonString}"`.
   *
   * @param {ReportBrowserErrorOptions} options - Contient l'objet `error` (avec `name` et `message`
   *                                              provenant de la DOMException de l'API WebAuthn) et toute option personnalisée.
   * @returns {Promise<void>} Une promesse qui se résout lorsque le rapport d'erreur est soumis.
   * @throws {Error} Si la soumission du formulaire échoue (p. ex., erreur réseau).
   *
   * @example
   * ```typescript
   * // En supposant que 'sdk' est une instance de ResetPasswordMfaWebAuthnPlatformChallenge
   * // et que 'webAuthnError' est une DOMException provenant d'un appel échoué à navigator.credentials.get().
   * try {
   *   await sdk.reportBrowserError({
   *     error: { name: webAuthnError.name, message: webAuthnError.message }
   *   });
   *   // Auth0 peut réafficher la page ou rediriger selon l'erreur.
   * } catch (submitError) {
   *   console.error("Failed to report WebAuthn browser error:", submitError);
   * }
   * ```
   */
  reportBrowserError(options: ReportBrowserErrorOptions): Promise<void>;

  /**
   * Permet à l'utilisateur de refuser le défi de plateforme WebAuthn et de sélectionner une autre méthode MFA.
   * Cette action soumet `action: "pick-authenticator"` à Auth0, ce qui devrait diriger
   * l'utilisateur vers un écran de sélection de facteur MFA pour le flux de réinitialisation de mot de passe.
   *
   * @param {TryAnotherMethodOptions} [options] - Facultatif. Tout paramètre personnalisé à envoyer avec la requête.
   * @returns {Promise<void>} Une promesse qui se résout lorsque l'action 'pick-authenticator' est soumise.
   * @throws {Error} Si la soumission du formulaire échoue.
   *
   * @example
   * ```typescript
   * // En supposant que 'sdk' est une instance de ResetPasswordMfaWebAuthnPlatformChallenge
   * try {
   *   await sdk.tryAnotherMethod();
   *   // En cas de réussite, Auth0 gère la redirection vers la sélection MFA.
   * } catch (error) {
   *   console.error("Failed to switch MFA method:", error);
   * }
   * ```
   */
  tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>;
}

Propriétés

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge

Accès aux propriétés et aux données propres à l’écran « reset-password-mfa-webauthn-platform-challenge ».

tenant · TenantMembers

transaction · TransactionMembers

untrustedData · UntrustedDataMembers

user · UserMembers

Méthodes

continueWithPasskey · Promise<void>

Lance le défi de l’authentificateur de plateforme WebAuthn en appelant navigator.credentials.get() à l’aide des options de défi fournies dans screen.publicKey. En cas de réussite, soumet l’assertion d’authentification obtenue à Auth0 avec action: "default".

Une promesse qui est résolue lorsque la tentative de vérification est soumise. Une opération réussie entraîne généralement une redirection.

Lève

Lève une erreur si screen.publicKey est absent, si navigator.credentials.get() échoue (p. ex., annulation par l’utilisateur NotAllowedError), ou si l’envoi du formulaire à Auth0 échoue. Si navigator.credentials.get() échoue avec une DOMException, il est recommandé d’intercepter cette erreur et d’appeler reportBrowserError.

Example

// En supposant que 'sdk' est une instance de ResetPasswordMfaWebAuthnPlatformChallenge
try {
  await sdk.continueWithPasskey({
    rememberDevice: true // si l’utilisateur a coché la case et que sdk.screen.showRememberDevice est true
  });
  // En cas de réussite, Auth0 gère la redirection.
} catch (error) {
  console.error("Platform authenticator verification failed:", error);
  // S’il s’agit d’une erreur de l’API WebAuthn (DOMException), la signaler
  if (error instanceof DOMException && error.name && error.message) {
    await sdk.reportBrowserError({ error: { name: error.name, message: error.message } });
  }
  // Vérifiez sdk.transaction.errors pour les messages de validation côté serveur si la page se recharge.
}

Show Paramètres

options? · ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions

Paramètres facultatifs du processus de vérification, comme rememberDevice (si screen.showRememberDevice est true) et d’autres options personnalisées.

Propriétés

rememberDevice? · boolean

Facultatif. Si true et que screen.showRememberDevice est aussi true, cela indique que l’utilisateur a choisi de mémoriser le navigateur actuel, ce qui pourrait permettre d’ignorer l’AMF pendant un certain temps. Correspond au champ du formulaire rememberBrowser.

reportBrowserError · Promise<void>

Signale une erreur côté navigateur survenue durant l’appel d’API navigator.credentials.get(). Cela sert à informer Auth0 de problèmes comme l’annulation par l’utilisateur, le délai d’expiration ou du matériel non pris en charge. Soumet les détails de l’erreur avec action: "showError::{errorDetailsJsonString}".

Une promesse qui est résolue lorsque le rapport d’erreur est soumis.

Lève

Si l’envoi du formulaire échoue (p. ex., erreur réseau).

Example

// En supposant que 'sdk' est une instance de ResetPasswordMfaWebAuthnPlatformChallenge
// et que 'webAuthnError' est une DOMException provenant d’un appel échoué à navigator.credentials.get().
try {
  await sdk.reportBrowserError({
    error: { name: webAuthnError.name, message: webAuthnError.message }
  });
  // Auth0 peut afficher de nouveau la page ou rediriger selon l’erreur.
} catch (submitError) {
  console.error("Failed to report WebAuthn browser error:", submitError);
}

Show Paramètres

options · ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions

Contient l’objet error (avec name et message de la DOMException de l’API WebAuthn) ainsi que toute option personnalisée.

Propriétés

error · WebAuthnErrorDetails

L’objet d’erreur de l’API WebAuthn (navigator.credentials.get()) à signaler. Doit inclure name et message.

tryAnotherMethod · Promise<void>

Permet à l’utilisateur de renoncer au défi de plateforme WebAuthn et de choisir une autre méthode d’AMF. Cette action soumet action: "pick-authenticator" à Auth0, ce qui devrait rediriger l’utilisateur vers un écran de sélection d’un facteur d’AMF pour le flux de réinitialisation du mot de passe.

Une promesse qui se résout lorsque l’action « pick-authenticator » est soumise.

Lève

Si la soumission du formulaire échoue.

Example

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

Show Paramètres

options? · ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions

Facultatif. Tous les paramètres personnalisés à envoyer avec la requête.