Newer Version Available

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

SharingBaseRule

Represents sharing rule settings such as access level and to whom access is granted.
This type extends the Metadata metadata type and inherits its fullName field.

You can’t create a SharingBaseRule component directly. Use the components under SharingRules instead.

Note

Version

SharingBaseRule replaces BaseSharingRule and is available in API version 33.0 and later.

Fields

Field Field Type Description
accessLevel string Required. The access level that the sharing rule grants.
accountSettings AccountSharingRuleSettings[] The access level for the account’s children (case, contact, and opportunity).
description string Describes the sharing rule. Maximum of 1000 characters.
label string Required. Label for the sharing rule.
sharedTo SharedTo Required. Specifies who the record should be shared with.

AccountSharingRuleSettings

Defines the access level for the case, contact, and opportunity associated with the account.

Field Field Type Description
caseAccessLevel string Required. The access level that the user or group has to cases associated with the account. Possible values are:
  • None
  • Read
  • Edit
contactAccessLevel string Required. The access level that the user or group has to contacts associated with the account. Possible values are:
  • None
  • Read
  • Edit
opportunityAccessLevel string Required. The access level that the user or group has to opportunities associated with the account. Possible values are:
  • None
  • Read
  • Edit

Wildcard Support in the Manifest File

This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.