Add-PnPUserToGroup

Adds a user to a group

Syntax

Add-PnPUserToGroup
   -LoginName <String>
                     -Identity <GroupPipeBind>
                     [-Web <WebPipeBind>]
                     [-Connection <SPOnlineConnection>]
Add-PnPUserToGroup
   -Identity <GroupPipeBind>
                     -EmailAddress <String>
                     [-SendEmail [<SwitchParameter>]]
                     [-EmailBody <String>]
                     [-Web <WebPipeBind>]
                     [-Connection <SPOnlineConnection>]

Examples

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

Add-PnPUserToGroup -LoginName user@company.com -Identity 'Marketing Site Members'

Add the specified user to the group "Marketing Site Members"

------------------EXAMPLE 2------------------

Add-PnPUserToGroup -LoginName user@company.com -Identity 5

Add the specified user to the group with Id 5

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:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-EmailAddress

The email address of the user

Only applicable to: SharePoint Online

Type:String
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-EmailBody

Only applicable to: SharePoint Online

Type:String
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Identity

The group id, group name or group object to add the user to.

Type:GroupPipeBind
Position:Named
Accept pipeline input:True
Accept wildcard characters:False
-LoginName

The login name of the user

Type:String
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-SendEmail

Only applicable to: SharePoint Online

Type:SwitchParameter
Position:Named
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
Position:Named
Accept pipeline input:False
Accept wildcard characters:False