--- schema_version: "1" id: 3f14f71014eb9adf928239095eefaf980b2eac9ce8a6f8f4f2025760be1faa11 title: SharingSettings collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_sharingsettings.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingsettings.htm source_site: developer.salesforce.com content_type: documentation content_hash: dba40bb72eb899652a027ecf9748194cc3e544138fd7781250ae8c2dfb6edaf8 description: Represents an organization’s sharing, visibility, and data access settings. This type extends the Metadata metadata type and inherits its fullName field. --- # SharingSettings Represents an organization’s sharing, visibility, and data access settings. This type extends the Metadata metadata type and inherits its fullName field. In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details. ## File Suffix and Directory Location SharingSettings values are stored in the Sharing.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component. ## Version SharingSettings ## Special Access Rules To use SharingSettings, you need the Manage Sharing permission. ## Fields

Field Name	Field Type	Description
deferGroupMembership	boolean	Indicates whether group membership calculations are suspended (`true`) or not (`false`). This field has a default value of `false`. This field is available in API version 49.0 and later. Important The defer sharing calculation feature isn't enabled by default. To enable it for your Salesforce org, contact Salesforce Customer Support. When you change the value of this field from `true` to `false`, group membership is automatically recalculated. Sharing rules are also automatically recalculated, unless the deferSharingRules field is set to `true` prior to modifying deferGroupMembership. Depending on your org, these recalculations can take a significant amount of time to complete. If the deferGroupMembership field is set to `true`, you can’t change the value of deferSharingRules. Sharing rule calculations are suspended regardless of the value of deferSharingRules.
deferSharingRules	boolean	Indicates whether sharing rule calculations are suspended (`true`) or not (`false`). This field has a default value of `false`. This field is available in API version 49.0 and later. Important The defer sharing calculation feature isn't enabled by default. To enable it for your Salesforce org, contact Salesforce Customer Support. When you change the value of this field from `true` to `false`, sharing rules are automatically recalculated. Depending on your org, this recalculation can take a significant amount of time to complete. If the deferGroupMembership field is set to `true`, you can’t change the value of deferSharingRules. Sharing rule calculations are suspended regardless of the value of deferSharingRules.
enableAccountRoleOptimization	boolean	Indicates whether person roles are assigned to new site users in accounts without existing users (`true`) or if regular site roles are created for new users (`false`). This field has a default value of `false`.
enableAssetSharing	boolean	Indicates whether sharing is enabled for assets (`true`) or asset access is determined by the parent object’s sharing rules (`false`). This field has a default value of `false`.
enableCommunityUserVisibility	boolean	Indicates whether site users in the same site can see each other regardless of the organization-wide defaults (`true`) or not (`false`). This field has a default value of `false`. In orgs created in API version 47.0 and later, this setting doesn’t apply to guest users.
enableExternalSharingModel	boolean	Indicates whether the external sharing model is enabled (`true`) or not (`false`). This field has a default value of `true` if Salesforce Experiences are enabled, and a default value of `false` if not. To use this field, you need the Customize Application permission.
enableKeepManualSharesOnTransfer	boolean	Indicates whether manual shares on a record are retained (`true`) or not (`false`) when the record is transferred to a new owner. This field is available in API version 68.0 and later.
enableManagerGroups	boolean	Indicates whether users can share records with their managers and manager subordinates groups (`true`) or not (`false`). This field has a default value of `false`. To use this field, you need the View and Manage Users permission.
enableManualUserRecordSharing	boolean	Indicates whether users can share their own user record (`true`) or not (`false`). This field has a default value of `false`.
enablePartnerSuperUserAccess	boolean	Indicates whether you can grant super user access to partners in sites (`true`) or not (`false`). This field has a default value of `false`. To use this field, you need the Customize Application permission
enablePortalUserCaseSharing	boolean	Indicates whether portal users can access related contacts for cases that they own (`true`) or not (`false`). This field has a default value of `false`.
enablePortalUserVisibility	boolean	Indicates whether portal users in the same customer or partner portal account can see each other regardless of the organization-wide defaults (`true`) or not (`false`). This field has a default value of `false`. To enable this field, contact Salesforce Support.
enableRemoveTMGroupMembership	boolean	Removes group membership info for the original territory management feature after migrating to Sales Territories when set to `true`. This field has a default value of `false`. Once this field is set to `true`, it can't be set to `false` again.
enableRestrictAccessLookupRecords	boolean	Indicates whether users must have read access to a record to see the record’s name in lookup and system fields (`true`) or not (`false`). This field has a default value of `true` in Salesforce orgs created in Spring ’20 or later and a default value of `false` in all other orgs. This field is available in API version 48.0 and later.
enableSecureGuestAccess	boolean	When `true`, guest users have org-wide defaults set to Private. To share records with them, you must use guest user sharing rules. As of API version 50.0, this field's value is always `true`, regardless of the value that you set. Changing its value has no effect on Salesforce, even if it reads `false`. This change applies retroactively back to API version 47.0, when this field was first introduced. Previously, in API version 47.0 to 49.0, this field indicated whether guest users’ record access is secured (`true`) or not (`false`), and the field's default value was `false`. Now, in all API versions, this field's value is always `true`, even if it reads `false`.
enableStandardReportVisibility	boolean	Indicates whether users can view reports based on standard report types that may expose data of users to whom they don't have access (`true`) or not (`false`). This field has a default value of `false`.
enableTerritoryForecastManager	boolean	Indicates whether forecast managers can act as delegated administrators for territories below them in the hierarchy (`true`) or not (`false`). This field has a default value of `false`.

## Declarative Metadata Sample Definition The following is an example of a SharingSettings false false false false false true true false true false false true false true true false false The following is an example package.xml that references the previous definition. Sharing Settings 68.0 ## Wildcard Support in the Manifest File The wildcard character \* (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

Important

Important