Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 1.91 KB

Remove-PnPUserFromGroup.md

File metadata and controls

83 lines (62 loc) · 1.91 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Remove-PnPUserFromGroup

SYNOPSIS

Removes a user from a group

SYNTAX

Remove-PnPUserFromGroup -LoginName <String>
                        -Identity <GroupPipeBind>
                        [-Web <WebPipeBind>]
                        [-Connection <SPOnlineConnection>]

EXAMPLES

------------------EXAMPLE 1------------------

PS:> Remove-PnPUserFromGroup -LoginName user@company.com -GroupName 'Marketing Site Members'

Removes the user [email protected] from the Group 'Marketing Site Members'

PARAMETERS

-Identity

A group object, an ID or a name of a group

Type: GroupPipeBind
Parameter Sets: (All)
Aliases: GroupName

Required: True
Position: Named
Accept pipeline input: False

-LoginName

A valid login name of a user ([email protected])

Type: String
Parameter Sets: (All)
Aliases: LogonName

Required: True
Position: Named
Accept pipeline input: False

-Connection

Optional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type: WebPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

RELATED LINKS

SharePoint Developer Patterns and Practices