PrivacySettings

Represents an organization’s settings for data privacy and consent management.

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

This type extends Metadata and inherits its fields.

PrivacySettings values are stored in the Privacy.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Introduced in API version 47.0.

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

• Type: boolean
• Required: No
• Introduced: API version 59.0
• Description: Indicates whether browser information is captured during authorization consent capture (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Introduced: API version 59.0
• Description: Indicates whether email address is captured during authorization consent capture (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Introduced: API version 59.0
• Description: Indicates whether IP address is captured during authorization consent capture (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Introduced: API version 59.0
• Description: Indicates whether location information is captured during authorization consent capture (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Introduced: API version 59.0
• Description: Indicates whether custom sharing is enabled for authorization consent records (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Introduced: API version 62.0
• Description: Indicates whether custom sharing for authorization consent records uses permission-based access control (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Introduced: API version 59.0
• Description: Indicates whether locking and versioning is enabled for authorization consent records (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Introduced: API version 59.0
• Description: Indicates whether configurable user PII (Personally Identifiable Information) classification is active (true) or not (false). The default value is false.

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

• Type: boolean
• Required: No
• Introduced: API version 47.0
• Description: Allows orgs to stream consent changes to the party data model via platform events. This field has a default value of false.

• Type: boolean
• Required: No
• Introduced: API version 47.0
• Description: 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.

• Type: boolean
• Required: No

• Type: boolean
• Required: No

• Type: boolean
• Required: No

• Type: boolean
• Required: No

• Type: boolean
• Required: No

• Type: boolean
• Required: No
• Introduced: API version 61.0
• Description: Indicates whether Salesforce Archive is enabled for privacy-related data archival (true) or not (false). The default value is false.

• Type: string
• Required: No

• Type: boolean
• Required: No
• Introduced: API version 58.0
• Description: Indicates whether a Preference Manager setup in Privacy Center uses default Marketing Cloud consent parameters and features. This field has a default value of false.

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>

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.