Skip to main content
The event object for the custom-token-exchange Actions trigger provides contextual information about a Custom Token Exchange request.
PropertyDescription
event.client

Information about the Client used during this token exchange.

Includes the following 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.request

Details about the request that initiated the transaction.

Includes the following properties:

  • body Dictionary. The body of the POST request. This data will only be available during refresh token, Client Credential Exchange flows, and Custom Token Exchange.
  • geoip Object.

    Includes the following properties:

    • cityName Optional string.
    • continentCode Optional string.
    • countryCode Optional string.
    • countryCode3 Optional string.
    • countryName Optional string.
    • latitude Optional number.
    • longitude Optional number.
    • subdivisionCode Optional string.
    • subdivisionName Optional string.
    • timeZone Optional string.
  • hostname Optional string. The hostname that is being used for the authentication flow.
  • ip String. The originating IP address of the request.
  • language Optional string. The language requested by the browser.
  • method String. The HTTP method used for the request
  • user_agent Optional string. The value of the User-Agent header received when initiating the transaction.
event.transaction

Information about the Custom Token Exchange transaction.

Includes the following properties:

  • requested_scopes Array of strings. The scopes specified (if any) when requesting the access token.
  • subject_token_type String. The value of the subject_token_type received in the request body. Although this value uniquely maps to this Action, note several subject_token_types may map this same Action, depending on how you define the corresponding Custom Token Exchange profiles. For example: urn://cic-migration-token.
  • subject_token String. The value of the subject_token received in the request body. This assertion should identify the user to log in. For example: 41598922a1745f7af70.
event.resource_server

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

Includes the following properties:

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