Objet d’événement

Découvrez l’objet d’événement 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 Object

{
  "secrets": {},
  "client": {
    "client_id": "string",
    "metadata": {},
    "name": "string"
  },
  "notification": {
    "from": "string",
    "html": "string",
    "locale": "string",
    "message_type": "string",
    "subject": "string",
    "text": "string",
    "to": "string"
  },
  "request": {},
  "tenant": {
    "id": "string"
  },
  "user": {}
}

​

event.client

event.client · object

Renseignements sur le client avec lequel cette transaction de connexion a été lancée.

Masquer propriétés d’event.client

client_id · string

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

metadata · dictionary

Un objet qui contient d’autres propriétés de l’application.

name · string

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

​

event.connection

event.connection · object · optional

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

Masquer propriétés de event.connection

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 à une base de données), etc.

​

event.custom_domain

event.custom_domain · object · optional

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

Masquer Propriétés de event.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 event.notification

from · string

Adresse courriel de l’expéditeur.

html · string

Modèle HTML généré.

locale · string

La locale utilisée pour générer le message, par exemple en_US, telle que définie dans la spécification BCP-47.

message_type · string

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

Valeurs autorisées : 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 de 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 event.organization

id · string

L’identifiant de l’organisation.

display_name · string

Le nom convivial de l’organisation.

metadata · dictionary

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

name · string

Le nom de l’organisation.

​

event.request

event.request · object

Masquer propriétés de la requête event.request

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é dans le flux d’authentification.

ip · string · optional

L’adresse IP d’origine de la requête.

query · dictionary · optional

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

user_agent · string · optional

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

​

event.secrets

event.secrets · secrets

Valeurs secrètes stockées de façon sécurisée et associées à cette Action.

​

event.tenant

event.tenant · object

Masquer propriétés de event.tenant

id · string

Le nom du tenant.

friendly_name · string · optional

Le nom convivial du tenant, généralement une version de l’ID plus facile à comprendre.

home_url · string · optional

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

logo_url · string · optional

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

support_email · string · optional

L’adresse courriel du service de soutien du tenant, si elle est définie dans ses paramètres.

support_url · string · optional

L’URL du service de soutien du tenant, si elle est définie dans ses paramètres.

​

event.transaction

event.transaction · object · optional

Détails sur la transaction en cours à des fins de traçabilité.

Masquer propriétés de event.transaction

correlation_id · string · optional

Un identifiant unique permettant de corréler cette requête entre plusieurs services aux fins de traçabilité distribuée.

​

event.user

event.user · dictionary

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

Masquer propriétés de event.user

app_metadata · dictionary

Champs personnalisés qui stockent des renseignements sur un utilisateur et qui influencent son accès, comme son plan de soutien, ses rôles de sécurité ou ses 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 influencer les ressources auxquelles il peut accéder, comme son adresse professionnelle, son adresse résidentielle ou ses préférences.

username · string · optional

(unique) Nom d’utilisateur de l’utilisateur.