/n software Adapters for BizTalk
/n software Adapters for BizTalk
Questions / Feedback?

LDAP Adapter

Properties   Configuration Settings  

The LDAP Adapter enables your BizTalk Server to perform operations against any LDAP directory server.

Remarks

The LDAP Adapter can be used to perform a variety of operations on any LDAP directory server.

LDAP Send Adapter

The send adapter is designed to be used as a solicit response adapter. Some operations require a message that adheres to a schema while others to not place any restrictions on the message content and rely solely on the adapter property values.

The operation performed by the adapter is controlled by the Operation property. To begin, specify the connection information in Server, and Port. SSL may be enabled via the SSLStartMode property.

To perform an authenticated bind, set BindDN to your username and Password.

All operations will populate the ResultCode, ResultDescription, and ResultSuccess context properties in the message returned by the adapter. These should be checked to determine the result of the operation that was requested.

Below is an overview of the available operations.

Add

Adds an entry specified by DN to the directory server using the type and value attributes defined in the message. The message must adhere to the schema defined in "LDAPAdd.xsd" that is located in the "schemas" folder of the installation. Note that instead of including the Value attribute in the message, Base64 encoded data may be included in the LDAPAttribute element text. To add attributes to an existing entry use the Modify operation instead.

Authenticate

Binds with the user specified by BindDN. This is only used to validate the user can bind successfully to the LDAP server. No other action is performed.

ChangePassword

Changes the password for the user specified by DN with the value specified in NewPassword.

Delete

Deletes the entry specified by DN.

Modify

Modifies an existing entry specified by DN. The message must adhere to the schema defined in "LDAPModify.xsd" that is located in the "schemas" folder of the installation. Note that instead of including the Value attribute in the message, Base64 encoded data may be included in the LDAPAttribute element text.

Search

Performs a search using the criteria specified in the message. The message must adhere to the schema defined in "LDAPSearch.xsd" that is located in the "schemas" folder of the installation. The response message will adhere to the schema defined in "LDAPSearchResult" and provide the search results.

Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.

Sender Property List


The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.

BindDNThe Distinguished Name used as the base for the LDAP bind.
ConnectionLifetimeInstructs the adapter whether or not to leave the connection to the server open.
DNThe Distinguished Name used as the base for LDAP operations.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
NewPasswordThe value of the new password.
OperationSpecifies the operation the adapter will perform.
OtherDefines a set of configuration settings to be used by the adapter.
PageSizeThe maximum number of results per page.
PasswordThe password used to authenticate to the LDAP server.
PortThe server port for the LDAP connection (default is 636).
ResultCodeThe result code returned in the last server response.
ResultDescriptionThe descriptive text returned in the last server response (if any).
ResultSuccessWhether or not the operations completed successfully.
ServerThe name or address of the LDAP server.
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the adapter starts the SSL negotiation.
TimeoutA timeout for the adapter.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
VersionThe version of LDAP used.

Configuration Settings


The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.

BinaryAttributesA comma separated list of attributes that are expected to be in binary form.
RepeatAttributeTypesWhether to include the type name in the LDAPAttribute for repeated types returned from a search.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLSNamedGroupsThe supported (EC)DHE groups.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the adapter whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 16.0 [Build 6659]