Remove Permission activity

An activity that removes the permissions from a SharePoint site, site collection, list, library, or list item.



Configure the Remove Permission activity

To configure the Remove Permission activity, do the procedure in this topic.

Prerequisites

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, go to the Activity Library, and open the SharePoint SharePoint icon tab.
      2. On the SharePoint SharePoint icon tab, drag the Remove Permission Remove Permission icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click Remove Permission Remove Permission icon.
  3. Configure Remove Permission screen.
  4. Click Role Type Role Type icon.
  5. Configure Permission screen.

    For more information, refer to Remove a Permission from a SharePoint Resource.

  6. (Optional) Click Advanced Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the common information for a system activity.

Screen



Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Remove Permission

Specifies how to configure the activity to remove permissions in SharePoint.

Screen



Fields

Field Name Definition

SharePoint

Function:
Specifies the access token that connects to your SharePoint site.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Add Token Add Token icon

Opens this Screen:
Access Token for SharePoint
Function of this Screen:
Configure an access token to connect to SharePoint.

Remove Permission for

Function:
Specifies the site collection, site, subfolders, or an item for which to remove the permission.
Accepted Values:
  • Site Collection
  • Site
  • List/Library
  • List Item
Default Value:
Site Collection
Accepts Process Data Variables:
No

Site

Function:
Specifies the URL for your SharePoint site.
Accepted Values:
A valid SharePoint site URL
Default Value:
None
Accepts Process Data Variables:
Yes
Example:

List

Function:
Specifies the name of the SharePoint library or list.
To Open this Field:
  1. Select List/Library or List Item.
Accepted Values:
A valid SharePoint library name or list name.
Default Value:
None
Accepts Process Data Variables:
Yes

List Item ID

Function:
Specifies the ID of a SharePoint list item.
To Open this Field:
  1. Select List Item.
Accepted Values:
The ID of your SharePoint list item.
Default Value:
${ListItemID}
Accepts Process Data Variables:
Yes

Permission

Specifies how to configure the role type and permissions to remove.



Fields

Field Name Definition

Permission

Function:
Specifies the permissions to remove for a site collection, site, list, library, or a list item.
Accepted Values:
A list of permissions.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
QA Owners

Name

Function:
Specifies the name of the user or group with permissions to the site collection, site, list, library, or a list item.
Accepted Values:
A list of names.
Default Value:
None
Accepts Process Data Variables:
No

Type

Function:
Specifies the type of permission for the set site collection, site, list, library, or a list item.
Accepted Values:
  • User - A SharePoint user.
  • SharePoint Group - A group within a SharePoint site collection level
Default Value:
None
Accepts Process Data Variables:
No

Permission Level

Function:
Specifies the permission level for the SharePoint resource.
Accepted Values:
  • Full Control - Gives participants all permissions.
  • Design - Lets participants view, add, update, delete, and approve changes, and customize the resource.
  • Edit - Lets participants add, change and delete lists, list items, and files.
  • Contribute - Lets participants view, add, update, and delete list items and files.
  • Read - Lets participants view pages and list items and download files.
  • View Only - Lets participants view pages, list items, and files.
  • Create new subsites - Lets participants create new subsites
  • Approve - Lets participants edit and approve pages, list items, and documents.
  • Manage Hierarchy - Lets participants create sites and edit pages, list items, and documents.
  • Restricted Read - Lets participants view pages and documents, but not view historical versions or user permissions.
  • Restricted Interfaces for Translation - Lets participants open lists and folders, and use remote interfaces.
Default Value:
None
Accepts Process Data Variables:
No