Objet d’événement

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

Event Object

{
  "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": {},
  "secrets": {}
}

`event.client`

object

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

Masquer propriétés d’event.client

string

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

dictionary

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

string

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

`event.connection`

object

optional

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

Masquer propriétés de event.connection

string

L’identifiant unique de la connexion.

dictionary

optional

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

string

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

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`

object

optional

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

Masquer Propriétés de event.custom_domain

string

Le nom de domaine personnalisé.

dictionary

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

`event.notification`

object

Masquer propriétés de event.notification

string

Adresse courriel de l’expéditeur.

string

Modèle HTML généré.

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.

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

string

Objet du courriel.

string

Modèle de texte généré.

string

Adresse courriel du destinataire.

`event.organization`

dictionary

optional

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

Masquer propriétés de event.organization

string

L’identifiant de l’organisation.

string

Le nom convivial de l’organisation.

dictionary

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

string

Le nom de l’organisation.

`event.request`

object

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

dictionary

optional

Masquer propriétés de geoip

string

optional

string

optional

string

optional

string

optional

string

optional

number

optional

number

optional

string

optional

string

optional

string

optional

string

optional

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

string

optional

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

dictionary

optional

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

string

optional

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

`event.secrets`

secrets

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

`event.tenant`

object

Masquer propriétés de event.tenant

string

Le nom du tenant.

string

optional

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

string

optional

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

string

optional

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

string

optional

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

string

optional

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

`event.transaction`

object

optional

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

Masquer propriétés de event.transaction

string

optional

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

`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

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.

string

optional

(unique) Adresse courriel de l’utilisateur.

boolean

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

string

optional

Nom de famille de l’utilisateur.

string

optional

Prénom de l’utilisateur.

string

optional

Nom complet de l’utilisateur.

string

optional

Surnom de l’utilisateur.

string

optional

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

string

(unique) Identifiant unique de l’utilisateur.

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.

string

optional

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

​event.client

​event.connection

​event.custom_domain

​event.notification

​event.organization

​event.request

​event.secrets

​event.tenant

​event.transaction

​event.user

`event.client`

`event.connection`

`event.custom_domain`

`event.notification`

`event.organization`

`event.request`

`event.secrets`

`event.tenant`

`event.transaction`

`event.user`