パートナーのActions統合

パートナーはActions統合を使用して、製品をAuth0ワークフローに紐づけるゼロコードソリューションを構築します。Actions統合を使用すると、Auth0のお客様は、ID確認や同意管理などのソリューションをコードを記述せずに実装することができます。Actions統合を書いておけば、お客様はそれをドラッグしてワークフローにドロップするだけです。

Actions統合は自己完結型の機能で、Auth0プラットフォームの選択した時点で実行されます。JavaScriptで書かれており、クローズドソースであるため、コードに変更を加えることはできません。

Actions統合を作成および公開する

Actions統合を作成するには、計画、構築、およびテストを実施しなければなりません。Auth0マーケットプレイスでお客様にお届けする前に、Auth0では、Actions統合を確認します。Auth0 Marketplaceの詳細については、「Marketplaceパートナー」をお読みください。

1.ユースケースを決定する

Actions統合が対処するユースケースを特定します。お客様のどの問題を解決しますか?問題をどのように解決しますか?詳細については、「統合のユースケースの定義」をお読みください。

2.フローを選択する

Action統合は1つのAction(アクション)から成り立っています。Actionを使ってできることは、それがAuth0ランタイム環境内のどこで実行されるか、そのActionのフローによって決まります。使用できるActionフローは以下のとおりです。

  • ログインフローは、ユーザーが正常にサインアップまたはログインした後に、同期的に実行されます。ログインイベントには、インタラクティブなフロー(ユーザー名/パスワードやフェデレーテッドログインなど)と非インタラクティブなフロー(セッションチェックやフレッシュトークンの交換など)が含まれます。このフローの詳細については、「ログインフロー」をお読みください。

  • マシンツーマシンフローは、アプリケーションがクライアント資格情報の付与を使用してアクセストークンを要求するときに、同期的に実行されます。このフローの詳細については、「マシンツーマシンフロー」をお読みください。

  • ユーザー登録前のフローは、Auth0がユーザーをデータベースまたはパスワードレス接続に追加する前に、同期的に実行されます。このフローは、エンタープライズやソーシャル接続のようなフェデレーテッドログインに対しては実行されません。このフローの詳細については、「ユーザー登録前のフロー」をお読みください。

  • ユーザー登録後のフローは、Auth0がユーザーをデータベースまたはパスワードレス接続に追加した前に、非同期的に実行されます。このフローは、エンタープライズやソーシャル接続のようなフェデレーテッドログインに対しては実行されません。このフローの詳細については、「ユーザー登録後のフロー」をお読みください。

  • パスワード変更後のフローは、顧客がデータベース接続ユーザーのパスワードを変更した後で、非同期的に実行されます。このフローは、他のタイプの接続でパスワード変更を行う場合は実行されません。このフローの詳細については、「パスワード変更後のフロー」をお読みください。

  • 電話メッセージの送信フローは、電話またはSMSメッセージをカスタムMFAプロバイダーの一部として届けます。カスタムMFAプロバイダーの詳細については、「多要素認証SMSと音声メッセージをカスタマイズする」をお読みください。このフローの詳細については、「電話メッセージの送信フロー」をお読みください。

アクションフローの詳細については、「フローとトリガーを探索する」をお読みください。ログイン中にユーザーをエンドポイントにリダイレクトする必要がある場合は、「パートナーのアクションをリダイレクトする」をお読みください。

3.Actions統合を構築する

Action統合のユースケースに合ったフローを決定したら、テスト用テナントでActionを構築します。指示については、「最初のアクションを書く」をお読みください。このアクションは、Action統合コードの基盤となります。さらに、様々なActionコード例(ユースケース別)と使用するテンプレートも多数揃っています。

Actions統合を安全かつ安定したものにするには、「Actionsコーディングのガイドライン」をお読みください。Actions統合に固有のこれらのガイドラインにも従ってください。

Auth0のレビューアーはユーザーのサービスにアクセスできないため、レビューに渡す前にアクションをテストしなければなりません。正常系とエッジケースの両方を手動でテストします。以下の項目をチェックしてください。

  • Actionをテストテナントで構築する場合には、顧客が指定する必要があるすべての値(識別子やテナント名、しきい値など)のシークレットを使用します。Actions統合を提出する場合、Auth0は、停止時に暗号化(シークレットの維持)が必要なフィールドと、編集可能なテキストフィールドを尋ねてきます。

  • デバッグ/テストモードの構成フラグをログインに使用すると、セットアップやトラブルシューティングに役立ちます。Actions統合がすべての実行に対してログを出力することはめったにありません。

  • シークレットの名前をALL_CAPS_SNAKE_CASEに書くと、確認作業が簡単になります。

  • Actions統合はクローズドソースであるため、顧客はコードを閲覧することも、変更を加えることもできません。Action統合の制御に必要な顧客固有の入力は、シークレットまたは構成から取得する必要があります。

4.Actions統合をテストする

提出手続きの間、Auth0は成功パスを使用するために、ユニットテストのカバー範囲を尋ねてきます。Auth0には、これをできる限り簡単に行うために必要な、あらゆるツールと例が用意されています。

  • Actionはユーザーが知らぬ間に失敗するのか、それとも次の実行をブロックするのか?

  • HTTP要求が失敗すると、Actionはどのように動作するのか?

  • ユーザーにどのようなエラーメッセージが表示されるのか?

  • どの情報が記録されるのか?

  • Actionはバイパスされるのか、それともスプーフィングされる可能性があるのか?

Actions統合を書いて綿密にテストしたら、Auth0でレビューに回し、Auth0 Marketplaceのサービスリクエストを提出します。リクエストの初回レビューが済んだら、Auth0からGitHubリポジトリへのリンクが送られてきます。このリンクには、Actions統合を文書化、テスト、および提出する方法が記載されています。

5.Actions統合を提出する

Auth0でActions統合を確認した後、リスティングのプレビューが届きます。Auth0 Marketplaceで、それをいつ公開するか確かめます。オンラインにアップされると、公開されたActions統合へのURLが送られてきます。Actions統合をプロモートすると、リンクを顧客ならびに潜在顧客と共有することができます。

6.Actions統合を公開する

Auth0がアクション統合の審査を完了すると、統合が審査と公開タイムラインに合格したかを通知します。