Skip to main content
パートナーの皆様は、Actions 連携 を使用して、自社製品を Auth0 のワークフローに組み込むゼロコードソリューションを構築できます。Actions 連携 を使うと、Auth0 の顧客はコードを一切書かずに、本人確認や同意管理などのソリューションを実装できます。Actions 連携 を作成するのはパートナーである皆様で、顧客はそれを自分のワークフローにドラッグ＆ドロップして利用します。 Actions 連携 は、Auth0 プラットフォーム内の指定したポイントで実行される自己完結型の関数です。JavaScript で記述されており、ソースコードは非公開のため、顧客がコードを変更することはできません。

​
Actions連携を作成して公開する

Actions連携の作成では、計画、構築、テストを行います。Auth0 Marketplace でお客様に提供する前に、Auth0 による Actions連携の審査が行われます。Auth0 Marketplace については、Marketplace Partners を参照してください。

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

Actions 連携でどのようなユースケースに対応するのかを明確にします。顧客のどのような課題を解決するのでしょうか。どのようにその課題を解決するのでしょうか。詳しくは、連携のユースケースを定義するをお読みください。

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

Action 連携は、1 つの Action で構成されます。Action で実行できることは、Auth0 のランタイム環境内のどこで実行されるか、つまり Action の フロー によって決まります。利用可能な Action フローは次のとおりです。
  • ログインフロー は、ユーザーがサインアップまたはログインに成功した後、同期的に実行されます。ログインイベントには、インタラクティブなフロー (ユーザー名/パスワードやフェデレーテッドログインなど) と、非インタラクティブなフロー (セッションチェックや の交換など) が含まれます。このフローの詳細については、Login Flow を参照してください。
  • Machine to Machine フロー は、アプリケーションが client credentials grant を使用して を要求したときに、同期的に実行されます。このフローの詳細については、Machine to Machine Flow を参照してください。
  • Pre User Registration フロー は、Auth0 がユーザーをデータベースまたは 接続に追加する前に、同期的に実行されます。このフローは、enterprise 接続やソーシャル接続などのフェデレーテッドログインでは実行されません。このフローの詳細については、Pre User Registration Flow を参照してください。
  • Post User Registration フロー は、Auth0 がユーザーをデータベースまたはパスワードレス接続に追加した後に、非同期で実行されます。このフローは、enterprise 接続やソーシャル接続などのフェデレーテッドログインでは実行されません。このフローの詳細については、Post User Registration Flow を参照してください。
  • Post Change Password フロー は、データベース接続のユーザーがパスワードを変更した後に、非同期で実行されます。このフローは、他の種類の接続でのパスワード変更では実行されません。このフローの詳細については、Post Change Password Flow を参照してください。
  • Send Phone Message フロー は、カスタム プロバイダーの一部として、電話または 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 連携を構築する

Action 連携のユースケースに適したフローを決めたら、テスト用テナントで Action を作成します。手順については、Write Your First Actionを参照してください。この Action が、Action 連携コードのベースになります。 また、連携の構築に役立つ Action 連携テンプレートも利用できます。 Actions 連携を安全かつ安定して実装する方法については、Actions Coding Guidelinesを参照してください。あわせて、Actions 連携に固有の以下のガイドラインにも従ってください。
  • テスト用テナントで Action を作成する際は、顧客が指定する必要のあるすべての値 (識別子、テナント名、しきい値など) に secrets を使用してください。Actions 連携を提出すると、Auth0 は、どのフィールドを保存時に暗号化する必要があるか (secrets のままにするか) 、どのフィールドを編集可能なテキストフィールドにできるかを確認します。
  • 設定やトラブルシューティングに役立つよう、ログ出力用のデバッグ / テストモード設定フラグを使用してください。Actions 連携で、すべての実行についてログを出力することはまれであるべきです。
  • レビューしやすいように、secret 名は ALL_CAPS_SNAKE_CASE で記述してください。
  • Action 連携はクローズドソースであり、顧客はコードを閲覧したり変更したりできません。Action 連携を制御するために必要な顧客固有の入力は、secrets または設定から取得する必要があります。

​
Step 4. Actions 連携をテストする

Auth0 のレビュアーはお客様のサービスにアクセスできないため、レビューに提出する前に Action をテストする必要があります。成功する実行パターンとエッジケースの両方を手動でテストしてください。次の点を確認します。
  • Action はサイレントに失敗したり、後続の実行を妨げたりしませんか？
  • HTTP リクエストが失敗した場合、Action はどのように動作しますか？
  • ユーザーに表示されるエラーメッセージはありますか？ ある場合はどのような内容ですか？
  • どのような情報がログに記録されますか？
  • Action は回避されたり、なりすまされたりする可能性がありますか？
提出プロセスでは、Auth0 は正常系に対するユニットテストカバレッジを求めます。Auth0 では、これをできるだけ簡単に行えるよう、必要なツールとサンプルをすべて提供しています。

​
ステップ 5. Actions 連携を申請する

Actions 連携の作成と十分なテストが完了したら、Auth0 にレビューを依頼するため、Auth0 Marketplace のサービスリクエストを送信してください。初回レビューを通過すると、その連携はセキュリティ準拠の審査に進みます。

​
ステップ 6. Actions 連携を公開する

Auth0 による Actions 連携の審査が完了すると、審査の結果と公開時期についてお知らせします。