Auth0 Rules
If you want to extend Auth0, we highly recommend you use Actions, which are a cornerstone of our overall extensibility product. With Actions, you have access to rich type information, inline documentation, and public npm packages, and can connect external integrations that enhance your overall extensibility experience. To learn more about what Actions offer, read Understand How Auth0 Actions Work.
Rules can be used in a variety of situations as part of the authentication pipeline where protocol-specific artifacts are generated:
an ID token in OpenID Connect (OIDC)
an access token in OAuth 2.0
an assertion in SAML
A new pipeline in which rules execute is created for each authentication request.
| Read... | To learn... |
|---|---|
| Rule Use Cases | About different rule uses cases. |
| Create Rules | How to create rules using the Auth Dashboard or the Management API. |
| Store Rule Configurations | How to use the global configuration object in rules for storing commonly used values. |
| Cache Expensive Resources in Rules | How to use the global object to reuse resources stored there instead of creating them every time you run a rule. |
| Debug Rules | How to debug rules. |
| Use the Management API from Within Rules | How to access the Auth0 Management API endpoints from within rules. |
| Redirect Users from Within Rules | How to use rules to redirect users before an authentication transaction is complete. |
| User Object Properties in Rules | About the user object and how it stores information logged in users returned by the identity provider. |
| Context Object Properties in Rules | About the context object and how it stores contextual information about the current authentication transactions. |
| Raise Errors from Rules | How to display an error message to users from within rules. |