SharePoint.BuildingBlocks.Permissions

Building blocks to manage the permissions.

Delete Group

Deletes the group(s) from the specified site. Multiple group can be deleted by specifying the group names in the 'Group Name' field separated by a semicolon.

Input Fields

Name	Required?	Description
Group Name	optional	The name of the group.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Delete Permission Level

Deletes a specific permission level from a list, an item from that list or to the group itself. Applies to a web when 'List', 'Title' is left empty and 'Item Id' is left on the default value. Applies to a list when 'Title' is left empty and 'Item Id' is left on the default value. Deleting a permission level breaks the inheritance of permissions.

Multiple permission levels on multiple groups can be removed on multiple lists. Those fields can be used with multiple values semicolon separated.

Input Fields

Name	Required?	Description
Group Name	optional	The name of the group.
Item Id	optional	The ID of a list item.
List	optional	The title or GUID of a list.
Permission Level	optional	The permission level to apply. Standard values: Read, Contribute, Administrator, Guest, WebDesigner, "". It is also possible to provide a custom created permission. Default: "".
Title	optional	The title of a list item.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Ensure Group

Ensures a group on the specified site. If the group already exists, it is updated. Multiple group can be ensured by specifying the group names in the 'Group Name' field separated by a semicolon.

Input Fields

Name	Required?	Description
Allow Members To Edit Membership	optional	Only allow members to edit the membership of the group. Default: False. False = Group Owner, True = Group Members.
Allow Requests To Join/Leave	optional	If set to true users can request membership in this group and allow users to request to leave the group. Default: False.
Auto Accept Request To Join/Leave	optional	If set to true, any user requesting access to this group will automatically be added as a member of the group and receive the permission levels associated with the group. Default: False.
Group Description	optional	The description of the group.
Group Name	optional	The name of the group.
Group Owner	optional	The owner of the group. Can be another SharePoint group or an AD user/group.
Only Allow Members To View Membership	optional	Only allow members to view the membership of the SharePoint group. Default: True. True = Members, False = Everyone.
Permission Level	optional	The permission level to apply. Standard values: Read, Contribute, Administrator, Guest, WebDesigner, "". It is also possible to provide a custom created permission. Default: "".
Request To Join Leave Email Setting	optional	The mail address which will be used to send the membership requests to if 'Auto Accept Request To Join/Leave' is set to true. Default: "".
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Ensure Permission

Ensure a definition of a permission level to a site that can be used to assign to a list, an item from that list or to the group itself.

Input Fields

Name	Required?	Description
Description	optional	Description of the permission level.
Name	required	Name of the permission level.
Parent Permission	optional	If specified all permission kinds of this parent permission wil be added to the new permission.
Permission Kinds	optional	Specifies the kind of permissions that are used to define user roles. Can be left empty if a parent permission is specified. If a parent permission is specified these permission kinds are added on top of the parent permission. They must be separated by a semicolon. E.g 'AddListItems;EditListItems;'. Accepted values: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.permissionkind.aspx.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Ensure Permission Inheritance

Applies permission inheritance on the given context which can be a list or a provided item in a list.

Input Fields

Name	Required?	Description
Item Id	optional	The ID of a list item.
List	optional	The title or GUID of a list.
Title	optional	The title of a list item.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Ensure Permission Level

Applies an existing permission level to a list, an item from that list or to the group itself. Applies to a web when 'List', 'Title' is left empty and 'Item Id' is left on the default value. Applies to a list when 'Title' is left empty and 'Item Id' is left on the default value. Ensuring a permission level breaks the inheritance of permissions.

Multiple permission levels on multiple groups can be ensured on multiple lists. Those fields can be used with multiple values semicolon separated.

Input Fields

Name	Required?	Description
Clear Existing Permissions	optional	If set to true, all existing configured permissions of different groups and users on the specified list, item from that list or the group itself, will be removed.
Group Name	optional	The name of the group.
Item Id	optional	The ID of a list item.
List	optional	The title or GUID of a list.
Permission Level	optional	The permission level to apply. Standard values: Read, Contribute, Administrator, Guest, WebDesigner, "". It is also possible to provide a custom created permission. Default: "".
Title	optional	The title of a list item.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Ensure User

Ensures a user on the specified site. If a group is provide the user will be added to that group. If no group is specified the user is added to the site with the specified permission level.

Input Fields

Name	Required?	Description
Email	optional	Email address of the user.
Group Name	optional	The name of the group.
Is Site Collection Administrator	optional	If set to true, the user will be added as an administrator to the site collection.
Login Name	required	The login name of the user. SharePoint On Premise: with domain prefix. SharePoint Online: email address.
Permission Level	optional	The permission level to apply. Standard values: Read, Contribute, Administrator, Guest, WebDesigner, "". It is also possible to provide a custom created permission. Default: "".
Title	optional	The title of a list item.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.