ExternalClientApplication | Metadata API Developer Guide

Parent Type

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

File Suffix and Directory Location

ExternalClientApplication components have the suffix .eca and are stored in the externalClientApps folder.

Version

ExternalClientApplication components are available in API version 59.0 and later.

Special Access Rules

Access to the ExternalClientApplication type requires orgs to enable the Opt in to External Client Apps permission in Setup.

Fields

Field Name	Description
contactEmail	Field Type string Description The email address that Salesforce uses to contact the external client app admin for the subscriber org.
contactPhone	Field Type string Description The phone number that Salesforce uses to contact the external client app admin for the subscriber org.
description	Field Type string Description A description for the app.
distributionState	Field Type ExtlClntAppDistState (enumeration of type string) Description The distribution state of an external client app. Values are: `Local` `Packaged`
iconUrl	Field Type string Description The URL for the icon image.
infoUrl	Field Type string Description Reserved for future use.
isProtected	Field Type boolean Description A package construct that developers use to control the visibility of components in subscriber orgs. Default is false.
label	Field Type string Description The label for the external client app.
logoUrl	Field Type string Description The URL for the logo image.
orgScopedExternalApp	Field Type string Description A unique ID consisting of the org ID and the name of this external client app. Either defined by the developer or auto-generated during the first deployment. Expected value uses this format: `[Organization_ID]`:`[External Client App Name]`.

Declarative Metadata Sample Definition

The following is an example of an ExternalClientApplication component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ExternalClientApplication xmlns="http://soap.sforce.com/2006/04/metadata">
3    <contactEmail>johndoe@example.com</contactEmail>
4    <description>Test external client app</description>
5    <distributionState>Local</distributionState>
6    <iconUrl>https://icon.example.com</iconUrl>
7    <infoUrl>https://info.example.com</infoUrl>
8    <logoUrl>https://logo.example.com</logoUrl>
9    <label>myeca</label>
10    <isProtected>false</isProtected>
11    <orgScopedExternalApp>Org_ID:External_Client_App_Name</orgScopedExternalApp> 
12</ExternalClientApplication>

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.