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

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

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

TransactionSecurityPolicy コンポーネントのサフィックスは .transactionSecurityPolicy で、transactionSecurityPolicies フォルダに保存されます。

バージョン

TransactionSecurityPolicy コンポーネントは、API バージョン 35.0 以降で使用できます。

項目

項目名	項目の型	説明
action	TransactionSecurityAction	必須。一致するトランザクションセキュリティポリシーがトリガされた場合に実行するアクションを記述します。
active	boolean	必須。`true` の場合、ポリシーが有効になり、イベントを積極的に監視します。
apexClass	string	Apex ベースのポリシーでは必須、その他のすべてのポリシーでは省略可能。このポリシーの `TxnSecurity.PolicyCondition` インターフェースを実装するクラスの名前。API バージョン 46.0 以降で利用できます。
description	string	ポリシーの説明。
developerName	string	一意の名前を使用して、同じ masterLabel を持つ他のポリシーとの競合を回避します。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
eventName	TransactionSecurityEventName (string 型の列挙)	拡張トランザクションセキュリティ (ベータ) のパイロットでのみ使用されます。ポリシーが監視するイベントの名前を示します。この項目は API 45.0 以降で使用できます。有効な値は、次のとおりです。 `AdminSetupEvent` — 組織の暗号化鍵の管理に関するユーザ操作を追跡します。 `ApiEvent` — 組織内のユーザ API コールを追跡します。 `LoginEvent` — 組織内の追跡可能なユーザログインイベントを表します。 `ListViewEvent` — ユーザがいつ組織のリストビューを操作したのかを追跡します。 `ReportEvent` — 組織内でいつレポートが実行されたかを追跡します。
eventType	MonitoredEvents (string 型の列挙)	Apex ベースのポリシーでは必須、その他のすべてのポリシーでは省略可能。監視中のイベントのタイプを示します。有効な値は、次のとおりです。 `AccessResource` — 選択したリソースへのアクセスがあった場合に通知します。 `AuditTrail` — 今後の使用のために予約されています。 `DataExport` — データローダ API クライアントを使用して、選択したオブジェクト種別がエクスポートされた場合に通知します。 `Entity` — 認証プロバイダや Chatter コメントなどのオブジェクト種別を使用した場合に通知します。 `Login` — ユーザがログインした場合に通知します。
executionUser	string	`CustomApexPolicy` 種別のポリシーでは必須。通知が選択されている場合、ポリシーがトリガされたときに通知するユーザの名前。このユーザには「すべてのデータの編集」および「設定の参照」権限が必要です。
フロー	string	`CustomConditionBuilderPolicy` 種別のポリシーでのみ必須。条件ビルダーの��ランザクションセキュリティポリシーのロジックが含まれるフローオブジェクトの ID。API バージョン 46.0 以降で利用できます。
masterLabel	string	このオブジェクトのマスタ表示ラベル。この表示値は、翻訳されない内部ラベルです。
resourceName	string	Apex ベースのポリシーでは必須、その他のすべてのポリシーでは省略可能。ポリシーのトリガ条件を絞り込むために使用されるリソース。たとえば、`DataExport` イベントでリソース Lead を選択すると、リードエンティティで発生するエクスポート活動のみを監視できます。使用可能なリソースは、[イベントの種別] 項目によって異なります。有効なリソースは、次のようにイベント種別でグループ化されます。 AccessResource — ConnectedApplication、Reports DataExport — Account、Case、Contact、Lead、Opportunity Entity — AuthProvider、ChatterMessage、FeedComment、FeedItem、Idea、Question Login—LoginHistory
type	TxnSecurityPolicyType (string 型の列挙)	ポリシーが使用する検証の種別。有効な値は次のとおりです。 `CustomApexPolicy` — Apex エディタで作成されました。 `CustomConditionBuilderPolicy` — 条件ビルダーで作成されました。デフォルト値は `CustomApexPolicy` です。

TransactionSecurityAction

一致するトランザクションセキュリティポリシーがトリガされた場合に実行するアクションを記述します。

項目名	項目の型	説明
block	boolean	必須。`true` の場合、要求された操作はブロックされます。このアクションは、Login イベントと AccessResource イベントにのみ適用されます。
endSession	boolean	必須。`true` の場合、新しいセッションを開始するには、現在のセッションを閉じる必要があります。このアクションは、Login イベントにのみ適用されます。
freezeUser	boolean	必須。`true` の場合、ポリシーをトリガしたユーザは凍結されます。このアクションは、エンティティイベントの Chatter リソースにのみ適用されます。
notifications	TransactionSecurityNotification[]	アクションがトリガされた場合のシステム管理者への通知方法を指定します。通知しないか、1 つまたは複数の通知を行うことができます。
twoFactorAuthentication	boolean	必須。`true` の場合、要求された操作を続行するには、高いアクセスレベルに対して 2 要素認証が必要です。このアクションは、Login イベントと AccessResource イベントにのみ適用されます。

TransactionSecurityNotification

一致するトランザクションセキュリティポリシーがトリガされた場合に、通知するユーザとその方法を記述します。

項目名	項目の型	説明
inApp	boolean	アプリケーション内通知が選択されている場合は true。
sendEmail	boolean	メール通知が選択されている場合は true。
user	string	通知を受信するシステム管理者。このユーザには「すべてのデータの編集」および「設定の参照」権限が必要です。

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

TransactionSecurityPolicy コンポーネントの例を次に示します。

組織のトランザクションセキュリティメタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。

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

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。