Passer au contenu principal
L’objet event du déclencheur d’actions custom-email-provider fournit des informations contextuelles sur les données du courriel.
PropriétéDescription

event.client

Informations sur le client avec lequel la transaction de connexion a été initiée.

Comprend les propriétés suivantes :

  • client_id Chaîne. L’ID client de l’application à laquelle l’utilisateur se connecte.
  • metadata Dictionnaire. Un objet qui contient les autres propriétés d’une application.
  • name Chaîne. Le nom de l’application (comme défini dans le Dashboard).

event.connection

(Facultatif)

Détails sur la connexion utilisée pour authentifier l’utilisateur.

Comprend les propriétés suivantes :

  • id Chaîne facultative. L’identifiant unique de la connexion.
  • metadata Dictionnaire facultatif. Métadonnées associées à la connexion.
  • name Chaîne facultative. Le nom de la connexion utilisée pour authentifier l’utilisateur (par ex. : twitter ou some-g-suite-domain).
  • strategy Chaîne facultative. Le type de connexion. Pour les connexions sociales, event.connection.strategy === event.connection.name. Pour les connexions d’entreprise, la stratégie est la suivante : waad (Windows Entra ID), ad (Active Directory/LDAP), auth0 (connexions aux bases de données), etc.

event.notification

Comprend les propriétés suivantes :

  • html Chaîne. Modèle HTML rendu.
  • from Chaîne. Adresse courriel de l’expéditeur pour les courriels.
  • subject Chaîne. Objet à joindre au courriel.
  • locale Chaîne facultative. La langue dans laquelle nous avons rendu le message, par exemple en_US, telle que définie dans la spécification BCP-47.
  • message_type Chaîne.

    Le type de message envoyé, par exemple verify_email ou welcome_email.

    Les valeurs possibles sont les suivantes :

    • verify_email
    • verify_email_by_code
    • reset_email
    • reset_email_by_code
    • welcome_email
    • verification_code
    • mfa_oob_code
    • enrollment_email
    • blocked_account
    • stolen_credentials
    • try_provider_configuration_email
    • organization_invitation
  • text Chaîne. Modèle de texte rendu.
  • to Chaîne. Adresse courriel du destinataire.

event.organization

(Facultatif)

Détails sur l’Organization associée à la transaction en cours.

Comprend les propriétés suivantes :

  • display_name Chaîne. Le nom convivial de l’Organization.
  • id Chaîne. L‘identifiant de l’Organization.
  • metadata Dictionnaire. Métadonnées associées à l’Organization.
  • name Chaîne. Le nom de l’Organization.

event.request

(Facultatif)

Comprend les propriétés suivantes :

  • geoip Objet facultatif.

    Comprend les propriétés suivantes :

    • countryCode Chaîne facultative.
    • countryCode3 Chaîne facultative.
    • cityName Chaîne facultative.
    • latitude Chaîne facultative.
    • longitude Chaîne facultative.
    • timeZone Chaîne facultative.
    • subdivisionCode Chaîne facultative.
    • subdivisionName Chaîne facultative.
    • continentCode Chaîne facultative.
  • ip Chaîne facultative. L’adresse IP initiale de la requête.
  • query Dictionnaire facultatif. Les paramètres de la chaîne de requête envoyés à la demande d’autorisation. Pris en charge uniquement pour le flux de réinitialisation des mots de passe.
  • user_agent Chaîne facultative. La valeur de l’en-tête User-Agent reçu lorsque de la transaction a été initiée.

event.tenant

Comprend les propriétés suivantes :

  • friendly_name Chaîne facultative. Le nom convivial du locataire, généralement une version plus lisible de l’ID.
  • home_url Chaîne facultative. L’URL d’accueil du locataire, si elle est définie et telle qu’elle figure dans ses paramètres.
  • id Chaîne. Le nom du locataire.
  • logo_url Chaîne facultative. L’URL du logo du locataire, si elle est définie et telle qu’elle figure dans ses paramètres.
  • support_email Chaîne facultative. Le courriel du service de soutien du locataire, s’il est défini et tel qu’il figure dans ses paramètres.
  • support_url Chaîne facultative. L’URL du service de soutien du locataire, si elle est définie et tel qu’elle figure dans ses paramètres.

event.user

Objet décrivant l’utilisateur au nom duquel la transaction en cours a été initiée.

Comprend les propriétés suivantes :

  • app_metadata Dictionnaire. Champs personnalisés qui stockent des informations sur un utilisateur et qui influencent l’accès de l’utilisateur, comme le plan de soutien, les rôles de sécurité ou les groupes de contrôle d’accès.
  • email Chaîne facultative. (unique) Adresse de courriel de l’utilisateur.
  • email_verified Booléen. Indique si l’utilisateur a vérifié son adresse de courriel.
  • family_name Chaîne facultative. Nom de famille de l’utilisateur.
  • given_name Chaîne facultative. Prénom de l’utilisateur.
  • name Chaîne facultative. Nom complet de l’utilisateur.
  • nickname Chaîne facultative. Pseudonyme de l’utilisateur.
  • picture Chaîne facultative. URL pointant vers la photo de profil de l’utilisateur.
  • user_id Chaîne. (unique) Identifiant unique de l’utilisateur.
  • user_metadata Dictionnaire. Champs personnalisés qui stockent des informations sur un utilisateur qui n’ont pas d’incidence sur les données auxquelles il peut ou ne peut pas accéder, comme l’adresse professionnelle, l’adresse personnelle ou les préférences de l’utilisateur.
  • username Chaîne facultative. (unique) Nom d’utilisateur

​
En savoir plus

⌘I