Connection String Options
The following is the full list of the options you can configure in the connection string for this provider.
| The authentication mechanism to be used when connecting to the Active Directory server. |
| The base portion of the distinguished name, used for limiting results to specific subtrees. |
| A password used to authenticate to a proxy-based firewall. |
| The TCP port for a proxy-based firewall. |
| The name or IP address of a proxy-based firewall. |
| The protocol used by a proxy-based firewall. |
| The user name to use to authenticate with a proxy-based firewall. |
| Whether or not to follow referrals returned by the Active Directory server. |
| Whether to return GUID attribute values in a human readable format. |
| Whether to return SID attribute values in a human readable format. |
| The LDAP version used to connect to and communicate with the server. |
| A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Core modules to be included in the log file. |
| 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. |
| The other parameters necessary to connect to a data source, such as username and password, when applicable. |
| The password for the distinguished name of the specified user. |
| The port the Active Directory server is running on. |
| You can use this property to enforce read-only access to ActiveDirectory from the provider. |
| Whether to limit the scope of the search to the whole subtree (BaseDN and all of its descendants), a single level (BaseDN and its direct descendants), or the base object (BaseDN only). |
| The domain name or IP of the Active Directory server. |
| The certificate to be accepted from the server when connecting using TLS/SSL. |
| The value in seconds until the timeout error is thrown, canceling the operation. |
| The distinguished name of a user. |
| Whether or not to use SSL to connect to the server. |
Auth Mechanism
The authentication mechanism to be used when connecting to the Active Directory server.
Data Type
string
Default Value
"SIMPLE"
Remarks
By default, AuthMechanism is SIMPLE, and default plaintext authentication is used to log in to the server. If AuthMechanism is set to DIGESTMD5, the more secure DIGEST-MD5 authentication is used. If AuthMechanism is set to NEGOTIATE, NTLM/Negotiate authentication will be used.
• SIMPLE
• DIGESTMD5
• NEGOTIATE
Base DN
The base portion of the distinguished name, used for limiting results to specific subtrees.
Data Type
string
Default Value
""
Remarks
Specifying a base DN may greatly improve performance when returning entries for large servers by limiting the number of entries that need to be examined.
Firewall Password
A password used to authenticate to a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
Firewall Port
The TCP port for a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
Firewall Server
The name or IP address of a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling.
Firewall Type
The protocol used by a proxy-based firewall.
Data Type
string
Default Value
"NONE"
Remarks
This property specifies the protocol that the adapter will use to tunnel traffic through the FirewallServer proxy.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the adapter opens a connection to Active Directory and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the adapter sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the adapter sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
Firewall User
The user name to use to authenticate with a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
Follow Referrals
Whether or not to follow referrals returned by the Active Directory server.
Data Type
bool
Default Value
false
Remarks
When following referrals, you will only be able to return data from the referral servers. INSERT/UPDATE/DELETE will not be available without updating the connection string to connect directly to that server.
Friendly GUID
Whether to return GUID attribute values in a human readable format.
Data Type
bool
Default Value
false
Remarks
When inspecting object attributes this setting determines whether GUID attributes such as "objectGUID" are returned as binary objects or converted into a human readable string such as "708d9374-d64a-49b2-97ea-489ddc717703". When set to True a friendly string value is returned. When set to False (default) a base 64 encoded string of the binary object is returned.
Friendly SID
Whether to return SID attribute values in a human readable format.
Data Type
bool
Default Value
false
Remarks
When inspecting object attributes this setting determines whether SID attributes such as "objectSid" are returned as binary objects or converted into a human readable string such as "S-1-5-21-4272240814-246508344-1325542772-12464". When set to True a friendly string value is returned. When set to False (default) a base 64 encoded string of the binary object is returned.
LDAP Version
The LDAP version used to connect to and communicate with the server.
Data Type
string
Default Value
"2"
Remarks
Valid options are 2 and 3 for LDAP versions 2 and 3.
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type
string
Default Value
""
Remarks
The path to a directory which contains the schema files for the adapter (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
The schema files are deployed alongside the adapter assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.
Log Modules
Core modules to be included in the log file.
Data Type
string
Default Value
""
Remarks
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
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.
Data Type
int
Default Value
-1
Remarks
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.
Other
The other parameters necessary to connect to a data source, such as username and password, when applicable.
Data Type
string
Default Value
""
Remarks
The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.
Integration and Formatting
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Password
The password for the distinguished name of the specified user.
Data Type
string
Default Value
""
Remarks
Together with User, this field is used to authenticate against the Active Directory server.
Port
The port the Active Directory server is running on.
Data Type
string
Default Value
"389"
Remarks
The port the Active Directory server is running on. Together with Server, this property is used to specify the Active Directory server.
Readonly
You can use this property to enforce read-only access to ActiveDirectory from the provider.
Data Type
bool
Default Value
false
Remarks
If this property is set to true, the adapter will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.
Scope
Whether to limit the scope of the search to the whole subtree (BaseDN and all of its descendants), a single level (BaseDN and its direct descendants), or the base object (BaseDN only).
Data Type
string
Default Value
"WHOLESUBTREE"
Remarks
Whether to limit the scope of the search to the whole subtree (BaseDN and all of its descendants), a single level (BaseDN and its direct descendants), or the base object (BaseDN only). Limiting scope can greatly improve the search performance.
WholeSubtree
SingleLevel
BaseObject
Server
The domain name or IP of the Active Directory server.
Data Type
string
Default Value
""
Remarks
Note: This does not need to include the LDAP:\\ portion, only the server domain name or IP.
SSL Server Cert
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type
string
Default Value
""
Remarks
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine will be rejected.
This property can take the forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type
string
Default Value
"60"
Remarks
If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.
If Timeout expires and the operation is not yet complete, the adapter throws an exception.
User
The distinguished name of a user.
Data Type
string
Default Value
""
Remarks
Together with Password, this field is used to authenticate against the Active Directory server.
Use SSL
Whether or not to use SSL to connect to the server.
Data Type
bool
Default Value
false
Remarks
Whether or not to use SSL to connect to the server. Note that a port of 636 will always use SSL.