Connecting to SharePoint On Premise

SharePoint On Premise can be accessed using either the SharePoint SOAP or SharePoint REST V1 connection type.

• SharePoint SOAP uses the SharePoint SOAP API with the sp:// URI scheme.
• SharePoint REST V1 uses the SharePoint REST API v1 (_api/web/) with the sprestv1:// URI scheme.

Note: SharePoint REST V1 supports connecting to both on-premise and SharePoint Online environments. The SSO authentication schemes (ADFS, Okta, OneLogin, PingFederate) authenticate through Microsoft's SharePoint Online cloud endpoints. For SharePoint Online-specific guidance, see also Connecting to SharePoint Online.

The following authentication schemes are supported for both connection types:

• User Credentials
• ADFS
• Okta
• OneLogin
• NTLM

Additionally, SharePoint REST V1 supports:

• AzureAD (Azure Active Directory / Entra ID)

User Credentials

Set the AuthScheme to Basic. You need to set the following connection properties:

• User: Set this to the SharePoint user.
• Password: Set this to SharePoint password for the user.

Below is an example connection string:

AuthScheme=Basic;User=yourUserName;Password=yourPassword;SharePointEdition=SharePointOnPremise;ConnectionType='SharePoint SOAP';URI='sp://Shared Documents/';StorageBaseURL=http://sharePointServer/;

AuthScheme=Basic;User=yourUserName;Password=yourPassword;SharePointEdition=SharePointOnPremise;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=http://sharePointServer/sites/mysite;

ADFS

Set the AuthScheme to ADFS. You need to set the following connection properties:

• User: Set this to the ADFS user.
• Password: Set this to ADFS password for the user.
• SSOLoginURL: Set this to the base URL for your ADFS server.

Below are example connection strings:

AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;SharePointEdition=SharePointOnPremise;ConnectionType='SharePoint SOAP';URI='sp://Documents/';StorageBaseURL=http://sharePointServer/;

AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

Okta

Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:

• User: Set this to the Okta user.
• Password: Set this to Okta password for the user.
• SSOProperties:
  • Domain (optional): It may be required to set this property if the domain configured on the SSO domain is different than the domain of the User.

The following are example connection strings:

AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;SharePointEdition=SharePointOnPremise;ConnectionType='SharePoint SOAP';URI='sp://Documents/';StorageBaseURL=http://sharePointServer/;

AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

OneLogin

Set the AuthScheme to OneLogin. The following connection properties are used to connect to OneLogin:

• User: Set this to the OneLogin user.
• Password: Set this to OneLogin password for the user.
• SSOProperties:
  • Domain (optional): It may be required to set this property if the domain configured on the SSO domain is different than the domain of the User.

The following are example connection strings:

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;SharePointEdition=SharePointOnPremise;ConnectionType='SharePoint SOAP';URI='sp://Documents/';StorageBaseURL=http://sharePointServer/;

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

NTLM

Set the AuthScheme to NTLM. The following connection properties are used to connect to NTLM:

• User: Set this to the NTLM user.
• Password: Set this to NTLM password for the user.

The following are example connection strings:

AuthScheme=NTLM;User=NtlmUsername;Password=NtlmPassword;SharePointEdition=SharePointOnPremise;ConnectionType='SharePoint SOAP';URI='sp://Documents/';StorageBaseURL=http://sharePointServer/;

AuthScheme=NTLM;User=NtlmUsername;Password=NtlmPassword;SharePointEdition=SharePointOnPremise;ConnectionType='SharePoint SOAP';URI='sp://Documents/mycars.JSON';StorageBaseURL=http://sharePointServer/;

AuthScheme=NTLM;User=NtlmUsername;Password=NtlmPassword;SharePointEdition=SharePointOnPremise;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=http://sharePointServer/sites/mysite;

AzureAD

Azure Active Directory (AzureAD / Entra ID) authentication is supported for SharePoint REST V1 only. This uses OAuth 2.0 to authenticate with Azure AD and obtain an access token for the SharePoint REST API. This works for both SharePoint Online and SharePoint Server on-premise (when configured with Entra ID as an OIDC identity provider, e.g. SharePoint Server Subscription Edition). Set the AuthScheme to AzureAD. The following connection properties are used to connect:

• OAuthClientId: Set this to the client Id in your Azure AD application settings.
• OAuthClientSecret: Set this to the client secret in your Azure AD application settings.
• CallbackURL: Set this to the Redirect URL configured in your Azure AD application.
• InitiateOAuth: Set this to GETANDREFRESH to have the provider manage the OAuth token exchange and refresh automatically.
• AzureTenant: Set this to the Azure AD tenant Id or domain (e.g. contoso.onmicrosoft.com or a tenant GUID). This is required for SharePoint On Premise.

The following are example connection strings:

AuthScheme=AzureAD;AzureTenant=contoso.onmicrosoft.com;InitiateOAuth=GETANDREFRESH;SharePointEdition=SharePointOnPremise;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://sharePointServer/sites/mysite;

AuthScheme=AzureAD;InitiateOAuth=GETANDREFRESH;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;