Event Object

Learn about the credentials-exchange Action trigger’s event object, which provides contextual information about the trigger execution.

The event object for the credentials-exchange Actions trigger provides contextual information about the trigger execution.

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

Information about the access token to be issued.

非表示 event.accessToken properties

customClaims · dictionary

scope · array of string

​

event.agent

event.agent · object · optional

[Early Access] Information about the agent acting in this flow. Set when the client requesting the token is linked to an agent and the tenant has agents as principals enabled; undefined otherwise.

非表示 event.agent properties

agent_id · string

[Early Access] The stable identifier for the agent, prefixed with agt_ (for example, agt_2hVk6JxPxbRgNZDKfJQqmn).

agent_metadata · dictionary

[Early Access] Free-form key-value metadata associated with the agent. Always defined when agent is present; an empty object when the agent has no metadata.

name · string

[Early Access] The human-readable name of the agent.

​

event.client

event.client · object

Information about the Client used during this token exchange.

非表示 event.client properties

client_id · string

The client id of the application the user is logging in to.

metadata · dictionary

An object for holding other application properties.

name · string

The name of the application (as defined in the Dashboard).

​

event.custom_domain

event.custom_domain · object · optional

Details about the custom domain associated with the current transaction.

非表示 event.custom_domain properties

domain · string

The custom domain name.

domain_metadata · dictionary

Custom domain metadata as key-value pairs.

​

event.organization

event.organization · dictionary · optional

Details about the Organization associated with the current transaction.

非表示 event.organization properties

id · string

The Organization identifier.

display_name · string

The friendly name of the Organization.

metadata · dictionary

Metadata associated with the Organization.

name · string

The name of the Organization.

​

event.request

event.request · object

Details about the request that initiated the transaction.

非表示 event.request properties

body · dictionary

The body of the POST request. This data will only be available during refresh token, Client Credential Exchange flows and PreUserRegistration Action.

geoip · dictionary

非表示 geoip properties

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

The hostname that is being used for the authentication flow.

ip · string

The originating IP address of the request.

language · string · optional

The language requested by the browser.

method · string

The HTTP method used for the request

user_agent · string · optional

The value of the User-Agent header received when initiating the transaction.

​

event.resource_server

event.resource_server · object

Information about the Resource Server that is issuing the access token.

非表示 event.resource_server properties

identifier · string

The identifier of the resource server. For example: https://your-api.example.com.

​

event.secrets

event.secrets · secrets

Secret values securely associated with this Action.

​

event.tenant

event.tenant · object

Information about the Tenant used during this token exchange.

非表示 event.tenant properties

id · string

The name of the tenant.

​

event.transaction

event.transaction · object

Information about the Credentials Exchange transaction.

非表示 event.transaction properties

correlation_id · string · optional

Correlation ID can be provided in the initial authentication request when the application redirects to Universal Login. You can use value to correlate logs and requests from your Action code with the user flow.

requested_scopes · array of string

The scopes specified (if any) when requesting the access token.

target_scopes · array of string · optional

[Early Access] The live target scope set for the access token. Initialized from the client grants and immediately updated by api.transaction target scope methods across current and subsequent Actions. After all Actions complete, these scopes are intersected with the client grant. Scopes not present in the grant are silently dropped from the final access token.