ExternalClientApplication

Represents the header file for an external client application configuration.

This type extends Metadata and inherits its fields.

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

Introduced in API version 59.0.

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

• Type: string
• Required: No
• Description: The email address that Salesforce uses to contact the external client app admin for the subscriber org.

• Type: string
• Required: No
• Description: The phone number that Salesforce uses to contact the external client app admin for the subscriber org.

• Type: string
• Required: No
• Description: A description for the app.

• Type: ExtlClntAppDistState (enumeration of type string)

• Required: No

• Description: The distribution state of an external client app.

  Values are:

• Possible values:

  • AutoInstalled — . For internal use only.
  • Local — .
  • Managed — . For internal use only.
  • Packaged — .

• Type: string
• Required: No
• Description: The URL for the icon image.

• Type: string
• Required: No
• Description: Reserved for future use.

• Type: boolean
• Required: No
• Description: A package construct that developers use to control the visibility of components in subscriber orgs. Default is false.

• Type: string
• Required: No
• Description: The label for the external client app.

• Type: string
• Required: No
• Description: The URL for the logo image.

• Type: ExtlClntAppManagedType (enumeration of type string)
• Required: No
• Description: For internal use only.

• Type: string
• Required: No
• 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. The expected value uses this format: [Organization_ID]:[External Client App Name].

This example shows 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>

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.