auth0/rules

Rules are code snippets written in JavaScript that are executed as part of the authentication pipeline in Auth0

Auth0 Rule Templates

This repo contains Rule templates that appear in the Auth0 Dashboard when you create a new Rule.

Table of Contents

• Documentation
• Contributing
• Support + Feedback
• Vulnerability Reporting
• What is Auth0
• License

Documentation

• Rule basics
• Rule best practices
• Using Rule configuration for secrets and other values
• Working with metadata in Rules
• The user object and context object
• Redirect users from witihin Rules
• Debugging Rules
• NPM modules available in all Rules
• Rules utility library

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

• Auth0's general contribution guidelines
• Auth0's code of conduct guidelines

If you're considering developing a new Rule template, please submit an Issue to discuss with our team. If you'd like to write an integration for the Auth0 Marketplace, please see our Partners page to get started.

0. Read the Contributing guidelines above
1. Make your changes in src/rules by changing an existing template or by adding a new file for a new template
2. If you're adding a new Rule, include the following metadata at the top:

• @title 3-5 word title of the rule
• @overview brief, one-sentence description of the rule.
• @gallery set to true
• @category use "access control", "enrich profile", "multifactor", "guardian", "debugging", "saml", or "default"
• A detailed, multi-line, Markdown-enabled description of the rule, including any required configuration keys

3. Ensure tests run in both Node v8 and Node v12 using a tool like nvm
4. Make sure to test your Rule in Auth0 directly to make sure it can be saved without errors and that it does what you expect during login
5. Submit your PR following the "fork and pull" workflow described here
6. Fill out the PR template completely and our team will review as soon as we're able

Support + Feedback

• Use the Support Center for questions on implementation and issues with a Rule installed in your tenant
• Use Issues here for code-level support and bug reports within the templates

Vulnerability Reporting

Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

What is Auth0?

Auth0 helps you to easily:

• implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.)
• log in users with username/password databases, passwordless, or multi-factor authentication
• link multiple user accounts together
• generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely
• access demographics and analytics detailing how, when, and where users are logging in
• enrich user profiles from other data sources using customizable JavaScript rules

Why Auth0?

License

These Rule templates are licensed under MIT - LICENSE