---
schema_version: "1"
id: fe4b1d59126861044d3b63444ccab72d791c0641d467f88a681b1c54e69d0109
title: Configure the External Client App OAuth Settings
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/meta_configure_external_client_app_oauth_settings.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.meta_configure_external_client_app_oauth_settings.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: b8707b560f6fcd985ad4f813ed7b4b0d356caf8b77ce556a9f2750ad7120f36f
description: Configure the OAuth settings file, which affects the local instance.
products:
  - Security
  - Cross Cloud
release: "264"
---
# Configure the External Client App OAuth Settings

Configure the OAuth settings file, which affects the local instance.

1. Create a file called \[ECAPP\_OAUTH\_SETTINGS\].ecaOauth-meta.xml, for example,myecasettings.ecaOauth-meta.xml, in a directory called extlClntAppOauthSettings. This file is theOAuth settings file, which defines the configuration of the external client app.
2. Configure the file with this information.
    
    <table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
            <colgroup>
              <col style="width:33.33333333333333%">
              <col style="width:66.66666666666666%">
            </colgroup>
            <thead class="slds-text-title_caps ">
              <tr class="">
                <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d50031e34">Field</th>
                <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d50031e36">Description</th>
              </tr>
            </thead>
            <tbody>
              <tr class="">
                <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e34 ">commaSeparatedOauthScopes</td>
                <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e36 ">This field is required. Type: String. The permissions given by the user
                  running the external client app.</td>
              </tr>
              <tr class="">
                <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e34 ">customAttribute</td>
                <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e36 ">This field is optional. Type: String. The additional configured attributes
                  to be included as developer defaults. The maximum number accepted is 128. Each
                  custom attribute must have a unique key and must use an available field. For
                  example, assign a key name, such as <kbd>country</kbd>, and insert
                  the field
                  $<kbd>Organization</kbd>.<kbd>Country</kbd>.</td>
              </tr>
              <tr class="">
                <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e34 ">externalClientApplication</td>
                <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e36 ">This field is required. Type: String. The name of the external client
                  application header in which these OAuth settings exist.</td>
              </tr>
              <tr class="">
                <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e34 ">label</td>
                <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e36 ">This field is required. Type: String. A name for the external client app
                  OAuth settings file.</td>
              </tr>
              <tr class="">
                <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e34 ">oauthLink</td>
                <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e36 ">This field is optional. Type: String. Auto-generated unique identifier.
                  This identifier consists of [Organization_ID]:[Oauth_Consumer_ID].</td>
              </tr>
              <tr class="">
                <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e34 ">trustedIpRanges</td>
                <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d50031e36 ">
                  <p>This field is optional. Specifies the ranges of IP addresses that can
                    access the app without requiring the user to authenticate with the external
                    client app. The maximum number of IP ranges is 128. This configuration includes
                    these attributes</p>
                  <ul>
                    <li><code>startIpAddress—</code>This field is required
                      when setting trustedIpRanges. Type: IP Address. The first address in the IP
                      range, inclusive. Required with end address.</li>
                    <li><code>endIpAddress—</code>This field is required
                      when setting trustedIpRanges. Type: IP Address. The last address in the IP
                      range, inclusive. Required with start address.</li>
                    <li><code>description—</code>This field is optional.
                      Type: String. A description of the IP range.</li>
                  </ul>
                </td>
              </tr>
            </tbody>
          </table>This example shows an OAuth settings file.
    
    ```markup
    <?xml version="1.0" encoding="UTF-8"?>
    <ExtlClntAppOauthSettings xmlns="http://soap.sforce.com/2006/04/metadata">
        <externalClientApplication>myeca</externalClientApplication>
        <label>My Oauth Settings</label>
        <trustedIpRanges>
            <startIpAddress>10.55.2.0</startIpAddress>
            <endIpAddress>10.55.2.255</endIpAddress>
            <description>Building 6</description>
        </trustedIpRanges>
        <trustedIpRanges>
            <startIpAddress>10.55.12.0</startIpAddress>
            <endIpAddress>10.55.12.255</endIpAddress>
        </trustedIpRanges>
        <customAttributes>
            <key>userattribute</key>
            <formula>$User.Country</formula>
        </customAttributes>
        <commaSeparatedOauthScopes>Basic, Web</commaSeparatedOauthScopes>
    </ExtlClntAppOauthSettings>
    ```