CrushFTP Documentation

This page in: CrushFTP 11

You are reading the CrushFTP 10 documentation. CrushFTP 11 is the current version. Read this page for CrushFTP 11

SharePoint Integration#

1. Sharepoint Microsoft Graph REST API-based integration.#

More info about Microsft Graph REST API: https://learn.microsoft.com/en-us/graph/api/resources/onedrive?view=graph-rest-1.0}

Remote item name: Sharepoint

Proxy: If your server's internet connection uses a proxy server. You need to whitelist domains: login.microsoftonline.com, graph.microsoft.com

Go to the Microsoft Azure portal: https://azure.microsoft.com/en-us/features/azure-portal/

Application registration: Go to the App registrations and click on New registration:

New registration

Name it. Select the Multitenant and personal Microsoft accounts type. The redirect URL must end with register_microsoft_graph_api/. Then click on register.

Register app

Under the redirect URL enable the Access Token to be issued by the authorization endpoint:

Enable access token

API permission: You must also provide permission for the Microsoft Graph. Go to the Api permission. Click on Add Permission, and select Microsoft Graph. About Microsoft Graph Permission see more details at https://learn.microsoft.com/en-us/graph/permissions-overview?tabs=http (it explains Application Permission and Delegated Permission).

1.1 Application Permission:#

Available on Version 10.5.1 Build : 14+

It permits a Server to server-to-server authentication. Add Files.REadWriteAll permission.

Ms graph app permission

Grant Admin consent on the added permission.

App permission admin consent

Client id : You can find it at Azure portal -> App Registration -> Overview:

Client id

Secret key: A new client secret needs to be created as well. Go to the "Certificate & secrets" and generate a new secret key. Click on New client secret.

New secret

Secret value

Authentication related settings:

User name: Itt must start with "app_permission", then the Client ID separated with tilda.

    app_permission~<<Client ID>>

Password: Client Secret.
Tennant: The tenant id. Tenant: See your App registration -> Overview -> EndPoints. Based on the App Registration Account type it can be an ID, common, or consumer.
Provide the SharePoint-specific settings. See under the 1.3.Sharepoint-specific settings. ( Link: https://www.crushftp.com/crush10wiki/Wiki.jsp?page=SharePoint%20Integration#section-SharePoint+Integration-1.3.SharepointSpecificSettings

App permission vfs item

1.2 Delegated Permission:#

Permission microsoft graph
Permission final

Client id : You can find it at Azure portal -> App Registration -> Overview:

Client id

Secret key: A new client secret needs to be created as well. Go to the "Certificate & secrets" and generate a new secret key. Click on New client secret.

New secret

Secret value

SharePoint remote item settings:

!!! The CrushFTP admin page URL must match the redirect URL. In our example : http://localhost:9090

Select the SharePoint item type and click on the "Get Refresh Token" button. Provide the Client ID and Client Secret Value (not ID, see the screenshot), and Tenant (in almost all cases it is just: common).

Remote item settings

Click on the "OK" button, log in with your Azure credentials, and allow CrushFTP to have access to your SharePoint files. After that the form will disappear and the username and password will be filled. Done.

Remote item done

1.3.Sharepoint-specific settings:#

Remote item sharepoint specific settings

_Site id : The SharePoint domain name.
Site Path: The path of the SharePoint site. It should start and end with a slash.
Drive name: Each SharePoint site has a document library where the site-related files are stored. See https://support.microsoft.com/en-us/office/what-is-a-document-library-3b5976dd-65cf-4c9e-bf5a-713c10ca2872 Provide its name.
Folder: Relative path of the document library of the SharePoint site.
Conflict Behaviour:
- Rename the file/folder if already exits
-
Replace the file/folder if already exits
-
Fail if the file/folder already exists

2. SharePoint REST service API-based integration#

Remote item name: Sharepoint2

More info : https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service?tabs=csom
!!!Constraint: On newer Sharepoint (after 2019) Grant App permission as it is disabled by default. To enable Custom Application APP Authentication run the following PowerShell commands:

Install-Module -Name Microsoft.Online.SharePoint.PowerShell
$adminUPN="<SharePoint administrator account>"
$orgName="<name of your Office 365 organization>"
$userCredential = Get-Credential -UserName $adminUPN -Message "Type the password."
Connect-SPOService -Url https://$orgName-admin.sharepoint.com -Credential $userCredential
get-spotenant | Select DisableCustomAppAuthentication
set-spotenant -DisableCustomAppAuthentication $false

Or

$creds = Get-Credential
$orgName="<name of your Office 365 organization>"
Connect-SPOService -Url https://$orgName-admin.sharepoint.com -Credential $creds
get-spotenant | Select DisableCustomAppAuthentication
set-spotenant -DisableCustomAppAuthentication $false

Advantage(Compared with MSGraph API Delegated Permission): Stream upload supported. There is no temporarily stored local file during the upload.

1. Register Add-In
Navigate and log in to the SharePoint online site. Got to the Register Add-In page by entering the URL as:

https://<sitename>.sharepoint.com/<<site path>>/_layouts/15/appregnew.aspx

Click the Generate button.

App reg new

Store the Client ID and Client Secret and click on Create button.

App reg new success

2. Grant Permissions to Add-In

Navigate to:

 https://<sitename>.sharepoint.com/<<site path>>/_layouts/15/appinv.aspx

This will redirect to the Grant permission page. Enter the Client ID(generated earlier), in the AppId textbox and click the Lookup button.
Provide the permission Request xml and click on Create button.

Permission Request XML content:

<AppPermissionRequests AllowAppOnlyPolicy="true">
	<AppPermissionRequest Scope="http://sharepoint/content/sitecollection/web" Right="FullControl"/></AppPermissionRequests>

App inv permission
SharePoint2 remote item settings:

User name : The created Client ID
Password : The created Client Secret
Site id : The sharepoint domain name.
Site Path: The path of the SharePoint site. It should start and end with a slash.
Drive name: Each SharePoint site has a document library where the site-related files are stored. See https://support.microsoft.com/en-us/office/what-is-a-document-library-3b5976dd-65cf-4c9e-bf5a-713c10ca2872 Provide its name
Folder: Relative path of the document library of the sharepoint site.

Sharepoint 2 vfs