Permissions Activities on Virtosoftware Guides & Docs

Remove user from SharePoint group

Thu, 24 Oct 2024 18:51:17 +0000

This activity allows removing member from a SharePoint group. SharePoint Designer phrase

If the user or secure group doesn’t exist, this method does nothing.

Parameters#

Input parameters

Parameter	Description	Example
The following user(s)	User login name, e-mail.Allowed multiple users or groups separated ';'.	“mycompany\john; john@gmail.com”
this group	Name or ID of theSharePoint group.	Home owners, 4, Home Viewers
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Remove permissions from site

Thu, 24 Oct 2024 18:51:10 +0000

This activity removes permission assignment from site. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
The following	Permission level string. Multi permission assignments are supported. Use ‘,’ or ‘;’ separator to grant several permission.Example:	Approve, Read, View Only.
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite
User(s)/group(s)	User login, e-mail, groupname, group ID	“user@domain”, “domain\user”. It allows multiplevalues separated by a semicolon.

Example

Remove permissions from list

Thu, 24 Oct 2024 18:51:03 +0000

This activity removes permission assignment from list. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
The following	Permission level string. Multi permission assignments are supported. Use ‘,’ or ‘;’ separator to grant several permission.Example:	Approve, Read, View Only.
Current list	Title or Url of chosen list. If the value field is empty, current list will be used.	Tasks[%Workflow Context:List Name%]/Lists/ Tasks
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite
User(s)/group(s)	User login, e-mail, groupname, group ID	“user@domain”, “domain\user”. It allows multiplevalues separated by a semicolon.

Example

Remove permissions from list item

Thu, 24 Oct 2024 18:50:56 +0000

This activity removes permission assignment from list item. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
The following	Permission level string. Multi permission assignments are supported. Use ‘,’ or ‘;’ separator to grant several permission.Example:	Approve, Read, View Only.
Current item	Item ID. If the value field isempty, current item ID will be used.	[%Variable:ItemID%], Current Item:ID
Current list	Title or Url of chosen list. If the value field is empty, current list will be used.	Tasks[%Workflow Context:List Name%]/Lists/ Tasks
Current site	The URL of a source SharePoint site. If the value field is empty, current site will be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite
User(s)/group(s)	User login, e-mail, groupname, group ID	“user@domain”, “domain\user”. It allows multiplevalues separated by a semicolon.

Example

Remove all site permissions

Thu, 24 Oct 2024 18:50:47 +0000

This activity deletes all roles assigned to users on site. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Remove all list permissions

Thu, 24 Oct 2024 18:50:37 +0000

This activity removes all permission assignment from list, breaking list permission inheritance if necessary.

SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
Current list	Title or Url of chosen list. If the value field is empty, current list will be used.	Tasks[%Workflow Context:List Name%]/Lists/ Tasks
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Remove all list item permissions

Thu, 24 Oct 2024 18:50:31 +0000

This activity removes all permission assignment from list item, breaking list permission inheritance if necessary.

SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
Current item	Item ID. If the value field isempty, current item ID will be used.	[%Variable:ItemID%], Current Item:ID
Current list	Title or Url of chosen list. If the value field is empty, current list will be used.	Tasks[%Workflow Context:List Name%]/Lists/ Tasks
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Grant Permission on site

Thu, 24 Oct 2024 18:50:22 +0000

The Grant Permission on Site activity enables you to assign specific permissions to users or groups on a SharePoint site. You can choose to override existing permissions or append new ones. The available permission levels include:

Full Control
Design
Contribute
Read

SharePoint Designer phrase

“Grant [Permission Level] permission on [Site URL] to [User(s)/Group(s)]. Override current permissions: [Yes/No].”

Parameters#

Input parameters

Parameter	Description	Example
The following	A string representing the permission level(s) to assign. Multiple permissions can be specified using ',' or ';' as separators.	Approve, Read, View Only.
Current site	The URL of the target SharePoint site. If left empty, the current site is used.	Examples: `https://contoso/SiteUrl` `[%Workflow Context:Current Site URL%]/subSite`
User(s)/group(s)	The login name, email, group name, or group ID of the user(s) or group(s) to grant permissions to. Multiple entries can be separated by a semicolon.	Examples: User: `user@domain.com` Domain\User: `domain\user`
Variable	Specifies whether to override existing permissions: No: Adds the new permission to existing permissions. Yes: Removes all old permissions and applies the new one.

Example

Grant Permission on list

Thu, 24 Oct 2024 18:50:16 +0000

The Grant Permission on List activity allows you to assign specific permissions to users or groups on a SharePoint list. You can choose to override existing permissions or append new ones. The available permission levels include:

Full Control
Design
Contribute
Read

SharePoint Designer Phrase:

“Grant [Permission Level] permission on [Current List] to [User(s)/Group(s)]. Override current unique permissions [Yes/No] "

Parameters#

Input parameters

Parameter	Description	Example
The following	A string representing the permission level(s) to assign. Multiple permissions can be specified using ',' or ';' as separators.	"Approve, Read, View Only".
Current list	The title or URL of the target list. If left empty, the current list is used.	Examples: Title: `Tasks` URL: `[%Workflow Context:List Name%]/Lists/Tasks`
Current site	The URL of the SharePoint site containing the list. If left empty, the current site is used.	Examples: `https://contoso/SiteUrl` `[%Workflow Context:Current Site URL%]/subSite`
User(s)/group(s)	The login name, email, group name, or group ID of the user(s) or group(s) to grant permissions to. Multiple entries can be separated by a semicolon.	Examples: User: `user@domain.com` Domain\User: `domain\user`
Variable	Specifies whether to override existing permissions: No: Adds the new permission to existing permissions. Yes: Removes all old permissions and applies the new one.

