search

pnp / cli-microsoft365

Manage Microsoft 365 and SharePoint Framework projects on any platform
https://aka.ms/cli-m365
MIT License
882 stars 312 forks source link

New command: `m365 spo site admin remove` #5884

Open MathijsVerbeeck opened 4 months ago

MathijsVerbeeck commented 4 months ago

Usage

m365 spo site admin remove [options]

Description

Removes a user or group as site collection administrator

Options

Option Description
-u, --siteUrl <siteUrl> The URL of the site
--userId [userId] The ID of the user to remove as a site collection admin
--userName [userName] The user principal name of the user to remove as a site collection admin
--groupId [groupId] The ID of the Microsoft Entra ID group to remove as a site collection admin
--groupName [groupName] The name of the Microsoft Entra ID group to remove as a site collection admin
--asAdmin If specified, we will use the SharePoint admin center to execute the command
-f, --force Don't prompt for confirmation

Examples

Removes user as site collection admin

m365 spo site admin remove --siteUrl https://contoso.sharepoint.com --userId 600713c5-53c6-4f24-b454-3c35e22b2639

Removes group as site collection admin without prompting for confirmation

m365 spo site admin remove --siteUrl https://contoso.sharepoint.com --groupName SP_Administrators --force

Response

No response

Additional info

We should add correct error handling as when we try to remove the primary site collection admin or when we try to remove the final site collection admin, as there always has to be atleast one if I'm not mistaken

martinlingstuyl commented 4 months ago

Also check out my comment here: https://github.com/pnp/cli-microsoft365/issues/5882#issuecomment-1981160284

MathijsVerbeeck commented 4 months ago

@martinlingstuyl I have updated the specs to include the --asAdmin flag.

martinlingstuyl commented 4 months ago

Should we use a -a short?

MathijsVerbeeck commented 4 months ago

Should we use a -a short?

We could, but it would be quite inconsistent as we do not use this short with the Power Platform commands that we offer.

Adam-it commented 4 months ago

LGTM 👍

mkm17 commented 2 months ago

Hi, could you assign me to this task as it is similar to other m365 spo site admin ... commands :)