Event Object

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

Event Object

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

`event.accessToken`

object

Information about the access token to be issued.

Hide event.accessToken properties

dictionary

array of string

`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.

Hide event.agent properties

string

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

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.

string

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

`event.client`

object

Information about the Client used during this token exchange.

Hide event.client properties

string

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

boolean

Indicates whether the client application is first-party (true) or third-party (false). First-party applications are owned and operated by your organization, while third-party applications are owned by an external party. To learn more, read First-Party and Third-Party Applications.

dictionary

An object for holding other application properties.

string

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

`event.custom_domain`

object

optional

Details about the custom domain associated with the current transaction.

Hide event.custom_domain properties

string

The custom domain name.

dictionary

Custom domain metadata as key-value pairs.

`event.organization`

dictionary

optional

Details about the Organization associated with the current transaction.

Hide event.organization properties

string

The Organization identifier.

string

The friendly name of the Organization.

dictionary

Metadata associated with the Organization.

string

The name of the Organization.

`event.request`

object

Details about the request that initiated the transaction.

Hide event.request properties

dictionary

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

dictionary

Hide geoip properties

string

optional

string

optional

string

optional

string

optional

string

optional

number

optional

number

optional

string

optional

string

optional

string

optional

string

optional

The hostname that is being used for the authentication flow.

string

The originating IP address of the request.

string

optional

The language requested by the browser.

string

The HTTP method used for the request

string

optional

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

`event.resource_server`

object

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

Hide event.resource_server properties

string

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

`event.secrets`

secrets

Secret values securely associated with this Action.

`event.tenant`

object

Information about the Tenant used during this token exchange.

Hide event.tenant properties

string

The name of the tenant.

`event.transaction`

object

Information about the Credentials Exchange transaction.

Hide event.transaction properties

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.

array of string

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

array of string

optional

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.

Concepts

How To

Reference

Use Cases

`event.accessToken`

`event.agent`

`event.client`

`event.custom_domain`

`event.organization`

`event.request`

`event.resource_server`

`event.secrets`

`event.tenant`

`event.transaction`

​event.accessToken

​event.agent

​event.client

​event.custom_domain

​event.organization

​event.request

​event.resource_server

​event.secrets

​event.tenant

​event.transaction

`event.accessToken`

`event.agent`

`event.client`

`event.custom_domain`

`event.organization`

`event.request`

`event.resource_server`

`event.secrets`

`event.tenant`

`event.transaction`