Objet Event

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

L’objet event du déclencheur Actions credentials-exchange fournit des renseignements contextuels sur son exécution.

Event Object

{
  "secrets": {},
  "accessToken": {
    "customClaims": {},
    "scope": []
  },
  "client": {
    "client_id": "string",
    "metadata": {},
    "name": "string"
  },
  "request": {
    "body": {},
    "geoip": {},
    "ip": "string",
    "method": "string"
  },
  "resource_server": {
    "identifier": "string"
  },
  "tenant": {
    "id": "string"
  },
  "transaction": {
    "requested_scopes": []
  }
}

​

event.accessToken

event.accessToken · object

Renseignements sur le jeton d’accès à émettre.

Masquer propriétés de event.accessToken

customClaims · dictionary

scope · array of string

​

event.agent

event.agent · object · optional

[Accès anticipé] Informations sur l’agent intervenant dans ce flux. Défini lorsque le client qui demande le jeton est lié à un agent et que les agents en tant que principaux sont activés dans le tenant; sinon, undefined.

Masquer propriétés de event.agent

agent_id · string

[Accès anticipé] L’identifiant stable de l’agent, précédé de agt_ (par exemple, agt_2hVk6JxPxbRgNZDKfJQqmn).

agent_metadata · dictionary

[Accès anticipé] Métadonnées libres sous forme de paires clé-valeur associées à l’agent. Toujours définies lorsque agent est présent; objet vide lorsque l’agent n’a pas de métadonnées.

name · string

[Accès anticipé] Le nom de l’agent lisible par l’humain.

​

event.client

event.client · object

Informations sur le client utilisé lors de cet échange de jetons.

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

Le 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

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

​

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

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

Masquer propriétés de la requête

body · dictionary

Le corps de la requête POST. Ces données ne sont disponibles que lors des flux de jeton d’actualisation, d’échange d’identifiants client et de l’Action PreUserRegistration.

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 lors de l’initialisation de la transaction.

​

event.resource_server

event.resource_server · object

Renseignements sur le serveur de ressources qui émet le jeton d’accès.

Masquer propriétés de event.resource_server

identifier · string

L’identifiant du serveur de ressources. Par exemple : https://your-api.example.com.

​

event.secrets

event.secrets · secrets

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

​

event.tenant

event.tenant · object

Renseignements sur le tenant utilisé lors de cet échange de jetons.

Masquer Propriétés de event.tenant

id · string

Le nom du tenant.

​

event.transaction

event.transaction · object

Renseignements sur la transaction d’échange d’identifiants.

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 corréler les logs et les requêtes de votre code Action avec le parcours utilisateur.

requested_scopes · array of string

Les portées précisées, le cas échéant, lors de la demande du jeton d’accès.

target_scopes · array of string · optional

[Accès anticipé] L’ensemble dynamique des portées cibles du jeton d’accès. Il est initialisé à partir des autorisations client et immédiatement mis à jour par les méthodes de portée cible d’api.transaction dans l’Action en cours et les Actions suivantes. Une fois toutes les Actions terminées, ces portées sont intersectées avec l’autorisation client. Les portées qui ne figurent pas dans l’autorisation sont silencieusement exclues du jeton d’accès final.