Propriétés de l’objet context dans Rules

Découvrez les propriétés de l’objet context de Rules, qui contient des renseignements sur les adresses IP des utilisateurs, les applications et leur emplacement.

La date de fin de vie (EOL) de Rules et Hooks sera le 18 novembre 2026, et ils ne sont plus offerts aux nouveaux tenants créés à compter du 16 octobre 2023. Les tenants existants avec des Hooks actifs conserveront l’accès au produit Hooks jusqu’à la fin de vie.

Nous vous recommandons fortement d’utiliser Actions pour étendre Auth0. Avec Actions, vous avez accès à des informations de typage détaillées, à de la documentation intégrée et à des packages npm publics, et vous pouvez établir des intégrations externes qui améliorent votre expérience globale d’extensibilité. Pour en savoir plus sur ce qu’offre Actions, consultez Comprendre le fonctionnement des Auth0 Actions.

Pour vous aider dans cette migration, nous proposons des guides pour vous aider à passer de Rules à Actions et à passer de Hooks à Actions. Nous avons aussi une page dédiée, Move to Actions, qui présente une comparaison des fonctionnalités, une démo d’Actions et d’autres ressources pour vous accompagner dans votre migration.

Pour en savoir plus sur la dépréciation de Rules et Hooks, consultez notre billet de blogue : Preparing for Rules and Hooks End of Life.

L’objet context stocke des renseignements contextuels sur la transaction d’authentification en cours, comme l’adresse IP de l’utilisateur, l’application ou l’emplacement.

Si vous modifiez le contenu du jeton à l’aide de l’objet context dans une Rule, vos changements seront disponibles dans les jetons une fois que toutes les Rules auront fini de s’exécuter. Si votre application exige aussi la authentification multifacteur ou le consentement de l’utilisateur, une invite sera présentée à l’utilisateur avant que les changements apportés au jeton soient disponibles.

​

Propriétés

Les propriétés suivantes sont disponibles pour l’objet context.

