Objet Event

Découvrez l’objet event du déclencheur Actions send-phone-message, qui fournit des renseignements contextuels sur son exécution.

L’objet event du déclencheur Actions send-phone-message fournit des renseignements contextuels sur son exécution.

Event Object

{
  "secrets": {},
  "message_options": {
    "action": "string",
    "code": "string",
    "message_type": "string",
    "recipient": "string",
    "text": "string"
  },
  "request": {
    "geoip": {},
    "ip": "string",
    "method": "string"
  },
  "tenant": {
    "id": "string"
  },
  "user": {}
}

​

event.client

event.client · object · optional

Renseignements sur le client avec lequel cette transaction 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 permettant de stocker d’autres propriétés de l’application.

name · string

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

​

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 du domaine personnalisé.

domain_metadata · dictionary

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

​

event.message_options

event.message_options · object

Détails sur le message envoyé à l’utilisateur.

Masquer propriétés de event.message_options

action · string

Le flux qui a déclenché cette action.

Valeurs autorisées : enrollment, second-factor-authentication

code · string

Mot de passe à usage unique que l’utilisateur doit saisir dans le formulaire.

message_type · string

Mode de livraison du message : par sms ou par voice.

Valeurs autorisées : sms, voice

recipient · string

Numéro de téléphone auquel le message sera envoyé.

text · string

Contenu du message à envoyer.

​

event.request

event.request · object

Détails sur 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 d’origine 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 lors de l’initialisation de la transaction.

​

event.secrets

event.secrets · secrets

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

​

event.security_context

event.security_context · object · optional

Objet contenant des signatures d’empreintes. Il est disponible uniquement si le client utilise Cloudflare. L’empreinte JA3/JA4 peut être nulle ou vide dans certains cas. C’est le plus souvent le cas pour les requêtes HTTP, car JA3 et JA4 sont calculées lors de la négociation TLS. Elle peut aussi être vide lorsque le Worker envoie des requêtes dans la même zone ou vers une zone qui n’est pas proxyfiée (ou vers un tiers).

Masquer propriétés de event.security_context

ja3 · string · optional

Signature d’empreinte JA3. Elle est disponible uniquement si le client utilise une connexion TLS.

ja4 · string · optional

Signature d’empreinte JA4. Elle est disponible uniquement si le client utilise une connexion TLS.

​

event.tenant

event.tenant · object

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

Masquer propriétés de event.tenant

id · string

Le nom du tenant.

​

event.transaction

event.transaction · object · optional

Détails de la transaction en cours.

Masquer propriétés de event.transaction

correlation_id · string · optional

L’ID de corrélation peut être fourni dans la requête d’authentification initiale lorsque l’application redirige vers Universal Login. Vous pouvez utiliser cette valeur pour établir une corrélation entre les logs et les requêtes de votre code Action, et le parcours utilisateur.

​

event.user

event.user · dictionary

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

Masquer propriétés de event.user

app_metadata · dictionary

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

created_at · string

Horodatage indiquant à quel moment le profil utilisateur a été créé.

email · string · optional

Adresse courriel (unique) 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 lors de la création de l’utilisateur. Cette propriété est offerte uniquement pour les connexions à une 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 menant à 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

Identifiant unique de l’utilisateur.

user_metadata · dictionary

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

username · string · optional

Nom d’utilisateur (unique) 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 authentifié initialement. Les utilisateurs peuvent aussi lier leur profil à plusieurs fournisseurs d’identité ; ces identités apparaîtront alors également dans ce tableau. Le contenu de chaque objet de fournisseur d’identité varie selon le fournisseur.