Metadata API Developer Guide
jNewer Version Available
ConnectedAppSettings
Represents settings for connected apps.
This type extends the Metadata
metadata type and inherits its fullName field.
File Suffix and Directory Location
ConnectedAppSettings values are
stored in a single file named ConnectedApp.settings in the
settings directory. The .settings files are
different from other named components because there is only one settings file for each
settings component.
Version
ConnectedAppSettings components are available in API version 47.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| enableAdminApprovedAppsOnly | boolean | If false (default), any connected app can call the Salesforce API. If true, only apps that have been approved or installed by the admin can call the Salesforce API. |
| enableSkipUserProvisioningWizardWelcomePage | boolean | If false (default), the User Provisioning Wizard Welcome page shows up when you access the wizard. To skip the welcome page in the future, you can select Do not show me this next time. If true, the Welcome page doesn’t show up the next time that you access the wizard. |
Declarative Metadata Sample Definition
The following is an example of a ConnectedAppSettings component.
1<?xml version="1.0" encoding="UTF-8"?>
2<ConnectedAppSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <enableAdminApprovedAppsOnly>false</enableAdminApprovedAppsOnly>
4 <enableSkipUserProvisioningWizardWelcomePage>true</enableSkipUserProvisioningWizardWelcomePage>
5</ConnectedAppSettings>The following is an example package.xml manifest 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>ConnectedApps</members>
5 <name>Settings</name>
6 </types>
7 <version>47.0</version>
8</Package>