Skip to content

Latest commit

 

History

History
137 lines (102 loc) · 2.93 KB

Set-PnPListPermission.md

File metadata and controls

137 lines (102 loc) · 2.93 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Set-PnPListPermission

SYNOPSIS

Sets list permissions

SYNTAX

Group

Set-PnPListPermission -Group <GroupPipeBind>
                      -Identity <ListPipeBind>
                      [-AddRole <String>]
                      [-RemoveRole <String>]
                      [-Web <WebPipeBind>]
                      [-Connection <SPOnlineConnection>]

User

Set-PnPListPermission -User <String>
                      -Identity <ListPipeBind>
                      [-AddRole <String>]
                      [-RemoveRole <String>]
                      [-Web <WebPipeBind>]
                      [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> Set-PnPListPermission -Identity 'Documents' -User '[email protected]' -AddRole 'Contribute'

Adds the 'Contribute' permission to the user '[email protected]' for the list 'Documents'

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

PS:> Set-PnPListPermission -Identity 'Documents' -User '[email protected]' -RemoveRole 'Contribute'

Removes the 'Contribute' permission to the user '[email protected]' for the list 'Documents'

PARAMETERS

-AddRole

The role that must be assigned to the group or user

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Group

Type: GroupPipeBind
Parameter Sets: Group

Required: True
Position: Named
Accept pipeline input: False

-Identity

The ID or Title of the list.

Type: ListPipeBind
Parameter Sets: (All)

Required: True
Position: Named
Accept pipeline input: False

-RemoveRole

The role that must be removed from the group or user

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-User

Type: String
Parameter Sets: User

Required: True
Position: Named
Accept pipeline input: False

-Connection

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

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: 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)

Required: False
Position: Named
Accept pipeline input: False

RELATED LINKS

SharePoint Developer Patterns and Practices