Remove-SPOContainerUser
Removes a user from a specified role in a SharePoint Embedded container.
Syntax
Default (Default)
Remove-SPOContainerUser
[-ContainerId] <String>
-LoginName <String>
-Role <String>
[<CommonParameters>]
Description
Removes a user from a defined role within a SharePoint Embedded container.
You must be a SharePoint Embedded Administrator to run this cmdlet.
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.
Note
You can't remove the principal owner of a container.
Examples
Example 1
Remove-SPOContainerUser 423poi45 -LoginName shras@contoso.com-Role Owner
Example 1 removes the user with User Principal Name "shras@contoso.com" from the role of an owner of container whose ContainerId is 423poi45 .
Parameters
-ContainerId
Applicable: SharePoint Online
The unique identifier of the container to which the user is being added.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LoginName
Applicable: SharePoint Online
The user’s login name to assign to the container. This is the User Principal Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Role
Applicable: SharePoint Online
The role to assign to the user within the container. Valid roles are:
Owner: Has full control over the container and its contents. Manager: Can add, update, and delete content, and manage permissions, but can't delete the container. Writer: Can add, update, and delete content in the container. Reader: Can only view content in the container.
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | Owner, Reader, Writer, Manager |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.