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

トランザクションセキュリティポリシーの定義を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

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

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

バージョン

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

項目

項目名	データ型	説明
action	TransactionSecurityAction	必須。一致するトランザクションセキュリティポリシーがトリガされた場合に実行するアクションを記述します。
active	boolean	必須。`true` の場合、ポリシーが有効になり、イベントを積極的に監視します。
apexClass	string	必須。このポリシーの `TxnSecurity.PolicyCondition` インターフェースを実装するクラスの名前。
eventType	MonitoredEvents (string 型の列挙)	監視中のイベントのタイプを示します。有効な値は、次のとおりです。 `AccessResource` — 選択したリソースへのアクセスがあった場合に通知します。 `AuditTrail` — 今後の使用のために予約されています。 `DataExport` — データローダ API クライアントを使用して、選択したオブジェクト種別がエクスポートされた場合に通知します。 `Entity` — 認証プロバイダやクライアントブラウザなどのオブジェクト種別を使用した場合に通知します。 `Login` — ユーザがログインした場合に通知します。
executionUser	string	必須。通知が選択されている場合、ポリシーがトリガされたときに通知するユーザの名前。このユーザには、システム管理者プロファイルが必要です。
resourceName	string	必須。ポリシーのトリガ条件を絞り込むために使用されるリソース。たとえば、Login イベントでは、特定のログイン URL のみがポリシーをトリガするようにリソースを追加できます。使用可能なリソースは、[イベントの種別] 項目によって異なります。有効なリソースは、次のようにイベント種別でグループ化されます。 AccessResource — EventTimestamp、SessionLevel、SourceIp DataExport — EventTimestamp、SessionLevel、SourceIp Entity — AuthorizeUrl、ConsumerKey、ConsumerSecret、DefaultScopes、DeveloperName、ErrorUrl、FriendlyName、IconUrl、IdTokenIssuer、LogoutUrl、TokenUrl、UserInfoUrl Login — ApiType、ApiVersion、Application、Browser、ClientVersion、LoginUrl、Platform、Status

TransactionSecurityAction

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

項目名	データ型	説明
block	boolean	必須。`true` の場合、要求された操作はブロックされます。このアクションは、Login イベントと AccessResource イベントにのみ適用されます。
endSession	boolean	必須。`true` の場合、新しいセッションを開始するには、現在のセッションを閉じる必要があります。このアクションは、Login イベントにのみ適用されます。
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        <endSession>false</endSession>
6        <notifications>
7            <inApp>false</inApp>
8            <sendEmail>true</sendEmail>
9            <user>admin@your.org</user>
10        </notifications>
11        <twoFactorAuthentication>false</twoFactorAuthentication>
12    </action>
13    <active>true</active>
14    <apexClass>TxnSecurityMdApiPolicy</apexClass>
15    <eventType>Login</eventType>
16    <executionUser>admin@your.org</executionUser>
17    <resourceName>LoginHistory</resourceName>
18</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>