# SharePoint
SharePoint (opens new window) is a web-based collaboration, document management and storage system integrated with Microsoft Office. It is primarily used for document management and storage but is highly configurable and usage varies substantially among organizations.
Workato's SharePoint connector enables you to build integrations and automations around SharePoint and other third-party applications.
# API version
The SharePoint connector uses the SharePoint REST API v1 (opens new window).
# How to connect to SharePoint on Workato
To connect SharePoint to Workato, you must have an Azure account. Workato supports the following authentication methods:
# Authorization code grant connection
This method requires the following fields: Subdomain Client ID (optional) Client Secret (optional)
# Step 1: Register the Workato app in SharePoint and generate a client ID and secret
Complete the following steps to register the Workato app and generate a client ID and secret for authorization code grant connections.
Select Microsoft Entra ID > App registrations > New registration, under Azure services.
Enter a unique name for the application and select a supported account type.
Select Web from the Select a platform drop-down.
Enter https://www.workato.com/oauth/callback as the Redirect URI and select Register.
Select API Permissions > Add a permission from the left-hand menu.
Select the SharePoint option, under Commonly used Microsoft APIs.
Select the Delegated permissions option.
Expand AllSites within the Select permissions options and select the AllSites.Read (Delegated) checkbox.
Select Certificates & secrets > New client secret from the left-hand menu.
Enter a description for the client secret and set an expiration date for the secret using the Expires drop-down.
Select Add to create the client secret.
Select the Copy to clipboard icon next to the Value after you create the secret. This is your Client Secret. Save the value in a secrets vault.
Navigate to Overview from the left-hand menu and copy the Application (client) ID value. This is your Client ID.
You can now configure your SharePoint connection in Workato, using the API permissions you set up in the Azure Portal.
# Step 2: Complete setup in Workato
Log in to your Workato account and navigate to the project where you plan to add your Microsoft SharePoint connection.
Click Create > Connection > select Microsoft Sharepoint as your connection.
Select the Authorization code grant option from the Authentication type drop-down menu.
Provide a unique Connection name that identifies to which SharePoint instance it is connected.
Enter your SharePoint subdomain as found in your SharePoint URL. For example, if your SharePoint URL is https://abc.sharepoint.com, the subdomain is abc.
Provide the client ID generated in SharePoint by completing the preceding steps.
Provide the client secret generated in SharePoint by completing the preceding steps.
Provide the name of the SharePoint site to which you plan to connect in the Site name field. If left blank, Workato connects to your default home site. Use the site name as found in the URL of the site page. For example, if the URL is https://company-name.sharepoint.com/sites/product, the site name is product.
# Client credentials grant connection
This method requires the following values:
- Subdomain
- Tenant ID
- Client ID
- Certificate
- Private Key
# Step 1: Register the Workato application in SharePoint
Complete the following steps to register the Workato app and obtain a client ID, secret, and private key for client credentials grant connections.
Log in to your Azure Portal (opens new window).
Navigate to Microsoft Entra ID > Manage > App registrations > New registration.
Enter a unique name for the application and select a supported account type.
Select Web from the Select a platform drop-down.
Enter https://www.workato.com/oauth/callback as the Redirect URI and select Register.
Select API Permissions > Add a permission from the left-hand menu.
Choose SharePoint from the Commonly used Microsoft APIs.
Select the Application permissions option.
Expand Sites in the Select permissions section and select the Sites.Read.All (Application) checkbox. Ensure that admin consent is granted in the Status column.
Select Certificates & secrets > Certificates > Upload certificate from the left-hand menu.
Upload a certificate if you already have one. If not, you can generate the certificate locally using tools such as OpenSSL or PowerShell.
Select Overview from the left-hand menu and copy the Application (client) ID value. This is your Client ID. Also, copy the Directory (tenant) ID value. This is your Tenant ID.
You can now configure your SharePoint connection in Workato using these required values.
# Step 2: Configure your SharePoint connection in Workato
Log in to your Workato account and navigate to the project where you plan to add your Microsoft SharePoint connection.
Click Create > Connection > select Microsoft Sharepoint as your connection.
Select the Client credentials option from the Authentication type dropdown menu.
Provide a unique Connection name that identifies to which SharePoint instance it is connected.
Enter your SharePoint subdomain as found in your SharePoint URL. For example, if your SharePoint URL is https://abc.sharepoint.com, the subdomain is abc.
Provide the tenant ID generated in SharePoint by completing the preceding steps.
Provide the client ID generated in SharePoint by completing the preceding steps.
Provide the certificate generated in SharePoint in the preceding steps.
Provide the private key string generated in SharePoint by completing the preceding steps.
Enter the name of the SharePoint site you plan to connect to in the Site name field. If left blank, Workato connects to your default home site. Use the site name as found in the URL of the site page. For example, if the URL is https://company-name.sharepoint.com/sites/product, the site name is product.
Last updated: 9/5/2024, 6:09:27 AM