Objet Event

Découvrez l’objet event du déclencheur Actions custom-phone-provider, qui fournit des informations contextuelles sur son exécution.

L’objet event du déclencheur Actions custom-phone-provider fournit des informations contextuelles sur son exécution.

Event Object

{
  "secrets": {},
  "client": {
    "client_id": "string",
    "metadata": {},
    "name": "string"
  },
  "notification": {
    "as_text": "string",
    "as_voice": "string",
    "delivery_method": "string",
    "message_type": "string",
    "recipient": "string"
  },
  "request": {
    "geoip": {},
    "ip": "string",
    "method": "string"
  },
  "tenant": {
    "id": "string"
  },
  "user": {}
}

​

event.client

event.client · object

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

Masquer propriétés de event.client

client_id · string

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

metadata · dictionary

Objet contenant d’autres propriétés de l’application.

name · string

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

​

event.connection

event.connection · object · optional

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

​

event.custom_domain

event.custom_domain · object · optional

Renseignements 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

as_text · string

Le texte tel que nous l’avons rendu, prêt à être envoyé par message texte.

as_voice · string

Le texte tel que nous l’avons rendu, prêt à être envoyé comme message vocal.

code · string · optional

Le mot de passe à usage unique que nous avons généré pour ce message dans certains cas (p. ex. otp_verify, otp_enroll). S’il est fourni, il est important de le communiquer à l’utilisateur final.

delivery_method · string

Le mode de livraison du message. Peut être text ou voice.

Valeurs autorisées : text, voice

from · string · optional

Le numéro de téléphone de l’émetteur, conforme à la norme E.164.

locale · string · optional

Le paramètre régional utilisé pour rendre le message, par exemple en_US, tel que défini dans la spécification BCP-47.

message_type · string

Le type de message envoyé, comme otp_verify ou blocked_account.

Valeurs autorisées : otp_verify, otp_enroll, blocked_account, change_password, password_breach

recipient · string

Le numéro de téléphone du destinataire, conforme à la norme E.164.

​

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 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 · object

Détails de la requête à l’origine de la transaction.

Masquer propriétés de la requête

geoip · dictionary

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

L’adresse IP source de la requête.

language · string · optional

La langue demandée par le navigateur.

method · string

La méthode HTTP utilisée pour la requête

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 associées de façon sécurisée à 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 plus lisible de l’ID.

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çage.

Masquer propriétés d’event.transaction

correlation_id · string · optional

Un identifiant unique permettant de corréler cette requête entre plusieurs services dans le cadre du traçage distribué.

​

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 contenant des renseignements sur un utilisateur 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.

created_at · string

Horodatage indiquant la date de création initiale du profil utilisateur.

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.

last_password_reset · string · optional

Horodatage indiquant la dernière réinitialisation ou modification du mot de passe de l’utilisateur. Ce champ n’existe pas à la création de l’utilisateur. Cette propriété est offerte uniquement pour les connexions de base de données.

name · string · optional

Nom complet de l’utilisateur.

nickname · string · optional

Surnom de l’utilisateur.

phone_number · string · optional

Numéro de téléphone de l’utilisateur.

phone_verified · boolean · optional

Indique si l’utilisateur a vérifié son numéro de téléphone.

picture · string · optional

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

updated_at · string

Horodatage indiquant la dernière mise à jour ou modification du profil de l’utilisateur.

user_id · string

(unique) Identifiant unique de l’utilisateur.

user_metadata · dictionary

Champs personnalisés contenant des renseignements sur un utilisateur qui n’ont aucune incidence sur ce à quoi 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.

identities · array of objects · optional

Contient des renseignements récupérés auprès du fournisseur d’identité auprès duquel l’utilisateur s’est initialement authentifié. Les utilisateurs peuvent également associer leur profil à plusieurs fournisseurs d’identité; ces identités figureront alors aussi dans ce tableau. Le contenu de chaque objet de fournisseur d’identité varie selon le fournisseur.