パートナー向け Actions Integrations

Auth0 のビジネスパートナーが、サードパーティ製品を Auth0 のワークフローに組み込むゼロコードソリューションを作成するための手順

このようなパートナーは、Actions Integrations を使用して、自社製品を Auth0 のワークフローに組み込むゼロコードソリューションを構築します。Actions Integrations を使用すると、Auth0 の顧客はコードをまったく書かずに、本人確認や同意管理などのソリューションを実装できます。パートナーが Actions Integration を作成し、顧客はそれをワークフローにドラッグ＆ドロップします。

Actions Integrations は、Auth0 プラットフォーム内の指定したポイントで実行される自己完結型の関数です。JavaScript で記述されるクローズドソースのため、顧客はそのコードを変更できません。

​

Actions Integration を作成して公開する

Actions Integration の作成では、計画、構築、テストを行います。Auth0 Marketplace で顧客が利用できるようにする前に、Auth0 による Actions Integration の審査が行われます。Auth0 Marketplace の詳細については、Marketplace Partners を参照してください。

​

ステップ 1. ユースケースを明確にする

Actions Integration で対応するユースケースを明確にします。顧客のどのような課題を解決するのか。どのようにその課題を解決するのか。詳しくは、Defining an Integration Use Caseを参照してください。

​

ステップ 2. フローを選択する

Action Integration は、1 つの Action で構成されます。Action で実行できることは、Auth0 ランタイム環境内のどこで実行されるか、つまり Action の フロー によって決まります。利用可能な Action フローは次のとおりです。

• Login flow は、ユーザーが正常にサインアップまたはログインした後に同期的に実行されます。ログインイベントには、インタラクティブなフロー (username/password やフェデレーテッドログインなど) と、非インタラクティブなフロー (セッションチェックや リフレッシュトークン の交換など) が含まれます。このフローの詳細については、Login Flow を参照してください。
• Machine to Machine flow は、アプリケーションがクライアントクレデンシャルグラントを使用して アクセストークン を要求するときに同期的に実行されます。このフローの詳細については、Machine to Machine Flow を参照してください。
• Pre User Registration flow は、Auth0 がユーザーをデータベースまたは パスワードレス 接続に追加する前に同期的に実行されます。このフローは、エンタープライズ接続やソーシャル接続などのフェデレーテッドログインでは実行されません。このフローの詳細については、Pre User Registration Flow を参照してください。
• Post User Registration flow は、Auth0 がユーザーをデータベースまたはパスワードレス接続に追加した後に非同期で実行されます。このフローは、エンタープライズ接続やソーシャル接続などのフェデレーテッドログインでは実行されません。このフローの詳細については、Post User Registration Flow を参照してください。
• Post Change Password flow は、データベース接続のユーザーのパスワードが変更された後に非同期で実行されます。このフローは、他の種類の接続でのパスワード変更では実行されません。このフローの詳細については、Post Change Password Flow を参照してください。
• Send Phone Message flow は、カスタム MFA プロバイダーの一部として、音声通話または SMS メッセージを送信します。カスタム MFA プロバイダーの詳細については、Customize Multi-factor Authentication SMS and Voice Messages を参照してください。このフローの詳細については、Send Phone Message Flow を参照してください。

Action フローの詳細については、Explore Flows and Triggers を参照してください。ログイン中にユーザーをエンドポイントにリダイレクトする必要がある場合は、Redirect Actions for Partners を参照してください。

​

ステップ 3. Actions Integration を構築する

Action Integration のユースケースに適したフローを決めたら、テスト用テナントで Action を作成します。手順については、初めての Action を作成するを参照してください。この Action は、Action Integration コードのベースになります。

また、統合の構築には、以下の Action Integration テンプレートを利用できます。

• Post Login Action Integration Template
• Machine-to-Machine Action Integration Template
• Pre User Registration Action Integration Template
• Post User Registration Action Integration Template
• Post Change Password Action Integration Template
• Send Phone Message Action Integration Template

Actions Integration を安全かつ安定して動作させる方法については、Actions Coding Guidelinesを参照してください。あわせて、Actions Integration 固有の次のガイドラインにも従ってください。

• テスト用テナントで Action を作成する際は、顧客が指定する必要のあるすべての値 (識別子、テナント名、しきい値など) に secrets を使用します。Actions Integration を送信すると、Auth0 はどのフィールドを保存時に暗号化する必要があるか (secrets のままにするか) 、またどのフィールドを編集可能なテキストフィールドにできるかを確認します。
• セットアップやトラブルシューティングに役立つログ出力には、デバッグ/テストモードの設定フラグを使用します。Actions Integration では、すべての実行でログを出力することはまれです。
• レビューしやすいように、secret 名は ALL_CAPS_SNAKE_CASE で記述します。
• Actions Integration はクローズドソースです。顧客はコードを閲覧することも変更することもできません。Action Integration の制御に必要な顧客固有の入力は、secrets または設定から取得する必要があります。

​

ステップ 4. Actions Integration をテストする

Auth0 のレビュアーはお客様のサービスにアクセスできないため、レビューに提出する前に Action をテストする必要があります。正常に実行されるケースとエッジケースの両方を手動でテストしてください。次の項目を確認します。

• Action は何の通知もなく失敗しますか、それとも以降の実行をブロックしますか？
• HTTP リクエストが失敗した場合、Action はどのように動作しますか？
• ユーザーに表示されるエラーメッセージはありますか？ある場合、どのような内容ですか？
• どのような情報がログに記録されますか？
• Action は回避されたり、なりすまされたりする可能性がありますか？

提出プロセスでは、Auth0 は成功パスに対する単体テストのカバレッジを求めます。Auth0 では、これをできるだけ簡単に行えるよう、必要なツールと例をすべて提供しています。

​

ステップ 5. Actions Integration を提出する

Actions Integration の作成と十分なテストが完了したら、Auth0 のレビューに提出します。Auth0 Marketplace のサービスリクエストを送信してください。初回レビューを通過すると、次にセキュリティ準拠の審査が行われます。

​

ステップ 6. Actions Integration を公開する

Auth0 による Actions Integration の審査が完了したら、審査結果と公開予定時期をお知らせします。