Generator-auth0-rules NPM

generator-auth0-rules

Yeoman generator to create and deploy auth0 rules

Installation

First, install Yeoman and generator-auth0-rules using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-auth0-rules

Then generate your new project:

yo auth0-rules

And finally generate additional auth0 rules:

yo auth0-rules:rule

How to determine order of my rules?

There will be a rules.meta.js file that is created and will maintain a list of all of your rule files. The order that these rules are set in this list will determine what order your rule shoes up in your auth0 rule list. You can also set the enabled flag to determine if a rule is active or not.

How to deploy rules with Travis CI

When you generate a project using this scaffold you will be given a deploy.js script at the root of your project that will be called from your travis.yml. So when you create the project and add rules via the command above they will be packaged and deployed to your auth0 account using the deploy script running in your Travis CI account.

Obviously, you do not want your auth0 credentials in your repo so this project assumes that you have them set as secret environment files on your Travis CI project. The following keys will need to be set in your Travis CI project settings.

CLIENT_ID
CLIENT_SECRET
DOMAIN

You can find your CLIENT_ID and CLIENT_SECRET in your auth0 account if you go to Application > API Explorer > Settings

Auth0 Credentials

The API Explorer machine to machine application in auth0 comes with each account by default. If you have removed this account for some reason or would you like to use a different account you may do so by creating a new machine to machine application and granting the following permissions.

read:rules
update:rules
create:rules