SharePoint connection - Tutorial
|
Last Update: 08.12.2023 |
For uploads and downloads of files, the internal CloudStorage connection is a good choice (version > 4.5 required). This is our 'GoTo' connection, as it is relatively easy to implement and no additional license is required.
In Phase 1 → CloudStorage can be used to fetch files, and in phase 6 → CloudStorage Response, it can be used to upload files.
Requirements in Azure
Before we get to the actual connection, we need to create an app in Microsoft Identity Platform and prepare authentication using OAuth2.
Quickstart: https://learn.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app
Required credentials from the Azure app:
|
Tenant |
Can be found in the app overview. |
|
Application ID |
Can be found in the app overview. |
|
Application Secret / Client Secret |
To be found under 'Certificates & Secrets' → 'Client secrets' tab. |
|
Redirect URI |
To be found under 'Authentication'. Without a redirect URI, there is no redirect to Lobster Integration for the browser login. In conjunction with DMZ: If a DMZ server is used, the redirect URL must be entered in the configuration file ./etc/forward.properties of the DMZ server! See also section Inwards forwarding for HTTP(S) requests. |
|
Scopes |
The scopes can be set under 'API permissions'. By default, the Graph API (Files→ Files.ReadWrite.All und Sites → Sites.ReadWrite.All) is used. The Type may vary depending on the authorization flow (see channel settings below)! Delegated is recommended for REFRESH_TOKEN.
|
Channel setup
With the above info, we can create a CloudStorage channel.
Under Administration → Partners → Partners/Channels we create a new CloudStorage channel.
For Type, we select MS 365 OneDrive / Sharepoint.
Click on Authenticate and you will be asked to save the channel. The authorization flow (Grant Type) can then be selected.
Authorization Flow
CLIENT_CREDENTIALS
This is the simpler authorization method, as no redirect URL is required and user login is not necessary.
Important: The scopes must be set to Type Application here! (see screenshot in the table above: Scopes)
Click on Fetch Access Token to successfully complete the authorization.REFRESH_TOKEN
The somewhat safer method.
The scopes should be set to Type Delegated here.
Please enter the IP/host name of the data in the Redirect URL field. The redirect URL can then be copied and pasted into the Redirect URI in Azure as described in the table above.
Click on Fetch Access Token to open the login screen for Microsoft. A final login and confirmation of the authorizations is required here.
Note: Please use a system account (e.g. lobster_prod@example.onmicrosoft.com). With the use of your private account, the private folder can be accessed!
If the authorization was successful, the following message will be displayed and the browser tab and the channel can be closed: "Login succeeded, your name is . Please close the browser tab now!"
Profile setup
The following SharePoint page is given: 'Sales Test Site'.
Downloading files (phase 1)
To download files, we enter the name of the site with @Name:Sales Test Site under Drive/Site-ID.
With the setting below, the postman_environment.json file is retrieved when the profile is run.
Note: If files are to be retrieved from Documents, it is sufficient to enter a single slash / instead of /test/123/ in the Directory field!
Uploading files (phase 6)
Note: For an upload, the SharePoint user/Microsoft account must have permissions to write to the corresponding pages!
To upload files, we proceed as above.
With the setting below, an input file is written to the /test/123/ directory when the profile runs.
Variables can also be used as SharePoint page name in the Drive/Site-ID field! Example: @Name:@var_sharepoint_sites@
Note: As an alternative to the SharePoint page name, the drive ID can also be specified. The drive ID can be retrieved via the Graph Explorer. Appropriate authorizations are already required for the Graph Explorer. These must be assigned to the account in advance! Microsoft's official guide to Drive IDs: https://learn.microsoft.com/en-us/graph/api/drive-get?view=graph-rest-1.0&tabs=http