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

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

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 文字です。この項目は、UI でデフォルトのメッセージオプションがオンのときは null です。使用可能になるのは、eventName が `ApiEvent`、`ListViewEvent`、`BulkApiResultEventStore`、または `ReportEvent` に設定されている場合のみです。API バージョン 49.0 以降で利用できます。カスタムメッセージには、担当のシステム管理者の名前やビジネス単位など、組織またはポリシーに固有の情報を含めます。含める内容には注意してください。ポリシーの設計方法に関する情報が多すぎると、悪意のあるユーザーを手助けすることになりかねません。 Lightning Experience では、2 要素認証 (2FA) はサポートされません。このため、`ListView` や `ReportEvent` などのイベントは、Lightning で Block にアップグレードされます。カスタムメッセージは翻訳できません。
customEmailContent	string	ポリシーがトリガーされたときに送信される管理者が作成したカスタムメールコンテンツ。リアルタイムイベント監視でのみ使用されます。最大 1333 文字です。この項目は、UI で [カスタムメールコンテンツ] 設定を選択したときに、メッセージコンテンツを入力していない場合には null になります。API バージョン 54.0 以降で利用できます。カスタムメッセージは翻訳できません。
description	string	ポリシーの説明。
developerName	string	一意の名前を使用して、同じ masterLabel を持つ他のポリシーとの競合を回避します。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。「DeveloperName を表示」または「設定・定義を参照する」権限を持っているユーザーのみがこの項目の表示、グループ化、並べ替え、絞り込みを行えます。
eventName	TransactionSecurityEventName (string 型の列挙)	リアルタイムイベント監視でのみ使用されます。ポリシーが監視するイベントの名前を示します。この項目は API 45.0 以降で使用できます。有効な値は、次のとおりです。 `ApiEvent` — `query()`、`queryMore()`、および `count()` のユーザーが開始した読み��り専用 API 呼び出しを追跡します。Enterprise WSDL および Partner WSDL の場合、SOAP API と Bulk API によって API 要求を捕捉します。Salesforce モバイルアプリケーションから開始された Tooling API コールおよび API コールは捕捉されません。 `ApiAnomalyEventStore` — ユーザーが API コールを行う方法の異常を追跡します。ApiAnomalyEventStore は、ApiAnomalyEvent のイベントデータを格納するオブジェクトです。このオブジェクトは API バージョン 50.0 以降で使用できます。 `BulkApiResultEventStore` — ユーザーがいつ Bulk API 要求の結果をダウンロードしたかを追跡します。BulkApiResultEventStore は、BulkApiResultEvent のイベントデータを格納する Big Object です。このオブジェクトは API バージョン 50.0 以降で使用できます。 `CredentialStuffingEventStore` — 識別済みのログイン情報スタッフィング攻撃中にユーザーが正常に Salesforce にログインした場合を追跡します。ログイン情報スタッフィングとは、盗まれたユーザーログイン情報を使用した大規模な自動ログイン要求を指します。この値は、API バージョン 49.0 以降で使用できます。 `ListViewEvent` — Lightning Experience、Salesforce Classic、または API を使用して、いつユーザーがリストビューでデータにアクセスしたかを追跡します。設定エンティティのリストビューは追跡されません。 `LoginEvent` — Salesforce にログインしたユーザーのログイン活動を LoginEvent で追跡します。 `PermissionSetEventStore` — 権限セットおよび権限セットグループへの変更を追跡します。 `ReportAnomalyEventStore` — ユーザーによるレポートの実行またはエクスポートの異常を追跡します (未保存のレポートを含む)。この値は API バージョン 49.0 以降で使用できます。 `ReportEvent` — 組織内でいつレポートが実行されたかを追跡します。 `SessionHijackingEventStore` — 未承認ユーザーが、盗まれたセッション識別子を使用して Salesforce ユーザーのセッションの所有権を取得した場合を追跡します。このようなイベントを検出するために、Salesforce は、確率的に推測された有意な変化を使用して、ユーザーの現在のブラウザーフィンガープリントが以前の既知のフィンガープリントからどの程度有意に異なるかを評価します。API バージョン 49.0 以降で利用できます。
eventType	MonitoredEvents (string 型の列挙)	従来のトランザクションセキュリティでのみ使用されます。Apex ベースのポリシーでは必須、その他のすべてのポリシーでは省略可能。監視中のイベントのタイプを示します。有効な値は、次のとおりです。 `AccessResource` — 選択したリソースへのアクセスがあった場合に通知します。 `AuditTrail` — 今後の使用のために予約されています。 `DataExport` — データローダー API クライアントを使用して、選択したオブジェクト種別がエクスポートされた場合に通知します。 `Entity` — 認証プロバイダーや Chatter コメントなどのオブジェクト種別を使用した場合に通知します。 `Login` — ユーザーがログインした場合に通知します。 Summer '20 以降、すべての Salesforce 組織で従来のトランザクションセキュリティが廃止されます。
executionUser	string	従来のトランザクションセキュリティでのみ使用されます。「すべてのデータの編集」および「設定の参照」ユーザー権限が割り当てられている有効ユーザーの名前または ID。 Summer '20 以降、すべての Salesforce 組織で従来のトランザクションセキュリティが廃止されます。
flow	string	`CustomConditionBuilderPolicy` 種別のポリシーでのみ必須。条件ビルダーのトランザクションセキュリティポリシーのロジックが含まれるフローオブジェクトの ID。API バージョン 46.0 以降で利用できます。
masterLabel	string	このオブジェクトの表示ラベル。この表示値は、翻訳されない内部ラベルです。可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。
resourceName	string	従来のトランザクションセキュリティでのみ使用されます。Apex ベースのポリシーでは必須、その他のすべてのポリシーでは省略可能。ポリシーのトリガー条件を絞り込むために使用されるリソース。たとえば、`DataExport` イベントでリソース Lead を選択すると、リードエンティティで発生するエクスポート活動のみを監視できます。使用可能なリソースは、[イベントの種別] 項目によって異なります。次の有効なリソースは、イベント種別でグループ化されます。 AccessResource — ConnectedApplication、Reports DataExport — Account、Case、Contact、Lead、Opportunity Entity — AuthProvider、ChatterMessage、FeedComment、FeedItem、Idea、Question Login — LoginHistory Summer '20 以降、すべての Salesforce 組織で従来のトランザクションセキュリティが廃止されます。
type	TxnSecurityPolicyType (string 型の列挙)	ポリシーが使用する検証の種別。有効な値は次のとおりです。 `CustomApexPolicy` — Apex エディターで作成されました。 `CustomConditionBuilderPolicy` — 条件ビルダーで作成されました。デフォルト値は `CustomApexPolicy` です。

TransactionSecurityAction

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

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

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 ファイルを使用したメタデータのリリースと取得」を参照してください。