ResetPasswordMfaPhoneChallengeMembers

ResetPasswordMfaPhoneChallengeMembers

Example

export interface ResetPasswordMfaPhoneChallengeMembers extends BaseMembers {
  /**
   * Access to client-specific information (e.g., client ID, name).
   * @type {ClientMembers}
   */
  client: ClientMembers;

  /**
   * Access to organization-specific information, if applicable.
   * @type {OrganizationMembers}
   */
  organization: OrganizationMembers;

  /**
   * Access to prompt details (e.g., prompt name).
   * @type {PromptMembers}
   */
  prompt: PromptMembers;

  /**
   * Access to the specific properties and data of the 'reset-password-mfa-phone-challenge' 画面.
   * @type {ScreenMembersOnResetPasswordMfaPhoneChallenge}
   */
  screen: ScreenMembersOnResetPasswordMfaPhoneChallenge;

  /**
   * Access to the current トランザクション details (e.g., state, errors).
   * @type {TransactionMembers}
   */
  transaction: TransactionMembers;

  /**
   * Sends the 確認コード to the user's phone via the specified method (SMS or Voice).
   * This action corresponds to the user clicking the "Send Code via SMS" or "Send Code via Voice Call" button.
   * It triggers the Auth0 backend to initiate the code delivery process.
   *
   * @param {ContinueOptions} payload - The options specifying the delivery type ('sms' or 'voice') and any custom data.
   * @returns {Promise<void>} A promise that resolves when the action is successfully submitted to the server.
   * @throws {Error} Throws an error if the submission fails (e.g., network issue, invalid state).
   * @example
   * ```typescript
   * import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';
   *
   * const screen = new ResetPasswordMfaPhoneChallenge();
   *
   * // Send code via SMS
   * await screen.continue({ type: 'sms' });
   *
   * // Send code via Voice Call
   * await screen.continue({ type: 'voice' });
   * ```
   */
  continue(payload: ContinueOptions): Promise<void>;

  /**
   * 別のMFA方式を選択できる画面にユーザーを遷移させます。
   * このアクションは、ユーザーが「Try Another Method」ボタンをクリックした場合に対応します。
   *
   * @param {TryAnotherMethodOptions} payload - 現在のチャレンジの種類（`sms` または `voice`）およびカスタムデータを指定するオプション。`type` フィールドは、ユーザーがどのフローから離脱するかをバックエンドに通知するために必要です。
   * @returns {Promise<void>} アクションがサーバーに正常に送信されると解決されるPromise。
   * @throws {Error} 送信に失敗した場合にエラーをスローします。
   * @example
   * ```typescript
   * import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';
   *
   * const screen = new ResetPasswordMfaPhoneChallenge();
   *
   * // If the user was presented with SMS option initially:
   * await screen.tryAnotherMethod({ type: 'sms' });
   *
   * // If the user was presented with Voice option initially:
   * await screen.tryAnotherMethod({ type: 'voice' });
   * ```
   */
  tryAnotherMethod(payload: TryAnotherMethodOptions): Promise<void>;
}

プロパティ

branding · BrandingMembers

client · ClientMembers

クライアント固有の情報 (client ID や名前など) にアクセスできます。

organization · OrganizationMembers

該当する場合は、organization 固有の情報にアクセスできます。

prompt · PromptMembers

prompt の詳細 (prompt 名など) にアクセスできます。

screen · ScreenMembersOnResetPasswordMfaPhoneChallenge

‘reset-password-mfa-phone-challenge’ 画面に固有のプロパティやデータにアクセスできます。

tenant · TenantMembers

transaction · TransactionMembers

現在のトランザクションの詳細 (state や errors など) にアクセスできます。

untrustedData · UntrustedDataMembers

user · UserMembers

メソッド

continue · Promise<void>

指定された方法 (SMS または音声通話) で、ユーザーの電話番号に確認コードを送信します。 このアクションは、ユーザーが「Send Code via SMS」または「Send Code via Voice Call」ボタンをクリックしたときに対応します。 これにより、Auth0 backend でコード配信処理が開始されます。

アクションがサーバーに正常に送信されると完了する Promise です。

Throws

送信に失敗した場合 (例: ネットワークの問題、invalid state) にエラーをスローします。

Example

import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';

const screen = new ResetPasswordMfaPhoneChallenge();

// SMS でコードを送信
await screen.continue({ type: 'sms' });

// 音声通話でコードを送信
await screen.continue({ type: 'voice' });

Show Parameters

payload · ResetPasswordMfaPhoneChallengeContinueOptions

配信方法 (sms または voice) と任意のカスタムデータを指定するオプションです。

プロパティ

type · "sms" | "voice"

ユーザーが確認コードの受信に選択した配信方法です。

• sms: テキストメッセージでコードを送信します。
• voice: 音声通話でコードを送信します。

tryAnotherMethod · Promise<void>

ユーザーを、別の MFA方式 を選択できる画面に移動させます。 このアクションは、ユーザーが「Try Another Method」ボタンをクリックしたときに対応します。

アクションがサーバーに正常に送信されると完了する Promise です。

Throws

送信に失敗した場合にエラーをスローします。

Example

import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';

const screen = new ResetPasswordMfaPhoneChallenge();

// ユーザーに最初に SMS オプションが表示されていた場合:
await screen.tryAnotherMethod({ type: 'sms' });

// ユーザーに最初に音声通話オプションが表示されていた場合:
await screen.tryAnotherMethod({ type: 'voice' });

Show Parameters

payload · ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions

現在のチャレンジの種類 (sms または voice) と任意のカスタムデータを指定するオプションです。type フィールドは、ユーザーがどのフローから移動しようとしているかを backend に伝えるために必要です。

プロパティ

type · "sms" | "voice"

現在の画面で最初に表示された、または選択された配信方法です。 これは、pick-authenticator アクションを正しく処理するために API endpoint で必要です。

• sms: 現在の画面が SMS challenge 用であることを示します。
• voice: 現在の画面が Voice challenge 用であることを示します。