afv-library/skills/platform-metadata-api-context-get/data/metadata_api/SharingSettings.json

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "SharingSettings - Metadata API",
  "description": "Represents an organization’s sharing, visibility, and data access settings. This type extends the Metadata metadata type and inherits its fullName field.",
  "file_information": ".settings",
  "directory_location": "settings",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "deferGroupMembership": {
      "type": "boolean",
      "description": "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. 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. Important"
    },
    "deferSharingRules": {
      "type": "boolean",
      "description": "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. 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. Important"
    },
    "enableAccountRoleOptimization": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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."
    },
    "enableManagerGroups": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "Indicates whether users can share their own user record (true) or not (false). This field has a default value of false."
    },
    "enablePartnerSuperUserAccess": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"SharingSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"deferGroupMembership\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"deferSharingRules\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableAccountRoleOptimization\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableAssetSharing\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableCommunityUserVisibility\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableExternalSharingModel\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableManagerGroups\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableManualUserRecordSharing\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enablePartnerSuperUserAccess\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enablePortalUserCaseSharing\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enablePortalUserVisibility\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableRemoveTMGroupMembership\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableRestrictAccessLookupRecords\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableSecureGuestAccess\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableShareObjectReportTypes\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableStandardReportVisibility\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableTerritoryForecastManager\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of a SharingSettings",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SharingSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <deferGroupMembership>false</deferGroupMembership>\n    <deferSharingRules>false</deferSharingRules>\n    <enableAccountRoleOptimization>false</enableAccountRoleOptimization>\n    <enableAssetSharing>false</enableAssetSharing>\n    <enableCommunityUserVisibility>false</enableCommunityUserVisibility>\n    <enableExternalSharingModel>true</enableExternalSharingModel>\n    <enableManagerGroups>false</enableManagerGroups>\n    <enableManualUserRecordSharing>true</enableManualUserRecordSharing>\n    <enablePartnerSuperUserAccess>false</enablePartnerSuperUserAccess>\n    <enablePortalUserCaseSharing>false</enablePortalUserCaseSharing>\n    <enablePortalUserVisibility>true</enablePortalUserVisibility>\n    <enableRemoveTMGroupMembership>false</enableRemoveTMGroupMembership>\n    <enableRestrictAccessLookupRecords>true</enableRestrictAccessLookupRecords>\n    <enableSecureGuestAccess>true</enableSecureGuestAccess>\n    <enableStandardReportVisibility>false</enableStandardReportVisibility>\n    <enableTerritoryForecastManager>false</enableTerritoryForecastManager>\n</SharingSettings>"
    }
  ]
}