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).

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 Project endpoints and connectors tab (see Design component palette).
• The Global Connections page (see Create a global endpoint in Global Connections).

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

• The design component palette's Project endpoints and connectors 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 endpoint in Global Connections).

Configure a Microsoft SharePoint 365 connection

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

The interface used in the connection configuration depends on the Authentication type selected:

• Azure Access Control Service: This option authenticates apps using the SharePoint Add-in model and Azure Access Control Service (ACS).
• Microsoft Entra ID: This option authenticates apps registered with Microsoft Azure Entra (previously known as Azure Active Directory or Azure AD).

Azure Access Control Service

If Azure Access Control Service is selected as the Authentication type, this user interface is presented:

• 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 (described in Prerequisites).

• Tenant ID: Enter the tenant ID.

• Authentication type: Select Azure Access Control Service.

• Client secret: Enter the client secret for the Microsoft SharePoint 365 app (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.

Microsoft Entra ID

If Microsoft Entra ID is selected as the Authentication type, this user interface is presented:

• 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 (described in Prerequisites).

• Tenant ID: Enter the tenant ID (described in Prerequisites).

• Authentication type: Select Microsoft Entra ID.

• Client assertion: Enter the client assertion, which can be generated by using a tool such as jwt.io or using the CreateJwtToken function in a Jitterbit script.

• Scope: Enter the OpenID Connect scope in this format: https://jbexample.sharepoint.com/.default.

• 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."}

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

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.