Rules 内から Management API を使用する

Rules と Hooks のサポート終了日 (EOL) は 2026 年 11 月 18 日 です。また、2023 年 10 月 16 日 以降に作成された新しいテナントでは、これらはすでに利用できません。アクティブな Hooks を使用している既存のテナントは、サポート終了日まで Hooks へのアクセスを維持できます。Auth0 を拡張するには、Actions の利用を強くお勧めします。Actions では、豊富な型情報、インラインドキュメント、公開 npm パッケージを利用できるほか、拡張性をさらに高める外部連携も可能です。Actions の詳細については、Understand How Auth0 Actions Work をご覧ください。移行を支援するために、Rules から Actions への移行および Hooks から Actions への移行のガイドを用意しています。さらに、機能比較、Actions デモ、その他移行に役立つリソースをまとめた専用ページ Move to Actions もご用意しています。Rules と Hooks の非推奨化について詳しくは、ブログ記事 Preparing for Rules and Hooks End of Life をご覧ください。

作成した Auth0 Rule の中では、auth0 オブジェクトを使用してユーザーの app_metadata または user_metadata を更新できます。これは ManagementClient の特別に制限されたインスタンス (node-auth0 Node.js クライアントライブラリで定義) であり、Auth0 Management API への限定的なアクセスを提供します。 Rules 内から追加のエンドポイントにアクセスするには、別のバージョンのライブラリを使用する必要があります。

auth0.accessToken で利用できる Management API のアクセストークンは、read:users と update:users のスコープに制限されています。より広い範囲のスコープが必要な場合は、クライアント認証情報フローを使用してトークンをリクエストできます。詳しくは、Get Management API Access Tokens for Production をご覧ください。

ライブラリの新しいバージョンを利用する

Auth0 Node.js クライアントライブラリの新しいバージョンは、利用したいバージョンを指定して読み込めます。最新のバージョン情報については、GitHub の Auth0 Node repository を確認してください。この例では、ライブラリのバージョン 2.9.1 を読み込み、その後ユーザーの一覧を取得して、ユーザーをコンソールに出力します (Actions Real-time Logs で確認できます) 。

Rules 内からユーザーを検索すると、ログインのパフォーマンスに影響する可能性があるため、推奨されません。

function (user, context, callback) {
  var ManagementClient = require('auth0@2.9.1').ManagementClient;
  var management = new ManagementClient({
    token: auth0.accessToken,
    domain: auth0.domain
  });

  management.getUsers(function (err, users) {
    console.log(users);
    callback(null, user, context);
  });
}

必須として設定できるライブラリを絞り込んだ一覧は、利用可能なライブラリのバージョンで確認してください。

ブランドのカスタマイズ

コードのカスタマイズ

サードパーティーのカスタマイズ

Rules 内から Management API を使用する

ライブラリの新しいバージョンを利用する

​ライブラリの新しいバージョンを利用する

ライブラリの新しいバージョンを利用する