Remove Permission activity

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


Remove Permission activity

Configure the Remove Permission activity

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

Examples

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, and open the SharePoint tab.

    Open SharePoint tab
  3. On the SharePoint tab, drag the Remove Permission activity onto your process.

    Drag Remove Permission activity

General Configuration

Specifies the basic settings for the Remove Permission activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

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:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

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.

Figure: Remove Permission screen

Remove Permission screen

Fields

Field NameDefinition

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:

Create Add Token icon
Opens this Screen:
Access Token for SharePoint
Function of this Screen:
Configure an access token to connect to SharePoint.
Example:
Refer to:

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
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Permission

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

Figure: Permission screen

Permission screen

Fields

Field NameDefinition

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:
One or more permissions from the list.

When you select the access token from the SharePoint field on the Set Permission screen, this field shows the permissions associated with the access token.

Default Value:
None
Accepts Process Data Variables:
No