Skip to content

Commit 04a795f

Browse files
authored
Update Remove-SPOContainerUser
1 parent 9bddbad commit 04a795f

1 file changed

Lines changed: 21 additions & 8 deletions

File tree

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerUser

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,26 @@ ms.reviewer:
1414

1515
## SYNOPSIS
1616

17-
Removes a user from an assigned role of a container.
17+
Removes a user from a specified role in a SharePoint Embedded container.
1818

1919
## SYNTAX
2020

2121
```
2222
Remove-SPOContainerUser [-ContainerId] <String> -LoginName <String> -Role <String> [<CommonParameters>]
2323
```
2424

25+
##DESCRIPTION
26+
27+
Removes a user from a defined role within a SharePoint Embedded container. Use this cmdlet when you need to revoke a user's access or change their assigned role. The user must be currently assigned to the specified role in the container for the removal to succeed.
28+
29+
You must be a SharePoint Embedded Administrator to run this cmdlet.
30+
31+
For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell).
32+
33+
> [!NOTE]
34+
> You can't remove the principal owner of a container.
35+
36+
2537
## EXAMPLES
2638

2739
### Example 1
@@ -38,7 +50,7 @@ Example 1 removes the user with User Principal Name "shras@contoso.com" from the
3850

3951
> Applicable: SharePoint Online
4052

41-
Use this parameter to specify the Container ID.
53+
The unique identifier of the container to which the user is being added.
4254

4355
```yaml
4456
Type: String
@@ -56,7 +68,7 @@ Accept wildcard characters: False
5668

5769
> Applicable: SharePoint Online
5870

59-
The User Principal Name to whom a membership is to be assigned.
71+
The user’s login name to assign to the container. This is the User Principal Name.
6072

6173
```yaml
6274
Type: String
@@ -74,11 +86,12 @@ Accept wildcard characters: False
7486

7587
> Applicable: SharePoint Online
7688

77-
The membership role intended to be assigned to a user. The available roles are :
78-
Owner: have full control over the container and the contents of the container.
79-
Manager: can add, update, and delete contents of a container and also maintain permissions of the container but cannot delete a container.
80-
Writer: can add, update, and delete content in the container.
81-
Reader: can only view content in the container.
89+
The role to assign to the user within the container. Valid roles are:
90+
91+
Owner: Has full control over the container and its contents.
92+
Manager: Can add, update, and delete content, and manage permissions, but can't delete the container.
93+
Writer: Can add, update, and delete content in the container.
94+
Reader: Can only view content in the container.
8295

8396
```yaml
8497
Type: String

0 commit comments

Comments
 (0)