There are various reasons that one requires elevated privileges to list/site workflow. Most common use case is, if workflow need to fetch data from some other list/library at site collection/sub site level.
SharePoint App-Only is the older, but still very relevant, model of setting up app-principals. This model works for both SharePoint Online and SharePoint 2013/2016 on-premises and is ideal to prepare your applications for migration from SharePoint on-premises to SharePoint Online. Below steps show how to setup an app principal with tenant full control permissions, but obviously you could also grant just read permissions using this approach.
- SharePoint 2013/2016
- SharePoint Online
This blog is also targets resolution of following error:
The Workflow was Suspended with Unauthorized HTTP
Unauthorized HTTP to /_vti_bin/client.svc/web/lists
By default, the SharePoint workflow doesn’t have sufficient permission to access the SharePoint lists, and this process requires a full control permission level.
Some important point before enabling App Step:
- To allow the workflow to use APP permissions, you must be a Site Owner or Site Collection Administrator.
- App Step can be activated at Tenant/Site Collection/Web.
- The Workflow Manager platform must be configured properly to be able to activate “Workflows can use app permissions” feature.
- The App Management Service must be configured to be able to grant a full control permission to a workflow.
- App step provides the workflow authorization for its Identity as a Full Control and ignores the current user permission.
- The SharePoint 2010 workflow is not supported in App Step,
- If you don’t elevate the permissions for the SharePoint Workflow, The App Step will be disabled in the SharePoint Designer.
To begin the elevation process, follow below steps:
- Allow workflow to use app permissions
- Grant full control permission to a workflow
- Develop the workflow actions inside an App Step using SharePoint Designer
Lets deep dive in details of all three steps mentioned above.
I. Allow workflow to use app permissions:
The Workflow Manager platform must be configured properly to be able to activate “Workflows can use app permissions” feature. This feature is scoped to the web level feature so in case of site collection or web. This feature is available under web features.
- Open the SharePoint Site > Site Settings.
- Below Site Actions > Select Manage site features.
- Activate Workflows can use app permissions feature.
In above step, we have ensured that after activating this feature, workflow can able to use permission which we will define under next step.
II. Grant full control permission to a workflow
- Open the SharePoint Site Collection > Site Settings >Below Users and Permissions > Click on Site App Permissions.
- Copy the client section of the App Identifier. The App Identifier is the identifier Guid between the last “|” and the “@” sign, as shown below.
- Navigate to grant permission to an app page by browsing the “appinv.aspx” page of the web site.
- Paste the client section of App Identifier to the App Id field.
- Click Lookup to fetch the required info.
- The App Management Service must be configured to be able to lookup your identifier. If the App Management Service is not installed you will get the below error when you clicked on Lookup button.
- Paste the below APP Permissions Request XML to grant full control permission. Make sure tags and attribute names are in correct casing because small case will not be detected.
<AppPermissionRequest Scope="http://sharepoint/content/sitecollection/web" Right="FullControl">
- You will then be asked to trust the Workflow app, Click Trust It.
III. Develop the workflow actions inside an App Step using SharePoint Designer
The App Step option will be disabled in the SharePoint Designer, in case you are not followed above mentioned steps. Using App step will allow the workflow to be authorized with its identity as a Full Control and ignore the current user permissions. This is will ensure that the workflow will be executed successfully in case the current user has no permissions.
Good to Go !! Once it is added it to workflow, it is easy to write any action under it.
NOTE: If you still see app step as disabled then close the SPD instance and reopen it. If still not see it enabled, then make sure you have done above steps in correct site collection/web.
NOTE: Make sure, Under Workflow Settings > Uncheck the “Automatic updates to workflow status to the current stage name“, then click Publish.
If you didn’t uncheck “Automatic updates to workflow status to the current stage name“, the current user will require Edit permission on the list to can edit the workflow status.
Happy SharePointing !!