PrivacySettings

Represents an organization’s settings for data privacy and consent management. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

PrivacySettings values are stored in the Privacy.settings file 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

PrivacySettings components are available in API version 47.0 and later.

Special Access Rules

To use PrivacySettings, you need the Customize Application or Modify Data Classification user permission.

Fields

Field Name	Field Type	Description
enableConsentAuditTrail	boolean	Reserved for future use.
enableConsentEventStream	boolean	Reserved for future use.
enableDefaultMetadataValues	boolean	Indicates whether a default data sensitivity value is applied to all contacts, leads, person accounts, and users (`true`) or not (`false`). This field has a default value of `false`. Available in API version 47.0 and later.

Declarative Metadata Sample Definition

The following is an example of a PrivacySettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<PrivacySettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableDefaultMetadataValues>false</enableDefaultMetadataValues>
4</PrivacySettings>

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>Privacy</members>
5        <name>Settings</name>
6    </types>
7    <version>47.0</version>
8</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide