ExternalClientAppSettings

Represents settings to enable the External Client App feature and provide access to the OAuth consumer secret.

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
enableConsumerSecretApiAccess	boolean	Indicates whether OAuth consumer secrets can be accessed (`true`) or not (`false`). When enabled, you can create external client apps that use OAuth.
enableExternalClientApps	boolean	Indicates whether you opted in to the External Client App feature (`true`) or not (`false`). When enabled, you can configure and deploy external client apps.

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        <enableConsumerSecretApiAccess>true</enableConsumerSecretApiAccess>
4        <enableExternalClientApps>true</enableExternalClientApps>
5</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.

Metadata API Developer Guide