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.

   Field	Description
   commaSeparatedOauthScopes	This field is required. Type: String. The permissions given by the user running the external client app.
   customAttribute	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 country, and insert the field $Organization.Country.
   externalClientApplication	This field is required. Type: String. The name of the external client application header in which these OAuth settings exist.
   label	This field is required. Type: String. A name for the external client app OAuth settings file.
   oauthLink	This field is optional. Type: String. Auto-generated unique identifier. This identifier consists of [Organization_ID]:[Oauth_Consumer_ID].
   trustedIpRanges	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 startIpAddress—This field is required when setting trustedIpRanges. Type: IP Address. The first address in the IP range, inclusive. Required with end address. endIpAddress—This field is required when setting trustedIpRanges. Type: IP Address. The last address in the IP range, inclusive. Required with start address. description—This field is optional. Type: String. A description of the IP range.

   This example shows an OAuth settings file.

   <?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>