RestrictionRule

Represents a restriction rule or a scoping rule. A restriction rule has enforcementType set to Restrict and controls the access that specified users have to designated records. A scoping rule has enforcementType set to Scoping and controls the default records that your users see without restricting access. This type extends the Metadata metadata type and inherits its fullName field.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

File Suffix and Directory Location

RestrictionRule components have the suffix .rule and are stored in the restrictionRules folder.

Version

RestrictionRule components are available in API version 52.0 and later.

Special Access Rules

To enable scoping rule functionality, contact Salesforce Customer Support. Only users with the Manage Sharing permission can create restriction rules and scoping rules.

Fields

Field Name	Field Type	Description
active	boolean	Indicates whether the rule is active (`true`) or not (`false`). The default value is `false`.
description	string	Required. The description of the rule.
enforcementType	EnforcementType (enumeration of type string)	Required. The type of rule. Valid values are: `FieldRestrict`—Don’t use. `Restrict`—Restriction rule. `Scoping`—Scoping rule.
masterLabel	string	Required. The name of the rule.
recordFilter	string	Required. The criteria that determine which records are accessible via the rule.
targetEntity	string	Required. The object for which you're creating the rule. We recommend that you don’t edit this field after the rule is created. If enforcementType is set to `Restrict`, custom objects, external objects, and these objects are supported: Contract Event Task TimeSheet TimeSheetEntry If enforcementType is set to `Scoping`, custom objects and these objects are supported: Account Case Contact Event Lead Opportunity Task
userCriteria	string	Required. The users that this rule applies to, such as all active users or users with a specified role or profile.
version	int	Required. The rule's version number.

Declarative Metadata Sample Definition

The following is an example of a RestrictionRule component.

1<?xml version="1.0" encoding="UTF-8"?>
2<RestrictionRule xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>true</active>
4    <description>Allows users with a specific profile to see only tasks that they own.</description>
5    <enforcementType>Restrict</enforcementType>
6    <masterLabel>Tasks You Own</masterLabel>
7    <recordFilter>OwnerId = $User.Id</recordFilter>
8    <targetEntity>Task</targetEntity>
9    <userCriteria>$User.ProfileId = '005xxxxxxxxxxxx'</userCriteria>
10    <version>1</version>
11</RestrictionRule>

The following is an example package.xml that references the previous definition.

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

Usage

For more information on restriction rules, see the Restriction Rules Developer Guide.

Metadata API Developer Guide