ユースケース例：パスワードレス認証でのActions

Actions を使用してパスワードレス認証フローをカスタマイズし、SMS やメール OTP をカスタムプロバイダー経由で送信する方法を説明します。

Actions を使用すると、SMS やメール OTP の配信をカスタムプロバイダー経由で行うことで、パスワードレス接続を拡張できます。Auth0 Actions を使用すると、認証メッセージの送信に使用する電話・メールサービスを制御できます。

​

カスタムメールプロバイダーを使用してパスワードレスメールを送信する

ユーザーがパスワードレスメール接続で認証すると、Auth0 は OTP を配信するために custom-email-provider Action をトリガーします。この Action を使用すると、任意のメールサービス経由でメッセージを送信できます。

Action を設定するには、Branding > Email Providerに移動し、Use my own email provider をオンにしてから、Custom Provider オプションを選択します。カスタムプロバイダーのデフォルトの送信元アドレスを From フィールドに追加します。詳細については、カスタマイズした Action でメールプロバイダーを設定するを参照してください。

Actions Editor で、次の例を使用します。

メールプロバイダーのサービスエンドポイントを Actions コードに追加し、API キーを Actions Editor の Secrets タブに追加する必要があります。

/**
 * Auth0 がパスワードレスのメール OTP を送信する際に呼び出されるハンドラー。
 * @param {Event} event - 通知の詳細。
 * @param {CustomEmailProviderAPI} api - 通知の動作を制御するメソッド。
 */
exports.onExecuteCustomEmailProvider = async (event, api) => {
  try {
    const response = await fetch('https://api.example.com/send-email', {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${event.secrets.API_KEY}`,
        'Content-Type': 'application/json',
      },
      body: JSON.stringify({
        to: event.notification.to,
        from: event.notification.from,
        subject: event.notification.subject,
        html: event.notification.html,
        text: event.notification.text,
      }),
    });

    if (response.status >= 400) {
      api.notification.retry(`Request failed with status: ${response.status}`);
      return;
    }
  } catch (error) {
    api.notification.drop(`Unexpected error: ${error.message}`);
  }
};

設定をテストするには、Send Test Email を選択します。

利用可能なイベントプロパティについて詳しくは、Actions Triggers: custom-email-provider - イベントオブジェクトを参照してください。

​

カスタム電話プロバイダーでパスワードレス SMS を送信する

ユーザーがパスワードレス SMS 接続を使用して認証を行うと、Auth0 は OTP を配信するために custom-phone-provider Action をトリガーします。この Action を使用すると、任意の SMS プロバイダー経由でメッセージを送信できます。

Action を設定するには、Branding > Phone Providerに移動します。Phone Message Provider をオンにして、Custom オプションを選択します。配信方法として Text、Voice、または両方を選択します。詳細については、カスタム電話プロバイダーを設定するを参照してください。

Actions Editor で、次の例を使用します。

電話プロバイダーのサービスエンドポイントを Actions コードに追加し、API キーを Actions Editor の Secrets タブに追加する必要があります。

/**
 * Auth0がパスワードレスSMSのOTPを配信する必要があるときに呼び出されるハンドラー。
 * @param {Event} event - 通知に関する詳細。
 * @param {CustomPhoneProviderAPI} api - 通知の動作を制御するためのメソッド。
 */
exports.onExecuteCustomPhoneProvider = async (event, api) => {
  const response = await fetch('https://api.example.com/messages', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${event.secrets.API_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      to: event.notification.recipient,
      from: event.notification.from,
      body: event.notification.as_text,
    }),
  });

  if (response.status >= 400) {
    api.notification.retry(`リクエストが次のステータスで失敗しました: ${response.status}`);
  }
};

設定をテストするには、Send Text Message を選択します。

利用可能なイベントプロパティについて詳しくは、Actions Triggers: custom-phone-provider - イベントオブジェクトを参照してください。

​

詳細情報

• カスタマイズしたActionでメールプロバイダーを設定する
• カスタム電話プロバイダーを設定する
• Twilio Verifyを使用してカスタム電話プロバイダーを設定する
• パスワードレス接続用のカスタムSMSゲートウェイを設定する
• パスワードレスにUnified Phone Experienceを使用する
• パスワードレス接続のベストプラクティス