Set-PnPGroupPermissions

Tip

We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Set-PnPGroupPermissions.md to change this file.

Adds and/or removes permissions of a specific SharePoint group

Syntax

Set-PnPGroupPermissions
   [-Identity] <GroupPipeBind>
   [-List <ListPipeBind>]
   [-AddRole <String[]>]
   [-RemoveRole <String[]>]
   [-Connection <PnPConnection>]
   [<CommonParameters>]

Examples

EXAMPLE 1

Set-PnPGroupPermissions -Identity 'My Site Members' -AddRole Contribute

Adds the 'Contribute' permission to the SharePoint group with the name 'My Site Members'

EXAMPLE 2

Set-PnPGroupPermissions -Identity 'My Site Members' -RemoveRole 'Full Control' -AddRole 'Read'

Removes the 'Full Control' from and adds the 'Contribute' permissions to the SharePoint group with the name 'My Site Members'

EXAMPLE 3

Set-PnPGroupPermissions -Identity 'My Site Members' -AddRole @('Contribute', 'Design')

Adds the 'Contribute' and 'Design' permissions to the SharePoint group with the name 'My Site Members'

EXAMPLE 4

Set-PnPGroupPermissions -Identity 'My Site Members' -RemoveRole @('Contribute', 'Design')

Removes the 'Contribute' and 'Design' permissions from the SharePoint group with the name 'My Site Members'

EXAMPLE 5

Set-PnPGroupPermissions -Identity 'My Site Members' -List 'MyList' -RemoveRole @('Contribute')

Removes the 'Contribute' permissions from the list 'MyList' for the group with the name 'My Site Members'

Parameters

-AddRole

Name of the permission set to add to this SharePoint group

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Identity

Get the permissions of a specific group by name

Type:GroupPipeBind
Aliases:Name
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-List

The list to apply the command to.

Type:ListPipeBind
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RemoveRole

Name of the permission set to remove from this SharePoint group

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False