Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds a new command: 'spo site admin remove'. Closes #5884 #6062

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions docs/docs/cmd/spo/site/site-admin-remove.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# spo site admin remove

Removes a user or group as site collection administrator

## Usage

```sh
m365 spo site admin remove [options]
```

## Options

```md definition-list
`-u, --siteUrl <siteUrl>`
: The URL of the SharePoint 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
```

<Global />

## Remarks

:::info

To use this command with the `--asAdmin` mode, you have to have permissions to access the tenant admin site.

Without this parameter, you have to have site collection admin permissions for the requested site.

:::

## Examples

Removes user as site collection admin

```sh
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 as SharePoint Admin

```sh
m365 spo site admin remove --siteUrl https://contoso.sharepoint.com --groupName SP_Administrators --force --asAdmin
```
## Response

The command won't return a response on success.
5 changes: 5 additions & 0 deletions docs/src/config/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3421,6 +3421,11 @@ const sidebars: SidebarsConfig = {
label: 'site admin list',
id: 'cmd/spo/site/site-admin-list'
},
{
type: 'doc',
label: 'site admin remove',
id: 'cmd/spo/site/site-admin-remove'
},
{
type: 'doc',
label: 'site appcatalog add',
Expand Down
1 change: 1 addition & 0 deletions src/m365/spo/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,7 @@ export default {
SITE_ADD: `${prefix} site add`,
SITE_ADMIN_ADD: `${prefix} site admin add`,
SITE_ADMIN_LIST: `${prefix} site admin list`,
SITE_ADMIN_REMOVE: `${prefix} site admin remove`,
SITE_APPCATALOG_ADD: `${prefix} site appcatalog add`,
SITE_APPCATALOG_LIST: `${prefix} site appcatalog list`,
SITE_APPCATALOG_REMOVE: `${prefix} site appcatalog remove`,
Expand Down
Loading