Skip to content

Hub Sites & Home Sites

Manage hub sites — register, associate, enumerate, and set as the intranet landing page.

Prerequisites

Requirement Description Reference
SharePoint Administrator role Required to register, unregister, and manage hub sites. SharePoint admin roles
Site Owner role (on target site) Required to associate a site with a hub.

How hub sites work

graph TD
    subgraph Hub
        H["Hub Site"]
        H --> HS1["Associated Site"]
        H --> HS2["Associated Site"]
    end
    H ---|"also can be"| Home["Home Site (intranet landing page)"]

A hub site groups related sites under a common navigation and branding. An associated site inherits the hub's theme and navigation. A hub site can also be set as the home site (intranet landing page).

Examples

Step Operation File Required role API reference
1 List hubs — enumerate all hub sites list_hub_sites.py Read access List hubs
2 Register — make a site a hub register_hub_site.py SharePoint Admin Register hub
3 Associate — join a site to an existing hub associate_site.py Site Owner on target site Associate
4 Connected hubs — list hubs associated with a hub get_connected_hubs.py Read access Get connected
5 Unregister — remove hub status from a site unregister_hub_site.py SharePoint Admin Unregister
6 Set home — set a site as intranet landing page set_home_site.py SharePoint Admin Set home
7 List home — enumerate all home sites list_home_sites.py Read access List home

Quick start

from office365.sharepoint.client_context import ClientContext

ctx = ClientContext("https://contoso-admin.sharepoint.com").with_client_certificate(
    "contoso.onmicrosoft.com", client_id="client_id", thumbprint="thumbprint", cert_path="./cert.pem"
)

# List all hub sites
hub_sites = ctx.hub_sites.get().execute_query()
for hub in hub_sites:
    print(f"  {hub.title}  ({hub.site_url})")

API reference