> ## Documentation Index
> Fetch the complete documentation index at: https://docs-staging-quickstart-revamp.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Learn about the credentials-exchange Action trigger's event object, which provides contextual information about the request for a client credentials exchange.

# Actions Triggers: credentials-exchange - Event Object

The `event` object for the credentials-exchange Actions trigger provides contextual information about the request for a client credentials exchange.

<table class="table">
  <thead>
    <tr>
      <th>Property</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p><code>event.accessToken</code></p>
      </td>

      <td>
        <p>Information about the <Tooltip tip="Authorization credential, in the form of an opaque string or JWT, used to access an API." cta="View Glossary" href="/docs/glossary?term=Access+Token">Access Token</Tooltip> to be issued.</p>
        <p>Includes the following properties:</p>

        <ul>
          <li><code>customClaims</code> <em>Dictionary</em>.</li>
          <li><code>scope</code> <em>Array of strings</em>.</li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p><code>event.client</code></p>
      </td>

      <td>
        <p>Information about the Client used during this token exchange.</p>
        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>client\_id</code> <em>String</em>.
            <span>The client id of the application the user is logging in to.</span>
          </li>

          <li>
            <code>metadata</code> <em>Dictionary</em>.
            <span>An object for holding other application properties.</span>
          </li>

          <li>
            <code>name</code> <em>String</em>.
            <span>The name of the application (as defined in the Dashboard).</span>
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p><code>event.organization</code></p>
      </td>

      <td>
        <p>Details about the Organization associated with the current transaction.</p>
        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>display\_name</code> <em>String</em>.
            <span>The friendly name of the Organization.</span>
          </li>

          <li>
            <code>id</code> <em>String</em>.
            <span>The Organization identifier.</span>
          </li>

          <li>
            <code>metadata</code> <em>Dictionary</em>.
            <span>Metadata associated with the Organization.</span>
          </li>

          <li>
            <code>name</code> <em>String</em>.
            <span>The name of the Organization.</span>
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p><code>event.request</code></p>
      </td>

      <td>
        <p>Details about the request that initiated the transaction.</p>
        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>body</code> <em>Dictionary</em>.
            <span>The body of the POST request. This data will only be available
            during refresh token, Client Credential Exchange flows and
            PreUserRegistration Action.</span>
          </li>

          <li>
            <code>geoip</code> <em>Object</em>.
            <p>Includes the following properties:</p>

            <ul>
              <li><code>cityName</code> <em>Optional string</em>.</li>
              <li><code>continentCode</code> <em>Optional string</em>.</li>
              <li><code>countryCode</code> <em>Optional string</em>.</li>
              <li><code>countryCode3</code> <em>Optional string</em>.</li>
              <li><code>countryName</code> <em>Optional string</em>.</li>
              <li><code>latitude</code> <em>Optional number</em>.</li>
              <li><code>longitude</code> <em>Optional number</em>.</li>
              <li><code>subdivisionCode</code> <em>Optional string</em>.</li>
              <li><code>subdivisionName</code> <em>Optional string</em>.</li>
              <li><code>timeZone</code> <em>Optional string</em>.</li>
            </ul>
          </li>

          <li>
            <code>hostname</code> <em>Optional string</em>.
            <span>The hostname that is being used for the authentication
            flow.</span>
          </li>

          <li>
            <code>ip</code> <em>String</em>.
            <span>The originating IP address of the request.</span>
          </li>

          <li>
            <code>language</code> <em>Optional string</em>.
            <span>The language requested by the browser.</span>
          </li>

          <li>
            <code>method</code> <em>String</em>.
            <span>The HTTP method used for the request</span>
          </li>

          <li>
            <code>user\_agent</code> <em>Optional string</em>.
            <span>The value of the <code>User-Agent</code> header received when
            initiating the transaction.</span>
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p><code>event.resource\_server</code></p>
      </td>

      <td>
        <p>
          Information about the Resource Server that is issuing the access token.
        </p>

        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>identifier</code> <em>String</em>.
            <span>The identifier of the resource server. For example:
            `https://your-api.example.com`.</span>
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p><code>event.tenant</code></p>
      </td>

      <td>
        <p>Information about the Tenant used during this token exchange.</p>
        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>id</code> <em>String</em>.
            <span>The name of the tenant.</span>
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p><code>event.transaction</code></p>
      </td>

      <td>
        <p>Information about the Credentials Exchange transaction.</p>
        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>requested\_scopes</code> <em>Array of strings</em>.
            <span>The scopes specified (if any) when requesting the access
            token.</span>
          </li>
        </ul>
      </td>
    </tr>
  </tbody>
</table>