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.
context object stores contextual information about the current authentication transaction, such as the user’s IP address, application, or location.
If you change token content using the context object within a rule, your changes will be available in tokens after all rules have finished running. If your application also requires or user consent, the user will be prompted before changes in the token are available.
Properties
The following properties are available for thecontext object.
| Property | Description |
|---|---|
context.tenant | A string containing the name of the tenant. |
context.clientID | The client id of the application the user is logging in to. |
context.clientName | The name of the application (as defined on the dashboard). |
context.clientMetadata | An object for holding other application properties. Its keys and values are strings. |
context.connectionID | A string containing the connection’s unique identifier. |
context.connection | The name of the connection used to authenticate the user (such as: twitter or some-g-suite-domain) |
context.connectionStrategy | The type of connection. For social connection connectionStrategy === connection. For enterprise connections, the strategy will be waad (Windows Azure AD), ad (Active Directory/LDAP), auth0 (database connections), and so on. |
context.connectionOptions | An object representing the options defined on the connection. connectionOptions.tenant_domain is a string containing the domain being used for authentication when using an Enterprise connection.connectionOptions.domain_aliases is an array containing the optional domains registered as aliases in addition to the primary domain (specified in the connectionOptions.tenant_domain property). |
context.connectionMetadata | An object representing metadata defined on the connection. Its keys and values are strings. |
context.samlConfiguration | An object that controls the behavior of the SAML and WS-Fed endpoints. Useful for advanced claims mapping and token enrichment (only available for samlp and wsfed protocol). |
context.protocol | The authentication protocol. Possible values:
|
context.riskAssessment | An object containing specific scores (low, medium, high, neutral) for high risk login attempt assessors. See Customize Adaptive MFA with Rules. |
context.stats | An object containing specific user stats, like stats.loginsCount. Note that any of the counter variables returned as part of the stats object do not increase during silent authentication (as when prompt=none). There are also scenarios where the counter variables might increase yet a rule or set of rules do not execute, as in the case of a successful cross-origin authentication followed by a failed token request. |
context.sso | This object will contain information about the Single Sign-on (SSO) transaction (if available)
|
context.accessToken | An object representing the options defined on the Access Toke. You can use this object to add custom namespaced claims to the Access Toke. context.accessToken.scope can be used to change the Access Token’s returned scopes. When provided, it is an array containing permissions in string format. Custom claims will be included in the Access Token after all rules have run. |
context.idToken | An object representing the options defined on the ID Token. Used to add custom namespaced claims to the ID Token. Custom claims will be included in the ID Token after all rules have run. |
context.multifactor | An object representing the multifactor settings used in implementing contextual MFA. |
context.redirect | The object used to implement the redirection of a user from a rule. |
context.sessionID | An internal identification for the authentication session. Value is kept only if prompt=none is used in the authorization request. Note that the session ID can change after rule execution on other flows, so the value available in context.sessionID might not match the new session ID that the user will receive. This makes this value only meaningful when prompt=none is used. |
context.request | An object containing useful information of the request. This can also be set to undefined. It has the following properties:
|
context.primaryUser | The unique user id of the primary account for the user. Used to link user accounts from various identity providers. |
context.authentication | An object containing information related to the authentication transaction with the following properties:methods: an array of objects containing the authentication methods a user has completed during their session. For example, a user that has completed a password-based authentication followed by MFA may have the following methods:json lines [ { "name": "pwd", "timestamp": 1434454643024 }, { "name": "mfa", "timestamp": 1534454643881 } ] The method objects will contain the following properties:
context.authentication.methods property in the Require MFA once per session Rule. |
context.authorization | An object containing information related to the authorization transaction with the following properties:
|
context.organization | Object containing information related to the organization. Includes the following properties:
|