ExtlClntAppConfigurablePolicies

Represents the policies for an external client app to disable or enable plugins.

Parent Type

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

File Suffix and Directory Location

ExtlClntAppConfigurablePolicies components have the suffix .ecaPlcy and are stored in the extlClntAppPolicies folder.

Version

ExtlClntAppConfigurablePolicies components are available in API version 60.0 and later.

Special Access Rules

The View all External Client Apps, view their settings, and edit their policies user permission is required for users with admin roles to configure OAuth policies.

Fields

Field Name Description
externalClientApplication
Field Type
string
Description

Required.

The name of the external client app associated with the OAuth plugins.
isEnabled
Field Type
boolean
Description

Required.

If true, all plugins are enabled unless individually disabled. If false, all plugins are disabled. The default value is true. Available in API version 60.0 and later.
isOauthPluginEnabled
Field Type
boolean
Description
If true, the OAuth plugin is enabled. If false the OAuth plugin is disabled. The default value is true. Available in API version 60.0 and later.
label
Field Type
string
Description
The OAuth policies name for the external client app.

Declarative Metadata Sample Definition

This example shows an ExtlClntAppConfigurablePolicies component.

<?xml version="1.0" encoding="UTF-8"?>
<ExtlClntAppConfigurablePolicies xmlns="http://soap.sforce.com/2006/04/metadata">
    <externalClientApplication>myeca</externalClientApplication>
    <isEnabled>true</isEnabled>    
    <isOauthPluginEnabled>true</isOauthPluginEnabled>
    <label>myecapolicy</label>
</ExtlClntAppConfigurablePolicies>

This example package.xml references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>*</members>
        <name>ExternalClientApplication</name>
    </types>
    <types>
        <members>*</members>
        <name>ExtlClntAppOauthSettings</name>
    </types>
    <types>
        <members>*</members>
        <name>ExtlClntAppGlobalOauthSettings</name>
    </types>
    <types>
        <members>*</members>
        <name>ExtlClntAppOauthConfigurablePolicies</name>
    </types>
    <types>
        <members>*</members>
        <name>ExtlClntAppConfigurablePolicies</name>
    </types>
    <version>60.0</version>
</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.