Set-PnPWebPermission
SYNOPSIS
Sets web permissions.
SYNTAX
Set group permissions
Set-PnPWebPermission -Group <GroupPipeBind> [-Identity <WebPipeBind>] [-AddRole <String[]>] [-RemoveRole <String[]>] [-Connection <PnPConnection>]
Set user permissions
Set-PnPWebPermission -User <String> [-Identity <WebPipeBind>] [-AddRole <String[]>] [-RemoveRole <String[]>] [-Connection <PnPConnection>]
DESCRIPTION
This cmdlet adds permissions to a user or a group or removes permissions from a user or a group.
EXAMPLES
EXAMPLE 1
Set-PnPWebPermission -User "user@contoso.com" -AddRole "Contribute"
Adds the "Contribute" permission role to the specified user in the current web.
EXAMPLE 2
Set-PnPWebPermission -Group "Project Managers" -AddRole "Contribute"
Adds the "Contribute" permission role to the "Project Managers" group in the current web.
EXAMPLE 3
Set-PnPWebPermission -Identity projectA -User "user@contoso.com" -AddRole "Contribute"
Adds the "Contribute" permission role to the user "user@contoso.com" in the subweb of the current web with site relative url "projectA".
EXAMPLE 4
Set-PnPWebPermission -User "user@contoso.com" -AddRole "Custom Role 1","Custom Role 2"
Adds the specified permission roles to the user "user@contoso.com" in the current web.
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)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-User
The name of the user.
Type: String
Parameter Sets: Set user permissions
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Group
The name of the group.
Type: String
Parameter Sets: Set group permissions
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AddRole
The name of the permission level to add to the specified user or group.
Type: String[]
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RemoveRole
The name of the permission level to remove from the specified user or group.
Type: String[]
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identity
The guid or site relative url of the web to use.
Type: WebPipeBind
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False