Skip to content

spo hubsite rights revoke

Revokes rights to join sites to the specified hub site for one or more principals

Attention

This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.

Usage

spo hubsite rights revoke [options]

Options

Option Description
--help output usage information
-u, --url <url> The URL of the hub site to revoke rights on
-p, --principals <principals> Comma-separated list of principals to revoke join rights. Principals can be users or mail-enabled security groups in the form of alias or alias@<domain name>.com
--confirm Don't prompt for confirming revoking rights
-o, --output [output] Output type. json|text. Default text
--verbose Runs command with verbose logging
--debug Runs command with debug logging

Important

Before using this command, log in to a SharePoint Online tenant admin site, using the spo login command.

Remarks

To revoke rights to join sites to a hub site, you have to first log in to a tenant admin site using the spo login command, eg. spo login https://contoso-admin.sharepoint.com. If you are logged in to a different site and will try to revoke rights, you will get an error.

Examples

Revoke rights to join sites to the hub site with URL https://contoso.sharepoint.com/sites/sales from user with alias PattiF. Will prompt for confirmation before revoking the rights

spo hubsite rights revoke --url https://contoso.sharepoint.com/sites/sales --principals PattiF

Revoke rights to join sites to the hub site with URL https://contoso.sharepoint.com/sites/sales from user with aliases PattiF and AdeleV without prompting for confirmation

spo hubsite rights revoke --url https://contoso.sharepoint.com/sites/sales --principals PattiF,AdeleV --confirm

More information