How to use IBM App Connect with Microsoft SharePoint

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

What should I consider first?

Before you use App Connect Designer with Microsoft SharePoint, take note of the following considerations:

• To authenticate connection to SharePoint Online using SAML verification, IBM App Connect does not support two-factor authentication. Before using IBM App Connect with your Sharepoint account, check if your account has two-factor authentication enabled and, if so, disable two-factor authentication.
• The SharePoint connector cannot be used to access personal site collections. To work with personal site collections, you can use the Microsoft OneDrive for Business connector.

Connecting to Microsoft SharePoint

Complete the connection fields that you see in the App Connect Designer Connect > Applications and APIs page (previously the Catalog page) or flow editor. If necessary, work with your Microsoft SharePoint administrator to obtain these values.

To create a connection from App Connect to a Microsoft SharePoint account, complete the following steps.

1. Open the Connect to Microsoft Sharepoint dialog box by using one of the following options:
   • For your first Microsoft SharePoint connection, click Connect.
   • To add another Microsoft SharePoint connection, expand the Accounts list and click Add a new account.
2. In the Connect to Microsoft Sharepoint dialog box, select the appropriate Type to connect to:
   • Select SharePoint Online to connect to a Microsoft SharePoint cloud-based service.
   • Select SharePoint Software to connect to a Microsoft SharePoint Server on premises.
3. If you have selected SharePoint Online, select an Authorization method:

   Authorization method	Connection field	Description
   BASIC OAUTH	Application client ID	Unique identifier generated after Microsoft Azure app registration to tie requests to specific projects
   	Application client secret	Application client secret for the unique Application client ID created for a specific project
   	OAuth access token	Access token generated from the Application client ID and Application client secret
   	OAuth refresh token	Refresh token generated from the Application client ID and Application client secret
   	SharePoint online URL	SharePoint online URL that provides a direct sign-in to the Microsoft SharePoint service; for example, https://anyorganization.sharepoint.com Tip: If you are already logged in to Microsoft SharePoint in the same browser window as App Connect Enterprise as a Service, App Connect can connect to that Microsoft SharePoint account without needing further action.
   Attention: SAML-based authentication is deprecated in the Microsoft SharePoint connector. To continue using the connector, configure one of the supported authentication types. SAML Restriction: To authenticate the connection to SharePoint Online by using SAML verification, IBM App Connect doesn't support two-factor authentication. Before you use IBM App Connect with your Microsoft SharePoint account, check if your account has two-factor authentication enabled and, if so, disable two-factor authentication or choose the Use the website (OAuth2) option.	SharePoint online URL	SharePoint online URL that provides a direct sign-in to the Microsoft SharePoint service; for example, https://anyorganization.sharepoint.com Tip: If you are already logged in to Microsoft SharePoint in the same browser window as App Connect Enterprise as a Service, App Connect can connect to that Microsoft SharePoint account without needing further action.
   	Site collection path	The site collection URL in SharePoint relative to the SharePoint URL; for example, /TeamSite or /sites/mysitecollection
   	User name	The user name for your Microsoft SharePoint account
   	Password	The password for your Microsoft SharePoint account
   OAUTH 2.0 AUTH CODE	SharePoint online URL	SharePoint online URL that provides a direct sign-in to the Microsoft SharePoint service; for example, https://anyorganization.sharepoint.com Tip: If you are already logged in to Microsoft SharePoint in the same browser window as App Connect Enterprise as a Service, App Connect can connect to that Microsoft SharePoint account without needing further action.

4. If you have selected SharePoint Software, choose a Version, and then select an Authorization method.

   Authorization method	Connection field	Description
   BASIC	SharePoint on premises host and port	SharePoint on premises web application URL that provides a direct sign-in to the Microsoft SharePoint service; for example, https://mysharepointhost:8443
   	Site collection path	The site collection URL in SharePoint relative to the SharePoint URL; for example, /TeamSite or /sites/mysitecollection
   	User name	The user name for your Microsoft SharePoint account
   	Password	The password for your Microsoft SharePoint account
   	Private network connection	Select the name of a private network agent that App Connect uses to connect to your private network. This list is populated with the names of private network agents that are created on the Private networks page. For more information, see Connecting to a private network.
   Attention: The use of NTLM-based authentication is deprecated in the containerized environment. NTLM v1	SharePoint on premises host and port	SharePoint on premises web application URL that provides a direct sign-in to the Microsoft SharePoint service; for example, https://mysharepointhost:8443
   	Site collection path	The site collection URL in SharePoint relative to the SharePoint URL; for example, /TeamSite or /sites/mysitecollection
   	User name	The user name for your Microsoft SharePoint account
   	Password	The password for your Microsoft SharePoint account
   	Domain	The domain you use to log in to your on premises SharePoint account
   	Workstation	Workstation or server name where SharePoint is installed
   	Private network connection	Select the name of a private network agent that App Connect uses to connect to your private network. This list is populated with the names of private network agents that are created on the Private networks page. For more information, see Connecting to a private network.

5. Click Continue.

To obtain the connection values for Microsoft SharePoint, see Obtaining connection values for Microsoft SharePoint.

To connect to a Microsoft SharePoint endpoint from the App Connect Designer Applications and APIs page for the first time, expand Microsoft SharePoint, then click Connect. For more information, see Managing accounts.

General considerations

Before you use App Connect Designer with Microsoft SharePoint, take note of the following general considerations:

• (General consideration) You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.

  For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

• (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Post connection considerations

Events and actions

Microsoft SharePoint events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Show more configurable events: Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects.

Microsoft SharePoint actions

Your flow completes these actions on this application.

Files

Create file

Download file

Retrieve files

Delete file

Update file

Rename file

Share file

Folder items

Retrieve folder items

Folders

Create folder

Retrieve folders

Delete folder

Update folder

List item attachments

Create list item attachment

Download list item attachment

Retrieve list item attachments

Delete list item attachment

Update list item attachment

List items

Create list item

Retrieve list items

Delete list item

Update list item

Lists

Create list

Retrieve lists

Delete list

Update list

Permissions

Retrieve permissions

Search

Search files

Shared links

Retrieve shared links

Sites

Retrieve sites

Delete site

Update site

Users

Retrieve users