Use the Management API from within Rules

Rules will reach end of life (EOL) on January 31, 2028.

As of October 16, 2023, Rules are no longer available in newly created tenants.
As of November 18, 2024, Rules are read-only. Active Rules still run, and you can enable or disable them and change their configuration values and secrets. You can’t edit their code in the Dashboard, the Management API, or tools that use it, such as the Auth0 CLI, Deploy CLI, Terraform, and Agent Skills.
After January 31, 2028, Rules stop running and are removed.

Use Actions to extend Auth0:

To learn more about Actions, read Understand How Auth0 Actions Work.
To migrate, read Migrate from Rules to Actions.

From within any Auth0 Rule you write, you can update a user’s app_metadata or user_metadata using the auth0 object, which is a specially-restricted instance of ManagementClient (defined in the node-auth0 Node.js client library) and provides limited access to the Auth0 Management API. To access additional endpoints from inside Rules, you have to use another version of the library.

The Access Token for the Management API, which is available through auth0.accessToken, is limited to the read:users and update:users scopes. If you require a broader range of scopes, you can request a token using the Client Credentials Flow. See Get Management API Access Tokens for Production.

Access a newer version of the library

You can load a newer version of the Auth0 Node.js client library by requiring the specific version of the library. For up-to-date version information, check the Auth0 Node repository in Github. In this example, we load version 2.9.1 of the library, then query the list of users and logs the users to the console (to be inspected with Actions Real-time Logs).

Searching for users from inside Rules may affect the performance of your logins; we advise against it.

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);
  });
}

For a filtered list of available libraries that can be set as required, check the available library versions.

​Access a newer version of the library

Access a newer version of the library