Show / Hide Table of Contents

    Remove-PnPUserFromGroup

    SYNOPSIS

    Removes a user from a group

    SYNTAX

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

    DESCRIPTION

    EXAMPLES

    EXAMPLE 1

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

    Removes the user user@company.com from the Group 'Marketing Site Members'

    PARAMETERS

    -Connection

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

    Type: PnPConnection
    Parameter Sets: (All)
    Aliases:
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Identity

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

    Type: GroupPipeBind
    Parameter Sets: (All)
    Aliases: GroupName
    
    Required: True
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -LoginName

    A valid login name of a user (user@company.com)

    Type: String
    Parameter Sets: (All)
    Aliases: LogonName
    
    Required: True
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: 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)
    Aliases:
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    RELATED LINKS

    SharePoint Developer Patterns and Practices

    Back to top Generated by DocFX spacer