Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
ExternalClientApplication
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 |
|
| contactPhone |
|
| description |
|
| distributionState |
|
| iconUrl |
|
| infoUrl |
|
| isProtected |
|
| label |
|
| logoUrl |
|
| managedType |
|
| orgScopedExternalApp |
|
Declarative Metadata Sample Definition
This example shows an ExternalClientApplication component.
<?xml version="1.0" encoding="UTF-8"?>
<ExternalClientApplication xmlns="http://soap.sforce.com/2006/04/metadata">
<contactEmail>johndoe@example.com</contactEmail>
<description>Test external client app</description>
<distributionState>Local</distributionState>
<iconUrl>https://icon.example.com</iconUrl>
<infoUrl>https://info.example.com</infoUrl>
<logoUrl>https://logo.example.com</logoUrl>
<label>myeca</label>
<isProtected>false</isProtected>
<orgScopedExternalApp>Org_ID:External_Client_App_Name</orgScopedExternalApp>
</ExternalClientApplication>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.