simple-ldap-search

Simple LDAP Searching.

Stats

StarsIssuesVersionUpdatedCreatedSize
simple-ldap-search
863.0.28 months ago5 years agoMinified + gzip package size for simple-ldap-search in KB

Readme

Simple LDAP Search

NPM Version

Searches LDAP. Nothing fancy.

A thin, promisified wrapper over LDAPjs's client.

Installation

$ npm install --save simple-ldap-search

Usage

import SimpleLDAP from 'simple-ldap-search';

const config = {
  url: 'ldap://0.0.0.0:1389',
  base: 'dc=users,dc=localhost',
  dn: 'cn=root',
  password: 'secret',
};

// create a new client
const ldap = new SimpleLDAP(config);

// setup a filter and attributes for your LDAP query
const filter = '(uid=artvandelay)';
const attributes = ['idNumber', 'uid', 'givenName', 'sn', 'telephoneNumber'];

// using async/await
const users = await ldap.search(filter, attributes);

// [{
//   dn: 'uid=artvandelay, dc=users, dc=localhost',
//   idNumber: 1234567,
//   uid: 'artvandelay',
//   givenName: 'Art',
//   sn: 'Vandelay',
//   telephoneNumber: '555-123-4567',
// }]

API

ldap.search(filter, attributes)

Parameters

  • filter: filters results.
  • attributes: a list of attributes to return

Returns

  • A promise for the results

ldap.destroy()

Destroys the connection to the LDAP server. Use when all done with LDAP client.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.