Metadata API Developer Guide
jNewer Version Available
ExternalClientAppSettings
Parent Type and Manifest Access
This type extends the Metadata metadata type and inherits its fullName field.
In the package manifest, all the settings metadata types are accessed using the Settings name. See Settings for more details.
File Suffix and Directory Location
ExternalClientAppSettings values are stored in the .settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.
Version
ExternalClientAppSettings components are available in API version 58.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| enableClientSecretInRestApiAccess | boolean | Indicates whether OAuth consumer secrets can be accessed through the credentials REST API (true) or not (false). This field is available in API version 62.0 and later. |
| enableConsumerSecretApiAccess | boolean | DEPRECATED. Indicates whether OAuth consumer secrets can be accessed through
Metadata API (true) or not (false). Use the external client app OAuth UI to access consumer secrets. |
| enablePackageEcaOauthFromDevOrg | boolean | Indicates whether you can package an external client app that is owned by an org, that isn't a Dev Hub org, (true) or not (false). It’s recommended that you only package OAuth-enabled external client apps that are owned by a Dev Hub org. This practice maintains the integrity of the OAuth client credentials by storing them on an org that won't be deleted. If you have other ways to maintain the OAuth client credentials, you can enable this field and package an external client app form a different type of org. External client apps built on ephemeral orgs, like Scratch orgs or sandboxes, can't be packaged even with this field set to true. This field is available in API version 62.0 and later. |
Declarative Metadata Sample Definition
The example shows a settings file component.
1<?xml version="1.0" encoding="UTF-8"?>
2<ExternalClientAppSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <enableClientSecretInRestApiAccess>true</enableClientSecretInRestApiAccess>
4 <enableConsumerSecretApiAccess>true</enableConsumerSecretApiAccess>
5 <enablePackageEcaOauthFromDevOrg>false</enablePackageEcaOauthFromDevOrg>
6</ExternalClientAppSettings>Wildcard Support in the Manifest File
The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.