Example

Grant Permission on list item

Thu, 24 Oct 2024 18:50:07 +0000

This activity grants permission on the list item. You can override or append user grant permissions. Value of permission field by default can be one of the following values:

Full Control Design Contribute Read

SharePoint Designer phrase

The activity supports multi permission assignment. Use ‘,’ or ‘;’ separator to grant several permission.

Example: “Approve, Read, View Only”.

Parameters#

Input parameters

Parameter	Description	Example
The following	Permission level string. Multi permission assignments are supported. Use ‘,’ or ‘;’ separator to grant several permission.Example:	Approve, Read, View Only.
Current item	Item ID. If the value field is empty, current item ID will be used.	[%Variable:ItemID%], Current Item:ID
Current list	Title or Url of chosen list. If the value field is empty, current list will be used.	Tasks[%Workflow Context:List Name%]/Lists/ Tasks
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite
User(s)/group(s)	User login, e-mail, groupname, group ID	“user@domain”, “domain\user”. It allows multiplevalues separated by a semicolon.
Variable	Override current permissions	No – a new permission will be added to existed permissionsYes – a new permission will override (remove) all oldpermissions

Example

Get members of SharePoint group

Thu, 24 Oct 2024 18:50:01 +0000

This activity returns collection of SharePoint group members. Supports “Distinguished Name” or “Account Name” output format.

SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
This group	Name or ID of theSharePoint group.	Home owners, 4, Home Viewers
Current site	The URL of the site collection to which the user account is being added. Default value is current site collection.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl; [%Workflow Context:Current Site URL%]/subSite
Variable	Result is Dynamic value	[{"Id": "27","LoginName": "i:0#.f\|membership\|john@contoso.microsoft.com","Email": "john@contoso.onmicrosoft.com"}, {"Id": "23","LoginName": "i:0#.f\|membership\| john @contoso.microsoft.com","Email": " john @contoso.microsoft.com"}]

Example

Check if user is a member of SharePoint group

Thu, 24 Oct 2024 18:49:54 +0000

This condition checks that user is member of specified SharePoint group. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
The following user(s)	User login name, e-mail.Allowed multiple users or groups separated ';'.	“mycompany\john; john@gmail.com”
This group	Name or id of theSharePoint group.	Home Owners, Home Viewers, 5
Current site	The URL of the site collection to which the user account is being added.Default value is current site url.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite
Variable	Override current permissions	No – a new permission will be added to existed permissionsYes – a new permission will override (remove) all oldpermissions

Example

Add user to SharePoint group

Thu, 24 Oct 2024 18:49:47 +0000

This activity adds user to existing SharePoint group. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
The following user(s)	User login name, e-mail. Allowed multiple users orgroups separated ';'.	“mycompany\john; john@gmail.com”
This group	Name or ID of theSharePoint group.	Home owners, 4, Home Viewers
Current site	The URL of the site collection to which the user account is being added.Default value is current site collection.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Restore inhereting permissions on site

Thu, 24 Oct 2024 18:49:37 +0000

This activity restores inheriting permission from Parent for specified site. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Restore inhereting permissions on list

Thu, 24 Oct 2024 18:49:25 +0000

This activity restores inheriting permission from Parent for specified list. SharePoint Designer phrase

Parameters#

Input parameters

Parameter

Description

Example

Current list	Title or Url of chosen list. If the value field is empty, current list will be used.	Tasks[%Workflow Context:List Name%]/Lists/ Tasks
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Restore inhereting permissions on list item

Thu, 24 Oct 2024 18:49:16 +0000

This activity restores inheriting permission from Parent for specified list item. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
Current item	Item ID. If the value field isempty, current item ID will be used.	[%Variable:ItemID%], Current Item:ID
Current list	Title or Url of chosen list. If the value field is empty, current list will be used.	Tasks[%Workflow Context:List Name%]/Lists/ Tasks
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Stop inhereting permissions on site

Thu, 24 Oct 2024 18:49:09 +0000

This activity stops inheriting permission from Parent for specified site. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Stop inhereting permissions on list

Thu, 24 Oct 2024 18:49:02 +0000

This activity stops inheriting permission from Parent for specified list. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
Current list	Title or Url of chosen list. If the value field is empty, current list will be used.	Tasks[%Workflow Context:List Name%]/Lists/ Tasks
Current site	The URL of a source SharePoint site. If the value field is empty, current sitewill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Stop inhereting permissions on list item

Thu, 24 Oct 2024 18:48:54 +0000

This activity stops inheriting permission from Parent for specified list item. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
Current item	Item ID. If the value field is	[%Variable:ItemID%], Current Item:ID

	empty, current item ID willbe used.
Current list	Name or Url of chosen list. If the value field is empty, current list will be used.	Tasks[%Workflow Context:List Name%]/Lists/ Tasks
Current site	The URL of a source SharePoint site. If the value field is empty, current site will be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example