--- schema_version: "1" id: b2f312b881bc0ceedb50b5302a07b853700da27508b2f414fd70b6e8ef7c3f2b title: RestrictionRule collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_restrictionrule.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_restrictionrule.htm source_site: developer.salesforce.com content_type: documentation content_hash: 12c873bb10845d87b0eb9b06157de60bd60d90e6f313ba85e081a28d3d3af81b description: 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. --- # 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. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important 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. ## 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 Only users with the View Restriction and Scoping Rules permission can view restriction rules and scoping rules via the API. Only users with the Manage Sharing permission can view, create, update, and delete 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
  • Quote
  • 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 representing a restriction rule. true Allows users with a specific profile to see only tasks that they own. Restrict Tasks You Own OwnerId = $User.Id Task $User.ProfileId = '00exxxxxxxxxxxx' 1 The following is an example of a RestrictionRule component representing a scoping rule. true View tasks contacts from Department A. Scoping SR for Department A contacts Department=$User.Department Contact $User.UserRoleId = '00Exxxxxxxxxxxx' 1 The following is an example package.xml that references the previous definition. \* RestrictionRule 55.0