Set-PnPWebPermission

Set permissions

Syntax

Set-PnPWebPermission
   -Group <GroupPipeBind>
                       [-AddRole <String[]>]
                       [-RemoveRole <String[]>]
                       [-Web <WebPipeBind>]
                       [-Connection <SPOnlineConnection>]
Set-PnPWebPermission
   -User <String>
                       [-AddRole <String[]>]
                       [-RemoveRole <String[]>]
                       [-Web <WebPipeBind>]
                       [-Connection <SPOnlineConnection>]
Set-PnPWebPermission
   -Identity <WebPipeBind>
                       -Group <GroupPipeBind>
                       [-AddRole <String[]>]
                       [-RemoveRole <String[]>]
                       [-Web <WebPipeBind>]
                       [-Connection <SPOnlineConnection>]
Set-PnPWebPermission
   -Identity <WebPipeBind>
                       -User <String>
                       [-AddRole <String[]>]
                       [-RemoveRole <String[]>]
                       [-Web <WebPipeBind>]
                       [-Connection <SPOnlineConnection>]
Set-PnPWebPermission
   -Url <String>
                       -Group <GroupPipeBind>
                       [-AddRole <String[]>]
                       [-RemoveRole <String[]>]
                       [-Web <WebPipeBind>]
                       [-Connection <SPOnlineConnection>]
Set-PnPWebPermission
   -Url <String>
                       -User <String>
                       [-AddRole <String[]>]
                       [-RemoveRole <String[]>]
                       [-Web <WebPipeBind>]
                       [-Connection <SPOnlineConnection>]

Description

Sets web permissions

Examples

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

Set-PnPWebPermission -Url projectA -User 'user@contoso.com' -AddRole 'Contribute'

Adds the 'Contribute' permission to the user 'user@contoso.com' for a web, specified by its site relative url

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

Set-PnPWebPermission -Identity 5fecaf67-6b9e-4691-a0ff-518fc9839aa0 -User 'user@contoso.com' -RemoveRole 'Contribute'

Removes the 'Contribute' permission to the user 'user@contoso.com' for a web, specified by its ID

Required Parameters

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

Identity/Id/Web object

Type:WebPipeBind
Position:Named
Accept pipeline input:True
Accept wildcard characters:False
-Url

The site relative url of the web, e.g. 'Subweb1'

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

Optional Parameters

-AddRole

The role that must be assigned to the group or user

Type:String[]
Position:Named
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:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-RemoveRole

The role that must be removed from the group or user

Type:String[]
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