Microsoft SharePoint Online Spoke
- UpdatedAug 1, 2024
- 9 minutes to read
- Washington DC
- Now Platform Capabilities
The Microsoft SharePoint Online spoke integrates your ServiceNow® instance with Microsoft SharePoint Online so that you can automate various predefined actions as part of a Workflow. For example, you can rename a folder on Microsoft SharePoint Online when a record in the database is updated.
Request apps on the Store
Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Integration Hub subscription
This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.
Spoke version
Microsoft SharePoint Online spoke v2.9.1 is the latest version.
Spoke dependencies
If you’re having trouble installing the app, ensure that these dependent plugins are installed:
- ServiceNow Integration Hub Runtime (com.glide.hub.integration.runtime)
- ServiceNow Integration Hub Action Step - REST (com.glide.hub.action_step.rest)
- Complex Object (com.glide.cobject)
- ServiceNow Flow Designer - Dynamic Inputs (com.glide.hub.dynamic_inputs)
- ServiceNow Integration Hub Action Step - REST (com.glide.hub.action_step.rest)
- ServiceNow Integration Hub Action Template - Data Stream (com.glide.hub.action_type.datastream)
Supported versions
Microsoft SharePoint Application Programming Interface (API) version v1.
Spoke flows
The Microsoft SharePoint Online spoke provides sample flows in the draft state to demonstrate automating the Microsoft SharePoint Online tasks. To customize a sample flow, copy it to a new application scope. The following table shows the available sample flows.
Flow | Description |
---|---|
New Attachment on Record creates folder, and copies attachment | When an attachment is created in a database table, a folder is created for a knowledge record on the Microsoft SharePoint Online spoke. Then, the attachment is copied to the folder. |
Create Site For Knowledge Base | When a knowledge base is created in the database table, the flow creates a site for it on the Microsoft SharePoint Online |
- If the single sign-on (SSO) is set up, you can use the action Look Up User Information By Login Name and verify that you're approved to perform the spoke actions.
- Flow designers and action designers must ensure that the user authorization checks are performed before the flow or action is executed.
Spoke subflows
The Microsoft SharePoint Online spoke provides a sample subflow in the draft state to demonstrate automating Microsoft SharePoint Online tasks. To customize the subflow, copy it to a new application scope.
Subflow | Description |
---|---|
Remove Then Add A User To A Group | Removes a user from a Microsoft SharePoint Online group and adds a new user. |
Delete Modern Site (without O365 Group) | Deletes the modern site associated with Non O365 Group (communication site). |
Submit Modern Site (with O365 Group) for Deletion |
Submits a modern Site (with O365 Group) for Deletion.
Note: It may take up to 30 minutes for site to move under deleted sites section of SharePoint Admin portal. |
Spoke actions
The Microsoft SharePoint Online spokeprovides actions to automate various Microsoft SharePoint Online tasks that are based on the triggers in the ServiceNow instance.
You can perform some actions by using the SharePoint Online connection and the remaining actions by using the SharePoint Graph connection.
Actions using the Sharepoint Online connection and credential alias record | ||
---|---|---|
Category | Action | Description |
Site Management | Create Modern Site | Creates a modern site of types Communication sites and Non-group associated Team Sites. |
Create Subsite | Creates a subsite on Sharepoint Online. The Tenant determines the root location. | |
Delete Modern Site | Deletes the modern site associated with non-O365 Group (communication site). | |
Delete Modern Site with O365 Group | Submit the modern site associated with the O365 Group (team site) for deletion. It deletes the associated 0365 group that deletes the site. Note: After execution, it can take up to 30 minutes for a site to be
deleted. |
|
Delete Subsite | Removes a subsite from Sharepoint Online. The Connection URL used determines what is the Root location. | |
Look up Modern Site Group Information | Retrieves the associated O365 group details of a modern site (team site). | |
Look up Modern Site Information | Gets the details of a modern site. | |
Look up Changes For Site | Retrieves the changes for a site that is based on the query conditions. | |
Look up Role Assignments | Retrieves all the role assignments that are defined on the site. | |
Look Up Site Collection ID | Looks up a specific site ID. | |
Look Up Subsite Details | Looks up information about a subsite. | |
Update Site Information | Updates a Microsoft SharePoint Online site. | |
Folder Management | Create Folder | Creates a folder in a document library on a Microsoft SharePoint Online site. |
Delete Folder | Deletes a folder in Microsoft SharePoint Online. Note: You receive no warning or notification before the folder is removed. |
|
List Files In A Folder | Gets a list of files in a folder. | |
List Folders In A Folder | Gets a list of the folders in a folder. | |
Look Up Folder | Looks up a folder in Microsoft SharePoint Online and returns its properties. For example, the output can contain the property "Relative URL". | |
Rename A Folder | Renames a folder in Microsoft SharePoint Online. | |
Share Folder With Group | Shares a folder with a group in Microsoft SharePoint Online. The group must belong to the Microsoft SharePoint Online tenant account. | |
Share Folder With User | Shares a folder with a user inMicrosoft SharePoint Online. The user must belong to the Microsoft SharePoint Online tenant account. | |
Unshare Folder With Group | Removes the access to a folder from a group. The group must belong to the Microsoft SharePoint Online tenant account. | |
Unshare Folder With User | Removes the access to a folder from a user. The user must belong to the Microsoft SharePoint Online tenant account. | |
File Management | Attach Sharepoint File To A Record | Attaches a Microsoft SharePoint Online file to a ServiceNow record. |
Check-in File | Sets a file in the Microsoft SharePoint Online in the checked in state. To find the version number of the file after its state is set to checked in, use the Look Up File Details action, Note: The file is already
uploaded and the action just updates the status of the file to be checked in. |
|
Check-out File | Sets a file in the Microsoft SharePoint Online in the checked out state. To find the version number of the file after its state is set to checked out, use the Look Up File Details action, Note: The file is already
downloaded and the action just updates the status of the file to checked out. |
|
Copy Attachment To Folder | Copies a ServiceNow attachment to a Microsoft SharePoint Online folder. | |
Copy File | Copies a file with a new name. | |
Create A Text File | Creates a text file with the information that you provide. | |
Delete File | Deletes a file in Microsoft SharePoint Online. | |
Look Up File Details | Looks up the file details in Microsoft SharePoint Online. | |
Move File | Moves a file to another location in Microsoft SharePoint Online. | |
Share File With Group | Shares a file with a group inMicrosoft SharePoint Online. The group must belong to the Microsoft SharePoint Online tenant account. | |
Share File With User | Shares a file with a Microsoft SharePoint Online user. The user must belong to the Microsoft SharePoint Online tenant account. | |
Unshare File With Group | Removes the access to a file from a Microsoft SharePoint Online group. The group must belong to the Microsoft SharePoint Online tenant account. | |
Unshare File With User | Removes the access to a file from a Microsoft SharePoint Online user. The user must belong to the Microsoft SharePoint Online tenant account. | |
User Management | Look Up User Information By Login Name | Searches a Microsoft SharePoint Online site for information on a user and returns the information. |
Look Up User Information By Email | Searches the specified Microsoft SharePoint Online site for a given user and return SharePoint information about that account. | |
Look Up User's Sharepoint Groups | Searches the Microsoft SharePoint Online site for information on all groups that a user is a member of and returns the information. | |
Search Management | Look up Search Query Results Stream | Searches the SharePoint Root site and retrieves the result based on the provided search query. |
Group Management | Add Role To Site | Adds a role to a Microsoft SharePoint Online user or group. |
Add User To Group | Adds a user to a Microsoft SharePoint Online site group. | |
Create Group | Creates a group in a Microsoft SharePoint Online site. | |
Delete Group | Deletes a group on a Microsoft SharePoint Online site. | |
Look Up Group By Name | Looks up a group by its name in a site location in the Microsoft SharePoint Online. If no site location is specified, the action searches the root site of the tenant. | |
Remove Role From Site | Removes permissions from a group or a user. | |
Remove User From Group | Removes a user from a Microsoft SharePoint Online site group. | |
Update Group Owner (User) | Updates a user as the group owner. | |
Look up M365 Members by Site Group | Retrieves a list of the users and M365 groups associated with a Microsoft SharePoint Online Site Group. | |
List Management | Create List | Creates a list in a Microsoft SharePoint Online site with its title and description. |
Create List Subscription | Creates a webhook subscription for a list. | |
Delete List By ID | Deletes a list in a Microsoft SharePoint Online site by its ID. | |
Look Up List Details By ID | Looks up a list in a Microsoft SharePoint Online site by its ID. | |
Look Up List ID By Title | Looks up a list in a Microsoft SharePoint Online by its title. | |
Update list in a site by ID | Updates a list in a Microsoft SharePoint Online site by its ID. | |
List Item Management | Create List Item | Creates a list item inside a list. |
Delete List Item By ID | Deletes a list item by both the list ID and the list item ID. | |
Look Up List Item By ID | Looks up a list item by both the list ID and the list item ID. | |
Look Up List Items In A List | Gets a list of items from a list in different formats. | |
Update List Item By ID | Updates a list item title by its ID. |
Actions using the SharePoint Graph connection and credential alias record | ||
---|---|---|
Category | Action | Description |
Change Management | Get Change Query Properties | Retrieves the change query properties that are used to define a query that is performed against the change log. |
Get Delta Link Token For Drive | Retrieves the latest delta link token for a drive. | |
Get Next Token | Retrieves the next link token from the SharePoint Resource Next Link Token table. | |
File Management | Get File Download Link | Retrieves the download URL of the file. |
Look up File Permissions | Gets the permissions for a file. | |
Look up Files | Retrieves all the files in a drive. | |
List Management | Create List Subscription | Creates a webhook subscription for a list. |
Renew List Subscription | Renews a webhook subscription for a list. | |
Delete List Subscription | Deletes the webhook subscription for a list. | |
Get List | Retrieves the details of a list from the SharePoint tenant. | |
Look up Drives | Retrieves all the drives for a site. | |
Site Management | Look up Site Collections | Retrieves all the site collections. |
Look up Subsites | Retrieves details of all the subsites in a site. | |
Create Root Site Subscription | Creates a webhook subscription for a root site. | |
Look up Site Permissions | Retrieves all permissions for a site. | |
Get Site | Gets the site details. |
SharePoint Online account requirements
The Microsoft SharePoint Online spoke requires that you create a custom app on your SharePoint Online account to generate OAuth 2.0 tokens. See Configure OAuth application in Microsoft Azure.
Connection and credential alias requirements
Integration Hub uses aliases to manage connection and credential information, and OAuth credentials. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection.
- Single tenant
- This spoke includes the MicrosoftSharepointOnline alias record to authorize actions on Microsoft SharePoint Online. Select this alias in the Tenant record to authorize changes in Microsoft SharePoint Online for a single tenant.
- Multiple tenants
- This spoke includes the MicrosoftSharepointOnline alias record to authorize actions on Microsoft SharePoint Online. Create a connection and credential alias record for each additional tenant site that you want to support. Select the correct alias in the Tenant record to authorize changes in Microsoft SharePoint Online. Create a connection and credential alias record for each additional tenant site that you want to support. Select the correct alias in the Tenant record to authorize changes in Microsoft SharePoint Online. See Create aliases for multiple tenants.
Three alias records are available by default with the spoke; Sharepoint Online, SharePoint Graph, and SharePoint Graph Root Site Subscription. Each alias record requires a tenant to be associated with it. If you intend to use all SharePoint Online, Graph, and Root Subscription actions in the spoke, you must ensure that you have created three tenant records in the Tenants tables of the Microsoft SharePoint Online spoke so that each tenant record is associated with its respective alias record.
- If configuring an integration for a single tenant, use the existing MicrosoftSharepointOnline alias record.
- You can use multiple tenants with the Microsoft SharePoint Graph connection alias only.