Skip to content

Commit 1d35326

Browse files
authored
Update Set-SPOContainerUser
1 parent e726204 commit 1d35326

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

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

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

1515
## SYNOPSIS
1616

17-
Reassigns the user from an already assigned role to a new role on a container.
17+
Reassigns a user from their current role to a new role within a SharePoint Embedded container.
1818

1919
## SYNTAX
2020

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

25+
##DESCRIPTION
26+
27+
Updates a user's assigned role within a SharePoint Embedded container. Use this cmdlet to reassign a user from their current role to a new one. You must specify the container ID, the user's login name, and the new role.
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+
> A user can be assigned to only one role within a container at a time.
35+
> To transfer principal ownership of a container, use the `Set-SPOContainer` cmdlet
36+
37+
2538
## EXAMPLES
2639

2740
### Example 1
@@ -38,7 +51,7 @@ Example 1 reassigns the role of User Principal Name "[email protected]" to manag
3851

3952
> Applicable: SharePoint Online
4053

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

4356
```yaml
4457
Type: String
@@ -56,7 +69,7 @@ Accept wildcard characters: False
5669

5770
> Applicable: SharePoint Online
5871

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

6174
```yaml
6275
Type: String
@@ -74,11 +87,13 @@ Accept wildcard characters: False
7487

7588
> Applicable: SharePoint Online
7689

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.
90+
The role to assign to the user within the container. Valid roles are:
91+
92+
Owner: Has full control over the container and its contents.
93+
Manager: Can add, update, and delete content, and manage permissions, but can't delete the container.
94+
Writer: Can add, update, and delete content in the container.
95+
Reader: Can only view content in the container.
96+
8297

8398
```yaml
8499
Type: String
@@ -110,14 +125,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
110125

111126
[Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell)
112127

113-
[Get-SPOApplication](./Get-SPOApplication.md)
128+
[Add-SPOContainerUser](./Add-SPOContainerUser.md)
114129

115-
[Set-SPOContainer](./Set-SPOContainer.md)
130+
[Set-SPOContainerUser](./Set-SPOContainerUser.md)
116131

117-
[Get-SPODeletedContainer](./Get-SPODeletedContainer.md)
118-
119-
[Remove-SPOContainer](./Remove-SPOContainer.md)
132+
[Set-SPOContainer](./Set-SPOContainer.md)
120133

121-
[Remove-SPODeletedContainer](./Remove-SPODeletedContainer.md)
134+
[Get-SPOContainer](./Get-SPOContainer.md)
122135

123-
[Restore-SPODeletedContainer](./Restore-SPODeletedContainer.md)

0 commit comments

Comments
 (0)