SharePoint update item permissions

Nintex external platform is required for this feature. For details, see Enable Nintex external platform features.

Updates permissions for existing list items in a SharePoint 2010, SharePoint 2013, or Office 365 SharePoint site.

Note: Not available for SharePoint 2007 sites.

Action settings

Following are the fields and options visible in the configuration settings dialog box for this action.

Section Field Description

(unlabeled)

Destination site URL

The URL of the site.

 

List name

The name of the list containing the items.

 

Items to update

Specify a query to determine which items are to be updated, specify whether or not to update folders and items within subfolders, and add filters to the query.

  • Query builder: Build a query to filter for items to update. View the CAML at any time by switching to the CAML Editor mode.
  • CAML editor: Create a more advanced query using XML encoding.

Scope: Specify options to determine the view scope of updates. Select or clear the following check boxes.

  • Include items in subfolders: When selected, updates items within subfolders.
  • Include folders: When selected, updates folders.

Filters: Specify the criteria that items must match for the permission to be updated. Select one of the following options.

  • Update all list item permissions: Updates all items in the list or document library.
  • Update items only when the following is true: Updates an item permission based on the values set in the column.
    • Update the items when column / When column: Specify a column, select an operator, and specify a value.

    • Add filter rule: Add a filter.
    • Delete (): Delete a filter. Displayed for second and subsequent filters.
    • And / Or: Specify how to group sequential filters.

 

Inherit permissions from parent Specify if the item permission will link to the parent permission set (the permissions used in the library or list that contains the item). Inheriting permissions does not apply any other permission settings.

 

Remove existing permissions Specify whether or not to clear the permissions that are currently set on the item before adding the new permissions. If the item currently inherits its permissions from the parent list, unselecting this option will cause the inherited permissions to be copied to the items.

User permissions

Target

Specify the target. Select one of the following items.

  • User
  • Group

 

User or group name

Specify one or more target-dependent values to assign access permissions for the specified items.

  • For the Target selection of User, specify one or more users following the format for the specified authentication mode.
    • For Windows authentication mode, use domain and user name.
    • For Forms authentication mode, use username.
    • For Office 365 authentication mode, use email address.
  • For the Target selection of Group, specify one or more SharePoint group names.

 

Permission

Specify the level of permission that can be assigned to a user or group for the item. Unless Remove existing permissions is selected, the permission will be added to the user's existing rights. Select one of the following items.

  • Full Control
  • Design
  • Edit

    Note: The Edit option is only available on SharePoint 2013.

  • Contribute
  • Read
  • View Only
  • Remove

Credentials

Authentication mode The mode to authenticate against the destination site.

 

Username

Specify a username with permissions to update the items in the destination site.

 

Password

Specify the password for the above username.

 

Domain or SharePoint Online website domain

Specify the domain for the username if using Windows authentication mode, or specify the SharePoint Online domain URL if connecting to an Office 365 SharePoint Online site.

(unlabeled)

Output

Store output for this action using the following selections.

  • All matched items updated: Specify a Yes/No variable to store whether or not all matched items have been updated. Returns "Yes" if all matched items were successfully updated.
  • List item ID: Specify a collection variable to store the ID of the updated items.
  • List item URL: Specify a collection variable to store the URL of updated items.