ExtlClntAppOauthSettings | Metadata API Developer Guide

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ExtlClntAppOauthSettings components have the suffix .ecaOauth and are stored in the extlClntAppOauthSettings folder.

Version

ExtlClntAppOauthSettings components are available in API version 59.0 and later.

Special Access Rules

Access to the OAuth plugin requires orgs to enable the Allow Access to OAuth Consumer Secrets via Metadata API permission in Setup. The View External Client Apps Consumer Secrets in Metadata user permission is required for users with developer roles to configure OAuth settings.

Fields

Field Name	Description
commaSeparatedOauthScopes	Field Type string Description OAuth scopes for the external client app, written as a comma-separated list.
customAttributes	Field Type ExtlClntAppOauthSettingsAttribute[] Description Unique attributes to be included as developer defaults. The maximum number accepted is 128. Each custom attribute must have a unique key and use an available field.
externalClientApplication	Field Type string Description Required. The external client app associated with this OAuth plugin.
label	Field Type string Description Label for the external client app.
oauthLink	Field Type string Description An auto-generated value that combines the org ID and the OAuth Consumer ID.
singleLogoutUrl	Field Type string Description URL where Salesforce sends a logout request when users log out of Salesforce.
trustedIpRanges	Field Type ExtlClntAppOauthIpRange[] Description 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.

ExtlClntAppOauthSettingsAttribute

Represents developer-defined attributes that are used to include additional information in the external client apps. Developers use these attributes to customize the app for specific use cases.

Field Name	Description
formula	Field Type string Description Required. The existing field that includes the desired information. For example, `Organization.Country`.
key	Field Type string Description Required. A unique name for the attribute. For example, `country`.

ExtlClntAppOauthIpRange

Represents the range of IP addresses that are trusted by the external client app.

Field Name	Description
description	Field Type string Description Identifies the purpose of the range, such as which part of a network corresponds to this range.
endIpAddress	Field Type string Description Required. Last address in the IP range, inclusive. Required with start address.
startIpAddress	Field Type string Description Required. First address in the IP range, inclusive. Required with end address.

Declarative Metadata Sample Definition

The following is an example of an ExtlClntAppOauthSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ExtlClntAppOauthSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <externalClientApplication>myeca</externalClientApplication>
4    <label>My Oauth Settings</label>
5    <trustedIpRanges>
6        <startIpAddress>10.55.2.0</startIpAddress>
7        <endIpAddress>10.55.2.255</endIpAddress>
8        <description>Building 6</description>
9    </trustedIpRanges>
10    <trustedIpRanges>
11        <startIpAddress>10.55.12.0</startIpAddress>
12        <endIpAddress>10.55.12.255</endIpAddress>
13    </trustedIpRanges>
14    <customAttributes>
15        <key>userattribute</key>
16        <formula>User.Country</formula>
17    </customAttributes>
18    <commaSeparatedOauthScopes>Basic, Web</commaSeparatedOauthScopes>
19</ExtlClntAppOauthSettings>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>ExternalClientApplication</name>
6    </types>
7    <types>
8        <members>*</members>
9        <name>ExtlClntAppOauthSettings</name>
10    </types>
11    <types>
12        <members>*</members>
13        <name>ExtlClntAppGlobalOauthSettings</name>
14    </types>
15    <types>
16        <members>*</members>
17        <name>ExtlClntAppOauthConfigurablePolicies</name>
18    </types>
19    <version>59.0</version>
20</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.