Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

TransactionSecurityPolicy

Represents a transaction security policy definition.

This object is available in Tooling API version 35.0 and later.

Supported Calls

create(), delete(), query(), retrieve(), update(), upsert()

Supported REST Methods

Query, DELETE, GET, PATCH, POST

Fields

Field	Details
ActionConfig	Type textarea Properties Create, Update Description Describes the action to take when the matching Transaction Security policy is triggered. Also indicates the type of notifications selected and the ID of the intended recipient. The recipient must be active and assigned the Modify All Data and View Set up user permissions. Multiple actions can be taken. The actions available depend on the EventType field.
ApexPolicyId	Type reference Properties Filter, Group, Nillable, Sort Description Represents the Apex `TxnSecurity.PolicyCondition` interface for this policy.
Description	Type string Properties Filter, Nillable, Sort Description The description entered for this policy. This field available in API 39.0 and later.
DeveloperName	Type string Properties Filter, Group, Sort Description The API, or program name, for this policy.
EventName	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Used in Real-Time Event Monitoring (Beta) only. Indicates the name of the event the policy monitors. This field is available in API 31.0 and later. Valid values are: `AdminSetupEvent`—Tracks user operations for managing encryption keys in your org. `ApiEvent`—Tracks user API calls in your org. `ListViewEvent`—Tracks when users access data with list views using Salesforce Classic or the API. It doesn’t track list views of Setup entities. `LoginEvent`—Tracks user login events in your org. `ReportEvent`—Tracks when reports are run in your org.
EventType	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the type of event the policy monitors. Valid values are: `AccessResource`—Notifies you when the selected resource has been accessed. `AuditTrail`—Reserved for future use. `DataExport`—Notifies you when any API query is made, such as from the Data Loader API client, or when a Report export occurs. `Entity`—Notifies you on use of an object type such as an authentication provider or chatter post. `Login`—Notifies you when a user logs in.
ExecutionUserId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the user whose context will be established to execute the Apex policy. This user must be active and assigned the Modify All Data and View Setup user permissions.
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated object in the Metadata API. Use to avoid race conditions on create, before you have IDs. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `installed` `released` `unmanaged` For more information about states of manageability for components in Salesforce AppExchange packages, see “Planning the Release of Managed Packages” in the Salesforce online help. This field is available in API version 38.0 and later.
MasterLabel	Type string Properties Filter, Group, Sort Description The policy’s name.
Metadata	Type mns:TransactionSecurityPolicy Properties Create, Nillable, Update Description The policy’s metadata. See the Metadata API Developer Guide for details.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
ResourceName	Type string Properties Filter, Group, Nillable, Sort Description A resource used to narrow down the conditions under which the policy triggers. For example, with a `DataExport` event, you can select a resource Lead to specifically monitor export activity occurring on your Lead entities. The resources available depend on the EventType field.
State	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates whether the policy is active. Valid values are: `Disabled` `Enabled`
Type	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of validation that the policy uses. The valid values are: `CustomApexPolicy`— Created with Apex editor. `CustomConditionBuilderPolicy`— Created with Condition Builder The default value is `CustomApexPolicy`.