メインコンテンツへスキップ
ルールはJanuary 31, 2028に提供終了 (EOL) となります。
  • October 16, 2023以降、新規作成されたテナントではルールを利用できません。
  • November 18, 2024以降、ルールは読み取り専用になります。有効なルールは引き続き実行され、有効化・無効化や、設定値およびシークレットの変更も可能です。ただし、ダッシュボード、Management API、およびこれを使用するツール (Auth0 CLI、Deploy CLI、Terraform、Agent Skillsなど) でコードを編集することはできません。
  • January 31, 2028を過ぎると、ルールは実行されなくなり、削除されます。
Auth0の拡張にはアクションをご利用ください:
特定の機能要件に対応するために、独自のルールを作成できます。既存のルール テンプレートを変更することも、用意されているサンプルの 1 つを使ってゼロから始めることもできます。Auth0 では、目的の達成に役立つよう、多数の既存ルールやルール テンプレートを提供しています。一覧については、GitHub 上の rules リポジトリ をご覧ください。

ルールの仕組み

ルールは、ユーザーがアプリケーションに認証するときに実行される JavaScript 関数です。認証プロセスが完了すると実行され、Auth0 の機能をカスタマイズしたり拡張したりするために利用できます。セキュリティ上の理由から、ルールのコードはサンドボックス内で、他の Auth0 テナントのコードから隔離された状態で実行されます。ルールはトークンのリフレッシュフロー中にも実行されます。詳しくは、Refresh Tokens を参照してください。 Auth0 でルールを使用する場合、認証トランザクションのフローは次のようになります。
認証フローにおけるルールの図
  1. アプリが Auth0 に認証リクエストを送信します。
  2. Auth0 は、設定された接続を通じてそのリクエストを ID プロバイダーにルーティングします。
  3. ユーザーが正常に認証されます。
  4. ID トークンおよび/またはアクセストークンはルールのパイプラインを通過した後、アプリケーションに送信されます。

前提条件

ルールでグローバル変数を使用する場合は、事前にルール変数を設定してください。詳しくは、ルールのグローバル変数を設定するをご覧ください。

Dashboard を使う

  1. Dashboard > Auth Pipeline > Rules に移動し、Create をクリックします。
    Dashboard - Auth Pipeline - Rules
  2. ルールのテンプレートを選択します。
    Dashboard - Auth Pipeline - Rules - Template
  3. ルールに名前を付け、必要に応じてスクリプトを編集して、Save changes をクリックします。
    Dashboard - Auth Pipeline - Rules - Edit Rule

Management API を使用する

Create Rule エンドポイント に POST リクエストを送信します。MGMT_API_ACCESS_TOKEN、RULE_NAME、RULE_SCRIPT、RULE_ORDER、RULE_ENABLED のプレースホルダー値は、それぞれご自身の 、ルール名、ルールスクリプト、ルールの順序番号、ルールの有効化設定の値に必ず置き換えてください。
Auth0 CLI を使用していますか?まだセットアップしていない場合は、このコマンドを実行する前に CLI セッションをセットアップして認証してください。
公開エンドポイント (例: travel0.us.auth0.com) では IPv6 アドレスを公開しています。IPv6 をサポートするマシンからリクエストが送信されると、context.request.ip プロパティには IPv6 アドレスが含まれます。IP アドレスを手動で処理する場合は、ipaddr.js@1.9.0 library を使用することをお勧めします。

レート制限の管理

Auth0 API を呼び出すルールでは、X-RateLimit-Remaining ヘッダーを確認し、返された値が 0 に近づいたら適切に対応することで、常にレート制限に対処するようにしてください。また、定められたレート制限を超過して HTTP ステータスコード 429 (Too Many Requests) を受け取った場合に備えたロジックも追加する必要があります。この場合、再試行が必要であれば、無限に再試行を繰り返す事態を避けるため、バックオフを設けるのが最善です。レート制限の詳細については、Rate Limit Policy For Auth0 APIs を参照してください。

利用可能なモジュール

ルールは、特定の Node.js バージョン向けに構成された JavaScript サンドボックス内で実行されます。 このサンドボックスは、設定された Node.js バージョンで利用可能なすべての JavaScript 言語機能 (および関連する構文) と、多数の Node.js モジュールをサポートしています。サポートされているサンドボックスモジュールの一覧は、Can I require: Auth0 Extensibility をご覧ください。

詳細はこちら