LDAP policy

An LDAP policy contains the connection details that are used by an LDAP Input or LDAP Request node when connecting to an LDAP application.

You can use an LDAP Request node in a message flow to connect IBM® App Connect Enterprise to LDAP applications and issue requests to perform actions on objects such as devices, entries, organizational units, persons, and rooms. You can use an LDAP Input node to monitor and accept input from LDAP. The LDAP policy controls, at run time, access to the LDAP application.

The LDAP policy is created when you configure a connection between an LDAP Input or LDAP Request node and LDAP by using the Connector Discovery wizard. During the process of discovery, account credentials are stored in the vault and connection details are stored in an LDAP policy. The policy is created with a type of LDAP, and the name of the policy is returned to the LDAP Input orLDAP Request node and specified in the Connection tab, in the format {policyProjectName}:policyName.

You can also create, update, or delete an LDAP policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking New > Discovery Connector policies and credentials.

You must deploy this policy before message flows that use the policy are started. If you redeploy an LDAP policy, all message flows that are using the policy will be stopped and restarted.

For more information about using LDAP policies, see Using LDAP with IBM App Connect Enterprise.

Table 1. Properties of the LDAP policy.
Property	Property name in .policyxml file	Description of properties
LDAP Application Type	applicationType	This property is reserved for future use and must be set to the value `online`.
LDAP Application Version	applicationVersion	This property is reserved for future use and must be set to the value `v1`.
LDAP Authentication method	authenticationMethod	This property must be set to `BASIC`.
LDAP URL	endpointUrl	Specify a valid LDAP URL in the format `ldap://<host or IP address>:<port>`.
Credential Name	credentialName	This property specifies the name of the credential that will be used for the connection to LDAP. The specified credential can be defined during connector discovery and stored in the vault. Alternatively, you can specify an existing credential that was configured by using the mqsicredentials command or the server.conf.yaml file, or loaded through an external credential provider.