Event Object

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

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

Event Object

{
  "client": { "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww", "name": "My App" },
  "resource_server": { "identifier": "https://api.example.com" },
  "transaction": {
    "subject_token": "eyJhbGciOi...",
    "subject_token_type": "urn:acme:legacy-token",
    "requested_scopes": ["read:reports"]
  },
  "request": { "ip": "13.33.86.1", "hostname": "your-tenant.us.auth0.com" },
  "organization": { "id": "org_abc123", "name": "acme" },
  "tenant": { "id": "your-tenant" },
  "secrets": {}
}

event.client

event.client · dictionary

Information about the Client with which this transaction was initiated.

Hide 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.organization

event.organization · dictionary · optional

Details about the Organization associated with the current transaction.

Hide 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 · dictionary

Details about the request that initiated the transaction.

Hide 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

Hide 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

Details about the resource server to which the access is being requested.

Hide 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

Details about the Tenant associated with the current transaction.

Hide tenant properties

id · string

The name of the tenant.

event.transaction

event.transaction · dictionary

Details about the current custom token exchange transaction.

Hide transaction properties

actor_token · string · optional

The actor token provided in the token exchange request.

actor_token_type · string · optional

The type of the actor token provided in the token exchange request.

actor_token_user · dictionary · optional

The user represented by the actor token. This will only be present if the actor_token_type is urn:ietf:params:oauth:token-type:id_token and the actor token provided in the token exchange request is a valid Auth0 generated ID token.

Hide actor_token_user properties

app_metadata · dictionary

Custom fields that store info about a user that influences the user’s access, such as support plan, security roles, or access control groups.

created_at · string

Timestamp indicating when the user profile was first created.

email · string · optional

(unique) User’s email address.

email_verified · boolean

Indicates whether the user has verified their email address.

family_name · string · optional

User’s family name.

given_name · string · optional

User’s given name.

last_password_reset · string · optional

Timestamp indicating the last time the user’s password was reset/changed. At user creation, this field does not exist. This property is only available for Database connections.

name · string · optional

User’s full name.

nickname · string · optional

User’s nickname.

phone_number · string · optional

User’s phone number.

phone_verified · boolean · optional

Indicates whether the user has verified their phone number.

picture · string · optional

URL pointing to the user’s profile picture.

updated_at · string

Timestamp indicating when the user’s profile was last updated/modified.

user_id · string

(unique) User’s unique identifier.

user_metadata · dictionary

Custom fields that store info about a user that does not impact what they can or cannot access, such as work address, home address, or user preferences.

username · string · optional

(unique) User’s username.

enrolledFactors · array of objects · optional

An array of authentication factors that the user has enrolled.

Show enrolledFactors properties

type · string

The type of authentication factor such as push-notification, phone, email, otp, webauthn-roaming and webauthn-platform.

options · dictionary · optional

Additional options describing this instance of the enrolled factor.

multifactor · array of strings · optional

List of multi-factor authentication (MFA) providers with which the user is enrolled. This array is updated when the user enrolls in MFA and when an administrator resets a user’s MFA enrollments.

identities · array of objects

Contains info retrieved from the identity provider with which the user originally authenticates. Users may also link their profile to multiple identity providers; those identities will then also appear in this array. The contents of an individual identity provider object varies by provider.

Show identities element properties

connection · string · optional

Name of the Auth0 connection used to authenticate the user.

isSocial · boolean · optional

Indicates whether the connection is a social one.

profileData · dictionary · optional

User information associated with the connection. When profiles are linked, it is populated with the associated user info for secondary accounts.

provider · string · optional

Name of the entity that is authenticating the user, such as Facebook, Google, SAML, or your own provider.

user_id · string · optional

User’s unique identifier for this connection/provider.

requested_scopes · array of strings

The scopes requested (if any) provided in the token exchange request.

requested_token_type · string

The type of token to be generated by Auth0. For example: urn:ietf:params:oauth:token-type:access_token.

subject_token · string

The subject token provided in the token exchange request.

subject_token_type · string

The subject_token_type provided in the token exchange request.