Déclencheurs Actions : custom-email-provider - Objet `event`

Découvrez l’objet event du déclencheur Actions custom-email-provider, qui fournit des renseignements contextuels sur son exécution.

L’objet event du déclencheur Actions custom-email-provider fournit des renseignements contextuels sur son exécution.

​

event.client

event.client · dictionary

Renseignements sur le client avec lequel cette opération de connexion a été amorcée.

Masquer propriétés du client

client_id · string

L’identifiant client de l’application à laquelle l’utilisateur se connecte.

metadata · dictionary

Un objet servant à stocker d’autres propriétés de l’application.

name · string

Le nom de l’application (tel qu’il est défini dans le Dashboard).

​

event.connection

event.connection · dictionary · optional

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

Masquer propriétés de la connexion

id · string

L’identifiant unique de la connexion.

metadata · dictionary · optional

Métadonnées associées à la connexion.

name · string

Le nom de la connexion utilisée pour authentifier l’utilisateur (par exemple twitter ou some-g-suite-domain).

strategy · string

Le type de connexion. Pour les connexions sociales, event.connection.strategy === event.connection.name. Pour les connexions d’entreprise, la stratégie peut être waad (Windows Azure AD), ad (Active Directory/LDAP), auth0 (connexions de base de données), etc.

​

event.custom_domain

event.custom_domain · dictionary · optional

Renseignements sur le domaine personnalisé associé à la transaction en cours.

Masquer propriétés de custom_domain

domain · string

Le nom de domaine personnalisé.

domain_metadata · dictionary

Les métadonnées du domaine personnalisé sous forme de paires clé-valeur.

​

event.notification

event.notification · object

Masquer propriétés de la notification

from · string

Adresse courriel de l’expéditeur.

html · string

Modèle HTML généré.

locale · string

Paramètre régional dans lequel le message a été généré, par exemple en_US, tel que défini dans la spécification BCP-47.

message_type · string

Type de message envoyé, comme verify_email ou welcome_email.

Valeurs possibles :

• 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

subject · string

Objet du courriel.

text · string

Modèle texte généré.

to · string

Adresse courriel du destinataire.

​

event.organization

event.organization · dictionary · optional

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

Masquer propriétés de l’organisation

id · string

L’identifiant de l’organisation.

display_name · string

Le nom d’affichage de l’organisation.

metadata · dictionary

Les métadonnées associées à l’organisation.

name · string

Le nom de l’organisation.

​

event.request

event.request · dictionary

Masquer propriétés de la requête

geoip · dictionary · optional

Masquer propriétés de geoip

cityName · string · optional

continentCode · string · optional

countryCode · string · optional

countryCode3 · string · optional

countryName · string · optional

latitude · number · optional

longitude · number · optional

subdivisionCode · string · optional

subdivisionName · string · optional

timeZone · string · optional

hostname · string · optional

Le nom d’hôte utilisé pour le flux d’authentification.

ip · string · optional

L’adresse IP source de la requête.

query · dictionary · optional

Les paramètres de la chaîne de requête envoyés avec la requête d’autorisation.

user_agent · string · optional

La valeur de l’en-tête User-Agent reçue au moment d’amorcer la transaction.

​

event.secrets

event.secrets · secrets

Valeurs secrètes associées en toute sécurité à cette action.

​

event.tenant

event.tenant · object

Masquer propriétés du tenant

id · string

Le nom du tenant.

friendly_name · string · optional

Le nom d’affichage du tenant, généralement une version de l’ID plus facile à lire.

home_url · string · optional

L’URL d’accueil du tenant, si elle est définie et indiquée dans ses paramètres.

logo_url · string · optional

L’URL du logo du tenant, si elle est définie et indiquée dans ses paramètres.

support_email · string · optional

L’adresse courriel du service d’assistance du tenant, si elle est définie et indiquée dans ses paramètres.

support_url · string · optional

L’URL du service d’assistance du tenant, si elle est définie et indiquée dans ses paramètres.

​

event.transaction

event.transaction · object · optional

Détails sur la transaction en cours à des fins de suivi.

Masquer propriétés de la transaction

correlation_id · string · optional

Un identifiant unique permettant de faire le lien entre cette requête et plusieurs services dans le cadre du suivi distribué.

​

event.user

event.user · dictionary

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

Masquer propriétés de l’utilisateur

app_metadata · dictionary

Champs personnalisés qui stockent des renseignements sur un utilisateur et qui influencent ses accès, comme le forfait de soutien, les rôles de sécurité ou les groupes de contrôle d’accès.

email · string · optional

(unique) Adresse courriel de l’utilisateur.

email_verified · boolean

Indique si l’utilisateur a vérifié son adresse courriel.

family_name · string · optional

Nom de famille de l’utilisateur.

given_name · string · optional

Prénom de l’utilisateur.

name · string · optional

Nom complet de l’utilisateur.

nickname · string · optional

Surnom de l’utilisateur.

picture · string · optional

URL pointant vers la photo de profil de l’utilisateur.

user_id · string

(unique) Identifiant unique de l’utilisateur.

user_metadata · dictionary

Champs personnalisés qui stockent des renseignements sur un utilisateur sans incidence sur ce à quoi il peut accéder, comme son adresse professionnelle, son adresse domiciliaire ou ses préférences.

username · string · optional

(unique) Nom d’utilisateur.