RelatedWebsiteSetsOverrides

Article
2025-05-09

Supported versions

On Windows and macOS since 121 or later

Description

This policy provides a way to override the list of sets Microsoft Edge uses for Related Website Sets

Each set in the browser's list of Related Website Sets must meet the requirements of a Related Website Set. A Related Website Set must contain a primary site and one or more member sites. A set can also contain a list of service sites that it owns, as well as a map from a site to all its ccTLD variants. See https://github.com/WICG/first-party-sets for more information on how Microsoft Edge uses Related Website Sets.

All sites in a Related Website Set must be a registrable ___domain served over HTTPS. Each site in a Related Website Set must also be unique, which means a site can't be listed more than once in a Related Website Set.

When this policy is given an empty dictionary, Microsoft Edge uses the public list of Related Website Sets.

For all sites in a Related Website Set from the replacements list, if a site is also present on a Related Website Set in the browser's list, then that site will be removed from the browser's Related Website Set. After this, the policy's Related Website Set will be added to the Microsoft Edge's list of Related Website Sets.

For all sites in a Related Website Set from the additions list, if a site is also present on a Related Website Set in Microsoft Edge's list, then the browser's Related Website Set will be updated so that the new Related Website Set can be added to the browser's list. After the browser's list has been updated, the policy's Related Website Set will be added to the browser's list of Related Website Sets.

The browser's list of Related Website Sets requires that for all sites in its list, no site is in more than one set. This is also required for both the replacements list and the additions list. Similarly, a site can't be in both the replacements list and the additions list.

Wildcards (*) aren't supported as a policy value, or as a value within any Related Website Set in these lists.

Supported features

Can be mandatory: Yes
Can be recommended: No
Dynamic Policy Refresh: No - Requires browser restart
Per Profile: Yes
Applies to a profile that is signed in with a Microsoft account: No

Data type

Dictionary

Windows information and settings

Group Policy (ADMX) info

GP unique name: RelatedWebsiteSetsOverrides
GP name: Override Related Website Sets.
GP path (Mandatory): Administrative Templates/Microsoft Edge/Related Website Sets Settings
GP path (Recommended): N/A
GP ADMX file name: MSEdge.admx

Example value

{"additions": [{"associatedSites": ["https://associate2.test"], "ccTLDs": {"https://associate2.test": ["https://associate2.com"]}, "primary": "https://primary2.test", "serviceSites": ["https://associate2-content.test"]}], "replacements": [{"associatedSites": ["https://associate1.test"], "ccTLDs": {"https://associate1.test": ["https://associate1.co.uk"]}, "primary": "https://primary1.test", "serviceSites": ["https://associate1-content.test"]}]}

Registry settings

Path (Mandatory): SOFTWARE\Policies\Microsoft\Edge
Path (Recommended): N/A
Value name: RelatedWebsiteSetsOverrides
Value type: REG_SZ

Example registry value

{"additions": [{"associatedSites": ["https://associate2.test"], "ccTLDs": {"https://associate2.test": ["https://associate2.com"]}, "primary": "https://primary2.test", "serviceSites": ["https://associate2-content.test"]}], "replacements": [{"associatedSites": ["https://associate1.test"], "ccTLDs": {"https://associate1.test": ["https://associate1.co.uk"]}, "primary": "https://primary1.test", "serviceSites": ["https://associate1-content.test"]}]}

Expanded example registry value

{
  "additions": [
    {
      "associatedSites": [
        "https://associate2.test"
      ],
      "ccTLDs": {
        "https://associate2.test": [
          "https://associate2.com"
        ]
      },
      "primary": "https://primary2.test",
      "serviceSites": [
        "https://associate2-content.test"
      ]
    }
  ],
  "replacements": [
    {
      "associatedSites": [
        "https://associate1.test"
      ],
      "ccTLDs": {
        "https://associate1.test": [
          "https://associate1.co.uk"
        ]
      },
      "primary": "https://primary1.test",
      "serviceSites": [
        "https://associate1-content.test"
      ]
    }
  ]
}

Mac information and settings

Preference Key name: RelatedWebsiteSetsOverrides
Example value:

<key>RelatedWebsiteSetsOverrides</key>
<dict>
  <key>additions</key>
  <array>
    <dict>
      <key>associatedSites</key>
      <array>
        <string>https://associate2.test</string>
      </array>
      <key>ccTLDs</key>
      <dict>
        <key>https://associate2.test</key>
        <array>
          <string>https://associate2.com</string>
        </array>
      </dict>
      <key>primary</key>
      <string>https://primary2.test</string>
      <key>serviceSites</key>
      <array>
        <string>https://associate2-content.test</string>
      </array>
    </dict>
  </array>
  <key>replacements</key>
  <array>
    <dict>
      <key>associatedSites</key>
      <array>
        <string>https://associate1.test</string>
      </array>
      <key>ccTLDs</key>
      <dict>
        <key>https://associate1.test</key>
        <array>
          <string>https://associate1.co.uk</string>
        </array>
      </dict>
      <key>primary</key>
      <string>https://primary1.test</string>
      <key>serviceSites</key>
      <array>
        <string>https://associate1-content.test</string>
      </array>
    </dict>
  </array>
</dict>

Share via