この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

EncryptionKeySettings

顧客が指定した鍵のオプションや鍵派生設定など、組織の暗号化鍵設定を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

パッケージマニフェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は、「設定」を参照してください。

ファイルのサフィックスおよびディレクトリの場所

EncryptionKeySettings の値は、settings フォルダの EncryptionKey.settings ファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

バージョン

EncryptionKeySettings は、API バージョン 47.0 以降で使用できます。

特別なアクセスルール

EncryptionKeySettings を有効化するには、「アプリケーションのカスタマイズ」および「暗号化鍵の管理」権限が必要です。

項目

項目名	項目の型	説明
enableCacheOnlyKeys	boolean	キャッシュのみの鍵サービスが有効か (`true`)、否か (`false`) を示します。デフォルト値は `false` です。`true` に設定すると、ユーザはキャッシュのみの鍵のコールアウト接続を設定し、必要に応じて Salesforce の外部に保存された鍵素材をデータに��用できます。
canOptOutOfDerivationWithBYOK	boolean	ユーザが鍵素材をアップロードするときに鍵ごとに鍵派生プロセスを除外できるか (`true`)、否か (`false`) を示します。デフォルト値は `false` です。
enableReplayDetection	boolean	キャッシュのみの鍵のコールアウトを nonce によってリプレイ攻撃から保護するか (`true`)、否か (`false`) を示します。enableReplayDetection を `true` に設定する前に `enableCacheOnlyKeys=”true”` が必要です。

宣言的なメタデータの定義のサンプル

EncryptionKey.settings ファイルの例を次に示します。

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>

パッケージマニフェストの例

組織の暗号化鍵設定メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>EncryptionKey</members>
5        <name>Settings</name>
6    </types>
7    <version>47.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド