API categoriesEdit online Various API categories are supported by IBM® Verify Directory. The following sets of APIs are supported: LDAP_ABANDON LDAP_ADD LDAP_BACKUP LDAP_BIND / UNBIND LDAP_CODEPAGE LDAP_COMPARE LDAP controls LDAP_CREATE_ABORT_TRANSACTION_REQUEST LDAP_CREATE_COMMIT_TRANSACTION_REQUEST LDAP_CREATE_EFFECTIVE_PWDPOLICY_REQUEST LDAP_CREATE_GET_FILE_REQUEST LDAP_CREATE_LIMIT_NUM_VALUES_CONTROL LDAP_CREATE_LOCATE_ENTRY_REQUEST LDAP_CREATE_ONLINE_BACKUP_REQUEST LDAP_CREATE_PASSWORD_POLICY_BIND_FINALIZE_REQUEST LDAP_CREATE_PASSWORD_POLICY_BIND_INIT_REQUEST LDAP_CREATE_PERSISTENTSEARCH_CONTROL LDAP_CREATE_PREPARE_TRANSACTION_REQUEST LDAP_CREATE_PROXYAUTH_CONTROL LDAP_CREATE_RESUME_ROLE_REQUEST LDAP_CREATE_RETURN_DELETED_OBJECTS_CONTROL LDAP_CREATE_TRANSACTION_CONTROL LDAP_CREATE_VLV_CONTROL LDAP_DELETE LDAP_END_TRANSACTION LDAP_ERROR LDAP_EXTENDED_OPERATION LDAP_FIRST_ATTRIBUTE LDAP_FIRST_ENTRY, LDAP_FIRST_REFERENCE LDAP_FREE_LIMIT_NUM_VALUES_RESPONSE LDAP_GET_BIND_CONTROLS LDAP_GET_DN LDAP_GET_TRAN_ID LDAP_GET_VALUES LDAP_INIT LDAP_MEMFREE LDAP_MESSAGE LDAP_MODIFY LDAP_PAGED_RESULTS LDAP_PARSE_EFFECTIVE_PWDPOLICY_RESPONSE LDAP_PARSE_ENTRYCHANGE_CONTROL LDAP_PARSE_EXTENDED_RESULT_W_CONTROLS LDAP_PARSE_LIMIT_NUM_VALUES_RESPONSE LDAP_PARSE_RESULT LDAP_PARSE_VLV_CONTROL LDAP_PASSWORD_POLICY LDAP_PLUGIN_REGISTRATION LDAP_PREPARE_TRANSACTION LDAP_RENAME LDAP_RESTORE LDAP_RESULT LDAP_SEARCH LDAP_SERVER_INFORMATION IN DNS LDAP_SSL LDAP_SSL_PKCS11 LDAP_START_TRANSACTION LDAP_START_TLS LDAP_STOP_TLS LDAP_SSL_ENVIRONMENT_INIT LDAP_SORT LDAP_SSL_SET_EXTN_SIGALG LDAP_SSL_SET_SUITEB_MODE LDAP_URL LDAP_ABANDONUse the LDAP_ABANDON API to abandon an LDAP operation in progress.LDAP_ADDUse the LDAP_ADD API to carry out an LDAP operation to add an entry.LDAP_BACKUPUse the LDAP_BACKUP API to request a server backup. This LDAP routine is used to create and call an LDAP extended operation for requesting a directory server backup.LDAP_BIND / UNBINDUse the LDAP_BIND / UNBIND API to request a server backup. LDAP routines for binding and unbinding.LDAP_CODEPAGEUse the LDAP_CODEPAGE API to manage string conversions. It functions for managing the conversion of strings between UTF-8 and a local code page.LDAP_COMPAREUse the LDAP_COMPARE API to do an LDAP compare operation.LDAP controlsCertain LDAP Version 3 operations can be extended with the use of controls. Controls can be sent to a server or returned to the client with any LDAP message. This type of control is called a server control.LDAP_CREATE_ABORT_TRANSACTION_REQUESTUse the LDAP_CREATE_ABORT_TRANSACTION_REQUEST API or LDAP routine to create a cancel or stop transaction request, in other words, an abort transaction request.LDAP_CREATE_ACCOUNT_STATUS_REQUESTUse the LDAP_CREATE_ACCOUNT_STATUS_REQUEST API or LDAP routine to create a berval for the account status request.LDAP_CREATE_COMMIT_TRANSACTION_REQUESTUse the LDAP_CREATE_COMMIT_TRANSACTION_REQUEST API or LDAP routine to create a commit transaction request.LDAP_CREATE_EFFECTIVE_PWDPOLICY_REQUESTUse the LDAP_CREATE_EFFECTIVE_PWDPOLICY_REQUEST API or LDAP routine for creating an extended operation request to query the effective password policy of a user or a group.LDAP_CREATE_GET_FILE_REQUESTUse the LDAP_CREATE_GET_FILE_REQUEST API or LDAP routine to create a berval request that can be sent on the get file extended operation.LDAP_CREATE_LIMIT_NUM_VALUES_CONTROLUse the LDAP_CREATE_LIMIT_NUM_VALUES_CONTROL API or LDAP routine to create the Limit Number of Attribute Values Control. This control is used to limit the number of values that are returned for the entire entry.LDAP_CREATE_LOCATE_ENTRY_REQUESTUse the LDAP_CREATE_LOCATE_ENTRY_REQUEST API or LDAP routine to create a berval request for the locate entry extended operation.LDAP_CREATE_ONLINE_BACKUP_REQUESTUse the LDAP_CREATE_ONLINE_BACKUP_REQUEST API or LDAP routine to create a berval request that can be sent on the online backup extended operation.LDAP_CREATE_PASSWORD_POLICY_BIND_FINALIZE_REQUESTUse the LDAP_CREATE_PASSWORD_POLICY_BIND_FINALIZE_REQUEST API or LDAP routine for creating a password policy bind finalize request and verifying extended operation request.LDAP_CREATE_PASSWORD_POLICY_BIND_INIT_REQUESTUse the LDAP_CREATE_PASSWORD_POLICY_BIND_INIT_REQUEST API or LDAP routine for creating a password policy bind initialize request and verifying the extended operation request.LDAP_CREATE_PERSISTENTSEARCH_CONTROLUse the LDAP_CREATE_PERSISTENTSEARCH_CONTROL API or LDAP routine to create a persistent search control that can be passed to the ldap_search_ext() or ldap_search_ext_s() function to initiate a persistent search.LDAP_CREATE_PREPARE_TRANSACTION_REQUESTUse the LDAP_CREATE_PREPARE_TRANSACTION_REQUEST API or LDAP routine to create a prepare transaction request.LDAP_CREATE_PROXYAUTH_CONTROLUse the LDAP_CREATE_PROXYAUTH_CONTROL API or LDAP routine to create an LDAP control that allows a bind entity to assume a proxy identity.LDAP_CREATE_RESUME_ROLE_REQUESTUse the LDAP_CREATE_RESUME_ROLE_REQUEST API to create a request for resuming the role extended operation. The LDAP routine creates a berval that can be sent by using the proxy back-end server resume role extended operation.LDAP_CREATE_RETURN_DELETED_OBJECTS_CONTROLUse the LDAP_CREATE_RETURN_DELETED_OBJECTS_CONTROL API or LDAP routine to create a return deleted objects control.LDAP_CREATE_TRANSACTION_CONTROLUse the LDAP_CREATE_TRANSACTION_CONTROL API or LDAP routine to create a transaction control that is sent by using the update operation within a transaction.LDAP_CREATE_VLV_CONTROLUse the LDAP_CREATE_VLV_CONTROL API or LDAP routine to create a virtual list view request control.LDAP_DELETEUse the LDAP_DELETE API or LDAP routine for conducting an LDAP operation to delete a leaf entry.LDAP_END_TRANSACTIONUse the LDAP_END_TRANSACTION API or LDAP routine to call an end transaction request.LDAP_ERRORUse the LDAP_ERROR API or LDAP routine to manage or handle protocol errors.LDAP_EXTENDED_OPERATIONUse the LDAP_EXTENDED_OPERATION API or LDAP routine to conduct extended operations and parse extended result.LDAP_FIRST_ATTRIBUTEUse the LDAP_FIRST_ATTRIBUTE API to step through the LDAP entry attributes.LDAP_FIRST_ENTRY, LDAP_FIRST_REFERENCEUse the LDAP_FIRST_ENTRY, LDAP_FIRST_REFERENCE API or LDAP routine for result entry and continuation reference parse and counting routines.LDAP_FREE_LIMIT_NUM_VALUES_RESPONSEUse the LDAP_FREE_LIMIT_NUM_VALUES_RESPONSE API or LDAP routine for freeing an LDAPNumValuesResponse structure.LDAP_GET_BIND_CONTROLSUse the LDAP_GET_BIND_CONTROLS API or LDAP routine to allow the client by using ldap_sasl_bind_s methods to get controls sent by the server.LDAP_GET_DNUse the LDAP_GET_DN API or LDAP routine to handle DN and RDN routines.LDAP_GET_TRAN_IDUse the LDAP_GET_TRAN_ID API or LDAP routine to get the transaction ID from the berval struct that is returned by the start transaction.LDAP_GET_VALUESUse the LDAP_GET_VALUES API or LDAP routine to fetch or manipulate values that handle routines.LDAP_INITUse the LDAP_INIT or LDAP routine to initialize the LDAP library and open a connection to an LDAP server, and get or set options for an LDAP connection.LDAP_MEMFREEUse the LDAP_MEMFREE API to free the storage that is allocated by the LDAP library.LDAP_MESSAGEUse the LDAP_MESSAGE API or LDAP routine to step through the list of messages in a result chain, as returned by ldap_result().LDAP_MODIFYUse the LDAP_MODIFY API to conduct various LDAP modify operations.LDAP_PAGED_RESULTSUse the LDAP_PAGED_RESULTS API or LDAP routine to request simple paged results of entries that are returned by the servers that match the filter that is specified on a search operation.LDAP_PARSE_EFFECTIVE_PWDPOLICY_RESPONSEUse the LDAP_PARSE_EFFECTIVE_PWDPOLICY_RESPONSE API or LDAP routine for extracting information from results that are returned by the ldap_parse_effective_pwdpolicy_request() routine.LDAP_PARSE_ENTRYCHANGE_CONTROLThe LDAP_PARSE_ENTRYCHANGE_CONTROL API or LDAP routine is used by a client application to parse the control when the client application receives entries that contain Entry Change Notification controls.LDAP_PARSE_EXTENDED_RESULT_W_CONTROLSUse the LDAP_PARSE_EXTENDED_RESULT_W_CONTROLS API or LDAP routine to parse the extended response result and return any response controls that are sent on the response.LDAP_PARSE_LIMIT_NUM_VALUES_RESPONSEUse the LDAP_PARSE_LIMIT_NUM_VALUES_RESPONSE API or LDAP routine to extract information from the results that are returned by the Limit Number of Attribute Values Control.LDAP_PARSE_RESULTUse the LDAP_PARSE_RESULT API or LDAP routine to extract information from the results that are returned by other LDAP API routines.LDAP_PARSE_VLV_CONTROLUse the LDAP_PARSE_VLV_CONTROL API or LDAP routine to parse a virtual list view control.LDAP_PASSWORD_POLICYUse the LDAP_PASSWORD_POLICY API or LDAP routine to extract information from results that are returned in the Password Policy Control structure.LDAP_PLUGIN_REGISTRATIONUse the LDAP_PLUGIN_REGISTRATION API or LDAP routine to register an LDAP client plug-in, obtain information about plug-ins that are registered by the application and plug-ins that are defined in ibmldap.conf, and free the array of plug-in information that is returned from the ldap_query_plugin() API.LDAP_PREPARE_TRANSACTIONUse the LDAP_PREPARE_TRANSACTION API or LDAP routine to call a prepare transaction request.LDAP_RENAMEUse the LDAP_RENAME API to carry out an LDAP rename operation.LDAP_RESTOREUse the LDAP_RESTORE API or LDAP routine to create and call an LDAP extended operation that requests a directory server restore.LDAP_RESULTUse the LDAP_RESULT API to wait for the result of an asynchronous LDAP operation, obtain LDAP message types, or obtain the message ID of an LDAP message.LDAP_SEARCHUse the LDAP_SEARCH API for carrying out various LDAP search operations.LDAP_SERVER_INFORMATION IN DNSUse the LDAP_SERVER_INFORMATION IN DNS API to run various LDAP operations for LDAP server information.LDAP_SSLUse the LDAP_SSL API or LDAP routine for initializing the Secure Socket Layer (SSL) function for an LDAP application, and creating a secure connection to an LDAP server.LDAP_SSL_PKCS11Use the LDAP_SSL_PKCS11 API or LDAP routine for setting up the SSL and PKCS#11 environment for GSKit.LDAP_START_TRANSACTIONUse the LDAP_START_TRANSACTION API or LDAP routine to call a start transaction request.LDAP_START_TLSUse the LDAP_START_TLS API or LDAP routine to start a TLS session.LDAP_STOP_TLSUse the LDAP_STOP_TLS API or LDAP routine to abandon an open LDAP connection over TLS.LDAP_URLUse the LDAP_URL API for Uniform Resource Locator routines.LDAP_SSL_ENVIRONMENT_INITUse the LDAP_SSL_ENVIRONMENT_INIT API to initialize SSL for a secure connection between a client and server.LDAP_SORTUse the LDAP_SORT API or LDAP routine to request the entries that are sort and returned by the servers that match the filter that is specified on a search operation.LDAP_SSL_SET_EXTN_SIGALG Use the ldap_ssl_set_extn_sigalg API in an LDAP application to set TLS 1.2 signature and hash algorithms.LDAP_SSL_SET_SUITEB_MODEUse the ldap_ssl_set_suiteb_mode API in an LDAP application to set Suite B mode.Parent topic: Programming reference