Newer Version Available

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

TransactionSecurityPolicy

Represents a transaction security policy definition (policy).

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
string
Properties
Create, Update
Description
Describes the action to take when the matching Transaction Security policy is triggered. Multiple actions can be taken. The actions available depend on the Event Type field.
Event Type Available Actions
AccessResource
  • Block
  • Two-factor authentication
DataExport None; only notifications are available.
Entity None; only notifications are available.
Login
  • Block
  • Two-factor authentication
  • End an existing session
ApexPolicyId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Represents the Apex TxnSecurity.PolicyCondition interface for this policy.
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The API, or program name, for this policy.
EventType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
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 the selected object type has been exported using the Data Loader API client.
  • Entity—Notifies you on use of an object type such as an authentication provider or client browser.
  • Login—Notifies you when a user logs in.
ExecutionUserId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the user to notify when the policy is triggered. This user must be active and assigned the System Administrator profile.
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The policy’s name.
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
Create, Filter, Group, Nillable, Sort, Update
Description
A resource used to narrow down the conditions under which the policy triggers. For example, with a Login event, you can add a resource to specify which login URL triggers the policy. The resources available depend on the Event Type field.
Event Type Available Actions
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
State
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Indicates whether the policy is active. Valid values are:
  • Disabled
  • Enabled
Type
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of validation that the policy uses. The only valid value is CustomApexPolicy.