Class LdapClient

Basic wrapper for the ldapjs library.

Helps out with promisifying calls, paging, binding etc.

Index

Constructors

Methods

getRootDSE getVendor search create

Constructors

constructor

new LdapClient(client: Client, logger: LoggerService): LdapClient
Parameters
- client: Client
- logger: LoggerService
Returns LdapClient
- Defined in plugins/catalog-backend-module-ldap/src/ldap/client.ts:89

Methods

getRootDSE

getRootDSE(): Promise<Entry | undefined>
Get the Root DSE.

Returns Promise<Entry | undefined>
See
https://ldapwiki.com/wiki/RootDSE
- Defined in plugins/catalog-backend-module-ldap/src/ldap/client.ts:214

getVendor

getVendor(): Promise<LdapVendor>
Get the Server Vendor. Currently only detects Microsoft Active Directory Servers.

Returns Promise<LdapVendor>
See
https://ldapwiki.com/wiki/Determine LDAP Server Vendor
- Defined in plugins/catalog-backend-module-ldap/src/ldap/client.ts:127

search

search(dn: string, options: SearchOptions): Promise<SearchResult>
Performs an LDAP search operation.
Parameters
- dn: string
  The fully qualified base DN to search within
- options: SearchOptions
  The search options
Returns Promise<SearchResult>
- Defined in plugins/catalog-backend-module-ldap/src/ldap/client.ts:100

`Static`create

create(
    logger: LoggerService,
    target: string,
    bind?: BindConfig,
    tls?: TLSConfig,
): Promise<LdapClient>
Parameters
- logger: LoggerService
- target: string
- Optionalbind: BindConfig
- Optionaltls: TLSConfig
Returns Promise<LdapClient>
- Defined in plugins/catalog-backend-module-ldap/src/ldap/client.ts:44