Propriété	Description
context.tenant	Une chaîne de caractères contenant le nom du tenant.
context.clientID	L’ID client de l’application à laquelle l’utilisateur se connecte.
context.clientName	Le nom de l’application (tel que défini dans le Dashboard).
context.clientMetadata	Un objet qui contient d’autres propriétés de l’application. Ses clés et ses valeurs sont des chaînes de caractères.
context.connectionID	Une chaîne de caractères contenant l’identifiant unique de la connexion.
context.connection	Le nom de la connexion utilisée pour authentifier l’utilisateur (par exemple : twitter ou some-g-suite-domain)
context.connectionStrategy	Le type de connexion. Pour une connexion sociale, connectionStrategy === connection. Pour les connexions d’entreprise, la stratégie sera waad (Windows Azure AD), ad (Active Directory/LDAP), auth0 (connexions de base de données), etc.
context.connectionOptions	Un objet représentant les options définies pour la connexion. connectionOptions.tenant_domain est une chaîne de caractères contenant le domaine utilisé pour l’authentification lorsqu’une connexion Enterprise est utilisée. connectionOptions.domain_aliases est un tableau contenant les domaines facultatifs enregistrés comme alias, en plus du domaine principal (indiqué dans la propriété connectionOptions.tenant_domain).
context.connectionMetadata	Un objet représentant les métadonnées définies sur la connexion. Ses clés et ses valeurs sont des chaînes de caractères.
context.samlConfiguration	Un objet qui contrôle le comportement des endpoints SAML et WS-Fed. Utile pour le mappage avancé des claims et l’enrichissement des tokens (disponible uniquement pour le protocole samlp et wsfed).
context.protocol	Le protocole d’authentification. Valeurs possibles : oidc-basic-profile : le plus utilisé, connexion Web oidc-implicit-profile : utilisé sur les appareils mobiles et les applications monopages oauth2-device-code : transaction utilisant le Device Authorization Flow oauth2-resource-owner : connexion par nom d’utilisateur et mot de passe, généralement utilisée avec les connexions de base de données oauth2-resource-owner-jwt-bearer : connexion utilisant un JWT bearer signé avec la clé privée de l’utilisateur oauth2-password : connexion utilisant l’échange de mot de passe oauth2-refresh-token : actualisation d’un token au moyen de l’échange de Refresh Token samlp : protocole SAML utilisé avec les applications SaaS wsfed : WS-Federation utilisé avec des produits Microsoft comme Office365 wstrust-usernamemixed : connexion par nom d’utilisateur et mot de passe WS-Trust utilisée avec CRM et Office365 delegation : lors de l’appel du point de terminaison Delegation redirect-callback : lorsqu’une règle de redirection reprend
context.riskAssessment	Un objet contenant des scores précis (faible, moyen, élevé, neutre) pour les évaluateurs de tentatives de connexion à risque élevé. Consultez Personnaliser Adaptive MFA avec Rules.
context.stats	Un objet contenant des statistiques utilisateur précises, comme stats.loginsCount. Notez qu’aucune des variables de compteur renvoyées dans l’objet stats n’augmente pendant l’authentification silencieuse (par exemple lorsque prompt=none). Il existe aussi des scénarios où les variables de compteur peuvent augmenter sans qu’une Rule ou un ensemble de Rules ne s’exécute, comme dans le cas d’une authentification cross-origin réussie suivie d’une demande de jeton ayant échoué.
context.sso	Cet objet contiendra des renseignements sur la transaction de Single Sign-on (SSO) (si disponible) with_auth0 : lorsqu’un utilisateur se connecte avec SSO à une application où le paramètre Use Auth0 instead of the IdP to do Single Sign-On est activé (uniquement pour les tenants Legacy). with_dbconn : une connexion SSO pour un utilisateur qui s’est connecté au moyen d’une connexion de base de données. current_clients : les ID client utilisant SSO.
context.accessToken	Un objet représentant les options définies pour le jeton d’accès. Vous pouvez utiliser cet objet pour ajouter des claims personnalisés avec espace de noms au jeton d’accès. context.accessToken.scope peut être utilisé pour modifier les scopes renvoyés par le jeton d’accès. Lorsqu’il est fourni, il s’agit d’un tableau contenant des permissions sous forme de chaînes de caractères. Les claims personnalisés seront inclus dans le jeton d’accès après l’exécution de toutes les Rules.
context.idToken	Objet représentant les options définies dans le ID Token. Sert à ajouter des revendications personnalisées avec espace de noms au ID Token. Les revendications personnalisées seront incluses dans le ID Token une fois toutes les Rules exécutées.
context.multifactor	Un objet représentant les paramètres du MFA utilisés dans la mise en œuvre du MFA contextuel.
context.redirect	L’objet utilisé pour mettre en place la redirection d’un utilisateur dans une rule.
context.sessionID	Un identifiant interne de la session d’authentification. La valeur est conservée seulement si prompt=none est utilisé dans la demande d’autorisation. Notez que l’ID de session peut changer après l’exécution de la règle dans d’autres flux, de sorte que la valeur disponible dans context.sessionID pourrait ne pas correspondre au nouvel ID de session que l’utilisateur recevra. Cette valeur n’est donc utile que lorsque prompt=none est utilisé.
context.request	Un objet contenant des renseignements utiles sur la requête. Il peut aussi être défini sur undefined. Il possède les propriétés suivantes : userAgent : l’agent utilisateur de l’application qui tente de se connecter. ip : l’adresse IP source de l’utilisateur qui tente de se connecter. Nous exposons des adresses IPv6 sur nos points de terminaison publics (par exemple, travel0.us.auth0.com). Si une requête provient d’une machine qui prend en charge IPv6, cette valeur contiendra une adresse IPv6. Si vous manipulez manuellement des adresses IP, nous vous recommandons d’utiliser la bibliothèque ipaddr.js@1.9.0. hostname : le nom d’hôte utilisé pour le flux d’authentification. query : un objet contenant les propriétés de la chaîne de requête de la transaction de connexion envoyée par l’application. body : le corps de la requête POST dans les transactions de connexion utilisées avec les protocoles oauth2-resource-owner, oauth2-resource-owner-jwt-bearer ou wstrust-usernamemixed. geoip : un objet contenant des renseignements géographiques associés à l’adresse IP. Il possède les propriétés suivantes : country_code : un code à deux caractères pour le pays associé à l’adresse IP. country_code3 : un code à trois caractères pour le pays associé à l’adresse IP. country_name : le nom du pays associé à l’adresse IP. city_name : le nom de la ville ou de la localité associée à l’adresse IP. latitude : la latitude associée à l’adresse IP. longitude : la longitude associée à l’adresse IP. time_zone : le fuseau horaire associé à l’adresse IP. continent_code : un code à deux caractères pour le continent associé à l’adresse IP. subdivision_code : le code ISO 3166-2 de la subdivision ou région de premier niveau. subdivision_name : le nom anglais de cette subdivision ou région.
context.primaryUser	L’ID utilisateur unique du compte principal de l’utilisateur. Sert à lier des comptes d’utilisateur de différents fournisseurs d’identité.
context.authentication	Un objet contenant des renseignements liés à la transaction d’authentification avec les propriétés suivantes : methods : un tableau d’objets contenant les méthodes d’authentification qu’un utilisateur a effectuées durant sa session. Par exemple, un utilisateur qui a effectué une authentification par mot de passe suivie d’une MFA peut avoir les méthodes suivantes : json lines [ { "name": "pwd", "timestamp": 1434454643024 }, { "name": "mfa", "timestamp": 1534454643881 } ] Les objets de méthode contiennent les propriétés suivantes : name : une chaîne représentant le nom de la méthode d’authentification qui a été effectuée. Il peut s’agir de l’une des valeurs suivantes (d’autres valeurs pourraient être prises en charge à l’avenir) : federated : une connexion sociale ou d’entreprise a été utilisée pour authentifier l’utilisateur pwd : une connexion de base de données a été utilisée pour authentifier l’utilisateur sms : une connexion SMS Passwordless a été utilisée pour authentifier l’utilisateur email : une connexion Passwordless Email a été utilisée pour authentifier l’utilisateur mfa : l’utilisateur a effectué une authentification multifacteur timestamp : un entier indiquant l’heure, en secondes, à laquelle la méthode d’authentification a eu lieu, en temps Unix Epoch Vous pouvez consulter un exemple de cas d’utilisation de la propriété context.authentication.methods dans la règle Require MFA once per session.
context.authorization	Un objet contenant des informations liées à la transaction d’autorisation avec les propriétés suivantes : roles : un tableau de chaînes contenant les noms des rôles attribués à un utilisateur. Vous trouverez un exemple de cas d’utilisation de la propriété context.authorization.roles pour ajouter des rôles aux jetons dans Exemples de cas d’utilisation : Rules avec autorisation.
context.organization	Objet contenant des renseignements liés à l’organisation. Inclut les propriétés suivantes : id : String contenant l’ID de l’organisation avec laquelle l’utilisateur se connecte. name : String contenant le nom de l’organisation (tel que défini dans l’Auth0 Dashboard). metadata : Dictionnaire de paires clé-valeur de chaînes contenant d’autres propriétés de l’organisation.

​

En savoir plus

• Débogage des Rules
• Propriétés de l’objet user dans les Rules
• Exemples de scénarios d’utilisation : Scopes et claims