Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
| Auth Scheme | The scheme used for authenticating to SharePoint. For On-Premise instances, accepted entries are NTLM, Basic, Digest, Forms, None, and Negotiate. NTLM is the default. For Sharepoint Online, the accepted entries are OAuth and OAuthJWT. |
| Azure Environment | The Azure Environment to use when establishing a connection. |
| Azure Tenant | The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used. |
| Calculated Data Type | The data type to be used for calculated fields. |
| Callback URL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your Add-In settings. |
| Continue On Error | Indicates whether or not to continue updating items in a batch after an error. |
| Create ID Columns | Indicates whether or not to create supplemental ID columns for SharePoint columns that use values from information stored in other Lists. |
| Firewall Password | A password used to authenticate to a proxy-based firewall. |
| Firewall Port | The TCP port for a proxy-based firewall. |
| Firewall Server | The name or IP address of a proxy-based firewall. |
| Firewall Type | The protocol used by a proxy-based firewall. |
| Firewall User | The user name to use to authenticate with a proxy-based firewall. |
| Folder Option | An option to determine how to display folders in results. Enter either FilesOnly, FilesAndFolders, Recursive, or RecursiveAll. |
| Include Lookup Columns | This option controls whether the driver returns the lookup columns defined on a table. |
| Initiate OAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| Kerberos KDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| Kerberos Keytab File | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| Kerberos Realm | The Kerberos Realm used to authenticate the user with. |
| Kerberos Service KDC | The Kerberos KDC of the service. |
| Kerberos Service Realm | The Kerberos realm of the service. |
| Kerberos SPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| Kerberos Ticket Cache | The full file path to an MIT Kerberos credential cache file. |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Log Modules | Core modules to be included in the log file. |
| Max Rows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| OAuth Access Token | The access token for connecting using OAuth. |
| OAuth Client Id | The client ID assigned when you register your application with an OAuth authorization server. |
| OAuth Client Secret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuth Expires In | The lifetime in seconds of the OAuth AccessToken. |
| OAuth Grant Type | The grant type for the OAuth flow. |
| OAuth JWT Cert | The JWT Certificate store. |
| OAuth JWT Cert Password | The password for the OAuth JWT certificate. |
| OAuth JWT Cert Subject | The subject of the OAuth JWT certificate. |
| OAuth JWT Cert Type | The type of key store containing the JWT Certificate. |
| OAuth JWT Issuer | The issuer of the Java Web Token. |
| OAuth JWT Subject | The user subject for which the application is requesting delegated access. |
| OAuth Refresh Token | The OAuth refresh token for the corresponding OAuth access token. |
| OAuth Settings Location | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://. |
| OAuth Token Timestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| OAuth Verifier | The verifier code returned from the OAuth authorization URL. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The maximum number of results to return per page from SharePoint. |
| Password | The password used to authenticate the user. |
| Proxy Auth Scheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| Proxy Auto Detect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| Proxy Exceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Proxy Password | A password to be used to authenticate to the ProxyServer proxy. |
| Proxy Port | The TCP port the ProxyServer proxy is running on. |
| Proxy Server | The hostname or IP address of a proxy to route HTTP traffic through. |
| Proxy SSL Type | The SSL type to use when connecting to the ProxyServer proxy. |
| Proxy User | A user name to be used to authenticate to the ProxyServer proxy. |
| Readonly | You can use this property to enforce read-only access to SharePoint from the provider. |
| Schema | The type of schema to use. |
| Share Point Edition | The edition of SharePoint being used. Set either SharePoint Online or SharePoint On-Premise. |
| Show Hidden Columns | Boolean determining if hidden columns should be shown or not. If false, all hidden columns will be removed from the column listing. |
| Show Predefined Columns | Boolean determining if predefined columns should be shown or not. If false, all columns derived from a base type will be removed from the column listing. |
| Show Version Views | Indicate whether to display the view of list versions. Such as ListA_Versions. |
| SSL Client Cert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSL Client Cert Password | The password for the TLS/SSL client certificate. |
| SSL Client Cert Subject | The subject of the TLS/SSL client certificate. |
| SSL Client Cert Type | The type of key store containing the TLS/SSL client certificate. |
| SSL Server Cert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| SSO Domain | The domain of the user when using single sign-on (SSO). |
| SSO Login URL | The identity provider's login URL. |
| SSO Password | The password of the SSOProvider used to authenticate the user. |
| SSO Properties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
| SSO Provider | The name of the SSO provider you are trying to authenticate. |
| SSO User | The SSOProvider user account used to authenticate. |
| STSURL | The URL of the security token service (STS) when using single sign-on (SSO). |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| URL | The base URL for the site. |
| Use Display Names | Boolean determining if the display names for the columns should be used instead of the API names. |
| Use NTLMV1 | Determines whether the driver will attempt to connect with NTLMv1 or NTLMv2 (default). |
| User | The SharePoint user account used to authenticate. |
| Use Simple Names | Boolean determining if simple names should be used for tables and columns. |
| Use SSO | Whether or not to use single sign-on (SSO) to authenticate to SharePoint Online. |