EncryptionKeySettings

Represents an org’s encryption key settings, such as customer-supplied keys options and key derivation settings. 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

EncryptionKeySettings values are stored in the EncryptionKey.settings file in the settings folder. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

EncryptionKeySettings is available in API versions 47.0 and later.

Special Access Rules

To enable EncryptionKeySettings, you need the Customize Application and Manage Encryption Keys permissions.

Fields

Field Name	Field Type	Description
enableCacheOnlyKeys	boolean	Indicates whether the Cache-Only Key Service is available (`true`) or not (`false`). The default value is `false`. If set to `true`, users can configure a cache-only key callout connection and apply key material stored outside of Salesforce to data on demand.
canOptOutOfDerivationWithBYOK	boolean	Indicates that users can opt out of key derivation processes on a key-by-key basis when they upload key material (`true`) or can’t (`false`). The default value is `false`.
enableReplayDetection	boolean	Indicates whether cache-only key callouts are protected from replay attacks by a nonce (`true`) or not (`false`). Requires `enableCacheOnlyKeys=”true”` before setting enableReplayDetection to `true`.

Declarative Metadata Sample Definition

The following is an example of the EncryptionKey.settings file:

1<?xml version="1.0" encoding="UTF-8"?>
2<EncryptionKeySettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableCacheOnlyKeys>true</enableCacheOnlyKeys>
4    <enableReplayDetection>true</enableReplayDetection>
5    <canOptOutOfDerivationWithBYOK>true</canOptOutOfDerivationWithBYOK>
6</EncryptionKeySettings>

Example Package Manifest

The following is an example package manifest used to deploy or retrieve the encryption key settings metadata for an organization:

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>EncryptionKeys</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