Microsoft SharePoint 365 Connection¶

Introduction¶

A Microsoft SharePoint 365 connection, created using the Microsoft SharePoint 365 connector, establishes access to Microsoft SharePoint 365. Once a connection is configured, you can create instances of Microsoft SharePoint 365 activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Note

The Microsoft SharePoint 365 connector supports OAuth 2.0 authentication.

Create or Edit a Microsoft SharePoint 365 Connection¶

A new Microsoft SharePoint 365 connection is created using the Microsoft SharePoint 365 connector from one of these locations:

The design component palette's Connections tab (see Design Component Palette).
The Global Connections page (see Create a Global Connection in Global Connections).

An existing Microsoft SharePoint 365 connection can be edited from these locations:

The design component palette's Connections tab (see Design Component Palette).
The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
The Global Connections page (see Edit a Global Connection in Global Connections).

Configure a Microsoft SharePoint 365 Connection¶

Each user interface element of the Microsoft SharePoint 365 connection configuration screen is described below.

Microsoft SharePoint 365 connection configuration

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

Connection Name: Enter a name to use to identify the connection. The name must be unique for each Microsoft SharePoint 365 connection and must not contain forward slashes / or colons :. This name is also used to identify the Microsoft SharePoint 365 endpoint, which refers to both a specific connection and its activities.
Office 365 Tenant URL: Enter the Microsoft Office 365 tenant URL.
Client ID: Enter the client ID for the Microsoft SharePoint 365 app (as described in Prerequisites).
Tenant ID: Enter the tenant ID.
Client Secret: Enter the client secret for the Microsoft SharePoint 365 app (as described in Prerequisites).
Use Proxy Settings (Private Agent Only): When using a Private Agent, this setting can be selected to use Private Agent proxy settings.
Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
Save Changes: Click to save and close the connection configuration.
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Possible Connection Error¶

If you receive this error when testing the connection, run the following script in PowerShell to enable custom app authentication:

{"error":"invalid_request","error_description":"Token type is not allowed."}

PowerShell Script

Install-Module -Name Microsoft.Online.SharePoint.PowerShell

$adminUPN= "<the full email address of the SharePoint administrator account, example: jan@mydomain.onmicrosoft.com>" $orgName="<mydomain>" 

$userCredential = Get-Credential -<the username of the SharePoint administrator account> $adminUPN -Message "<the password of the SharePoint administrator account>" Connect-SPOService -Url https://$orgName-admin.sharepoint.com -Credential 

$userCredential set-spotenant -DisableCustomAppAuthentication $false

Note

Replace the placeholder text (including the angle brackets < >) with the appropriate values for the SharePoint instance.

Next Steps¶

After a Microsoft SharePoint 365 connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions Menus in Connector Basics.

These activity types are available:

Upload File: Uploads a PDF or text file into Microsoft SharePoint 365 and is intended to be used as a target in an operation.
Query: Queries object data in Microsoft SharePoint 365 and is intended to be used as a source in an operation.
Update: Updates object data into Microsoft SharePoint 365 and is intended to be used as a target in an operation.
Create: Creates object data in Microsoft SharePoint 365 and is intended to be used as a target in an operation.
Delete: Deletes object data from Microsoft SharePoint 365 and is intended to be used as a target in an operation.