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

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

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

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

バージョン

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

項目

項目名	項目の型	説明
action	TransactionSecurityAction	必須。一致するトランザクションセキュリティポリシーがトリガされた場合に実行するアクションを記述します。
active	boolean	必須。`true` の場合、ポリシーが有効になり、イベントを積極的に監視します。
apexClass	string	Apex ベースのポリシーでは必須、その他のすべてのポリシーでは省略可能。このポリシーの `TxnSecurity.PolicyCondition` または `TxnSecurity.EventCondition` インターフェースを実装するクラスの名前。API バージョン 46.0 以降で利用できます。
blockMessage	string	アクションがポリシーによってブロックされたときにユーザが受け取るカスタムメッセージ。リアルタイムイベント監視でのみ使用されます。最大 1000 文字です。この項目は、デフォルトのメッセージオプションが選択されている場合 null として表示されます。この項目が使用可能になるのは、eventName が `ApiEvent`、`ListViewEvent`、または `ReportEvent` に設定されている場合のみです。API バージョン 49.0 以降で利用できます。
description	string	ポリシーの説明。
developerName	string	一意の名前を使用して、同じ masterLabel を持つ他のポリシーとの競合を回避します。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
eventName	TransactionSecurityEventName (string 型の列挙)	リアルタイムイベント監視でのみ使用されます。ポリシーが監視するイベントの名前を示します。この項目は API 45.0 以降で使用できます。有効な値は、次のとおりです。 `ApiEvent` — `query()`、`queryMore()`、および `count()` のユーザが開始した読み取り専用 API 呼び出しを追跡します。Enterprise WSDL および Partner WSDL の場合、SOAP API、REST API、および Bulk API によって API 要求を捕捉します。Salesforce モバイルアプリケーションから開始された Tooling API コールおよび API コールは捕捉されません。 `CredentialStuffingEventStore` — 識別済みのログイン情報スタッフィング攻撃中にユーザが正常に Salesforce にログインした場合を追跡します。ログイン情報スタッフィングとは、盗まれたユーザログイン情報を使用した大規模な自動ログイン要求を指します。この値は API バージョン 49.0 以降で使用できます。 `ListViewEvent` — Lightning Experience、Salesforce Classic、または API を使用して、いつユーザがリストビューでデータにアクセスしたかを追跡します。設定エンティティのリストビューは追跡されません。 `LoginEvent` — Salesforce にログインしたユーザのログイン活動を LoginEvent で追跡します。 `ReportAnomalyEventStore` — ユーザによるレポートの実行またはエクスポートの異常を追跡します (未保存のレポートを含む)。この値は API バージョン 49.0 以降で使用できます。 `ReportEvent` — 組織内でいつレポートが実行されたかを追跡します。 `SessionHijackingEventStore` — 未承認ユーザが、盗まれたセッション識別子を使用して Salesforce ユーザのセッションの所有権を取得した場合を追跡します。このようなイベントを検出するために、Salesforce は、確率的に推測された有意な変化を使用して、ユーザの現在のブラウザフィンガープリントが以前の既知のフィンガープリントからどの程度有意に異なるかを評価します。この値は API バージョン 49.0 以降で使用できます。
eventType	MonitoredEvents (string 型の列挙)	従来のトランザクションセキュリティでのみ使用されます。Apex ベースのポリシーでは必須、その他のすべてのポリシーでは省略可能。監視中のイベントのタイプを示します。有効な値は、次のとおりです。 `AccessResource` — 選択したリソースへのアクセスがあった場合に通知します。 `AuditTrail` — 今後の使用のために予約されています。 `DataExport` — データローダ API クライアントを使用して、選択したオブジェクト種別がエクスポートされた場合に通知します。 `Entity` — 認証プロバイダや Chatter コメントなどのオブジェクト種別を使用した場合に通知します。 `Login` — ユーザがログインした場合に通知します。
executionUser	string	従来のトランザクションセキュリティでのみ使用されます。「すべてのデータの編集」および「設定の参照」ユーザ権限が割り当てられている有効ユーザの名前または ID。
flow	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 コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<TransactionSecurityPolicy xmlns="http://soap.sforce.com/2006/04/metadata">
3    <action>
4        <block>true</block>
5        <notifications>
6            <inApp>true</inApp>
7            <sendEmail>true</sendEmail>
8            <user>user@your.org</user>
9        </notifications>
10        <twoFactorAuthentication>false</twoFactorAuthentication>
11    </action>
12    <active>true</active>
13    <apexClass>TxnSecMDApiPolicyEventCondition</apexClass>
14    <blockMessage>You cannot view this report.</blockMessage>
15    <developerName>TxnSecPolicyMDApi</developerName>
16    <eventName>ReportEvent</eventName>
17    <masterLabel>Txn Sec MD Api Policy</masterLabel>
18    <type>CustomApexPolicy</type>
19</TransactionSecurityPolicy>

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

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

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

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