ExtlClntAppConfigurablePolicies

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

This type extends Metadata and inherits its fields.

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

Introduced in API version 60.0.

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.

• Type: string

• Required: Yes

• Description: Required.

  The name of the external client app associated with the plugins.

• Type: boolean
• Required: No
• Introduced: API version 66.0
• Description: If true, the Canvas app plugin is enabled. If false, the Canvas app plugin is disabled. The default value is true.

• Type: boolean
• Required: Yes
• Description: Required.

• Type: boolean
• Required: No
• Introduced: API version 63.0
• Description: If true, the Mobile plugin is enabled. If false, the Mobile plugin is disabled. The default value is true.

• Type: boolean
• Required: No
• Introduced: API version 63.0
• Description: If true, the Notification plugin is enabled. If false, the Notification plugin is disabled. The default value is true.

• Type: boolean
• Required: No
• Introduced: API version 60.0
• Description: If true, the OAuth plugin is enabled. If false, the OAuth plugin is disabled. The default value is true.

• Type: boolean
• Required: No
• Introduced: API version 63.0
• Description: If true, the Push Notification plugin is enabled. If false, the Push Notification plugin is disabled. The default value is true.

• Type: boolean
• Required: No
• Introduced: API version 63.0
• Description: If true, the SAML plugin is enabled. If false, the SAML plugin is disabled. The default value is true.

• Type: string
• Required: No
• Description: The OAuth policies name for the external client app.

• Type: ExtlClntAppStartPage (enumeration of type string)

• Required: No

• Description: Determines which URL to use for the start page.

  • Custom
  • None
  • OAuth

  Available in API version 63.0 and later.

• Type: string
• Required: No
• Introduced: API version 63.0
• Description: The custom URL where users are directed after they authenticate. For example, direct users to a specific page in the service provider app.

This example shows an ExtlClntAppConfigurablePolicies component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ExtlClntAppConfigurablePolicies xmlns="http://soap.sforce.com/2006/04/metadata">
3    <externalClientApplication>myeca</externalClientApplication>
4    <isEnabled>true</isEnabled>
5....<isCanvasPluginEnabled>true</isCanvasPluginEnabled>
6    <isMobilePluginEnabled>true</isMobilePluginEnabled>
7    <isNotificationPluginEnabled>true</isNotificationPluginEnabled>    
8    <isOauthPluginEnabled>true</isOauthPluginEnabled>
9    <isPushPluginEnabled>true</isPushPluginEnabled>
10    <isSamlPluginEnabled>true</isSamlPluginEnabled>
11    <label>myecapolicy</label>
12    <startPage>OAuth</startPage>
13    <startUrl>https://example.org</startUrl>
14</ExtlClntAppConfigurablePolicies>

This example package.xml 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    <types>
20        <members>*</members>
21        <name>ExtlClntAppConfigurablePolicies</name>
22    </types>
23    <version>60.0</version>
24</Package>

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.