メタデータ API 開発者ガイド
jPlatformEncryptionSettings
使用可能な暗号化スキーム、権限、暗号化ポリシーアクセス、暗号化可能な項目の設定など、組織のプラットフォームの暗号化設定を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
パッケージマニフェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
PlatformEncryptionSettings の値は、settings フォルダの PlatformEncryption.settings ファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
PlatformEncryptionSettings は、API バージョン 47.0 以降で使用できます。
特別なアクセスルール
PlatformEncryptionSettings 属性を有効または無効にするには、「アプリケーションのカスタマイズ」権限が必要です。鍵の管理タスクを許可する属性には、「暗号化鍵の管理」権限が必要です。必要な権限の完全なリストは、「Shield Platform Encryption に必要なユーザ権限」を参照してください。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| canEncryptManagedPackageFields | boolean | インストール済み管理パッケージのカスタム項目に対する暗号化をユーザが有効にできるか (true)、否か (false) を示します。 |
| isUseHighAssuranceKeysRequired | boolean | 鍵の管理アクションに 2 つ目の認証方法が必要か (true)、否か (false) を示します。2 つ目の認証方法は、Salesforce Authenticator、Yubikey、その他の時間ベースのワンタイムパスワードなどのアプリケーションです。デフォルト値は false です。 |
| isMEKForEncryptionRequired | boolean | 項目に対する暗号化の有効化などの暗号化ポリシータスクで、それらのタスクのベースラインの権限に加えて「暗号化鍵の管理」権限も必要か (true)、否か (false) を示します。 |
| enableDeterministEncryption | boolean | サポートされる項目に顧客が確定的暗号化スキームを適用するか (true)、否か (false) を示します。確定的暗号化スキームでは、顧客が暗号化データを絞り込むことができます。 |
| enableEncryptFieldHistory | boolean | バックグラウンド暗号化プロセスで、項目履歴およびフィード追跡の値に顧客の有効な鍵素材を適用するか (true)、否か (false) を示します。デフォルト値は false です。false の場合、バックグラウンド暗号化プロセスは、項目履歴またはフィード追跡に保存されたデータの重複を除くすべての暗号化データに有効な鍵素材を適用します。 |
| enableEventBusEncryption | boolean | 行動がイベントバスでの保存時に暗号化されるか (true)、否か (false) を示します。この行動には、変更データキャプチャイベントとプラットフォームイベントがあります。デフォルト値は false です。false の場合、行動は暗号化されず、イベントバスにクリアテキストで保存されます。 |
宣言的なメタデータの定義のサンプル
次に、PlatformEncryption.settings ファイルの例を示します。
1<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2<PlatformEncryptionSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <canEncryptManagedPackageFields>true</canEncryptManagedPackageFields>
4 <isUseHighAssuranceKeysRequired>true</isUseHighAssuranceKeysRequired>
5 <isMEKForEncryptionRequired>true</isMEKForEncryptionRequired>
6 <enableDeterministEncryption>true</enableDeterministEncryption>
7 <enableEncryptFieldHistory>true</enableEncryptFieldHistory>
8 <enableEventBusEncryption>true</enableEventBusEncryption>
9</PlatformEncryptionSettings>パッケージマニフェストの例
組織の [プラットフォームの暗号化] 設定メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>PlatformEncryption</members>
5 <name>Settings</name>
6 </types>
7 <version>47.0</version>
8</Package>マニフェストファイル内のワイルドカードのサポート
package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。