Event Object

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

Event Object

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

`event.client`

object

Information about the Client with which this transaction was initiated.

Masquer event.client properties

string

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

dictionary

An object for holding other application properties.

string

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

`event.organization`

dictionary

optional

Details about the Organization associated with the current transaction.

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

Masquer 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

Masquer 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

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

Masquer 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

Details about the Tenant associated with the current transaction.

Masquer event.tenant properties

string

The name of the tenant.

`event.transaction`

object

Details about the current custom token exchange transaction.

Masquer event.transaction properties

string

optional

The actor token provided in the token exchange request.

string

optional

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

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.

Masquer actor_token_user properties

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.

string

Timestamp indicating when the user profile was first created.

string

optional

(unique) User’s email address.

boolean

Indicates whether the user has verified their email address.

string

optional

User’s family name.

string

optional

User’s given name.

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.

string

optional

User’s full name.

string

optional

User’s nickname.

string

optional

User’s phone number.

boolean

optional

Indicates whether the user has verified their phone number.

string

optional

URL pointing to the user’s profile picture.

string

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

string

(unique) User’s unique identifier.

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.

string

optional

(unique) User’s username.

array of objects

optional

An array of authentication factors that the user has enrolled.

array of string

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.

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.

array of string

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

string

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

string

The subject token provided in the token exchange request.

string

The subject_token_type provided in the token exchange request.

Credentials Exchange

Custom Email Provider

Custom Phone Provider

Custom Token Exchange

Event Stream

Password Reset Post Challenge

Post Change Password

Post Login

Post User Registration

Pre User Registration

Send Phone Message

`event.client`

`event.organization`

`event.request`

`event.resource_server`

`event.secrets`

`event.tenant`

`event.transaction`

​event.client

​event.organization

​event.request

​event.resource_server

​event.secrets

​event.tenant

​event.transaction

`event.client`

`event.organization`

`event.request`

`event.resource_server`

`event.secrets`

`event.tenant`

`event.transaction`