Module : ldap

Version : 1.0.0

Module Overview

This module provides an inbound LDAP authentication provider, which is used to authenticate using LDAP credentials.

For information on the operations, which you can perform with this module, see the below Functions. For an example on the usage of the operations, see the Secured Service with LDAP Example.

Records

LdapConnection

Represets the LDAP connection.

LdapConnectionConfig

Represents the configurations that are required for an LDAP auth store.

SecureSocket

Configures the SSL/TLS options to be used for LDAP communication.

Classes

InboundLdapAuthProvider

Represents the inbound LDAP auth provider.

Functions

doAuthenticate
I

Authenticates with the username and password.

getGroups
I

Retrieves the group(s) of the user related to the provided username.

initLdapConnectionContext
I

Initailizes the LDAP connection context.

Types

Error

Represents LDAP module related errors.

Errors

LdapError

Represents the LDAP error type with the message and the cause.