Skip to content

Latest commit

History

67 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

LDAP js client

'Build status'

node >= 8.0

No jdapjs (https://www.npmjs.com/package/ldapjs) as dependency.

Why: because jdapjs is not maintained for more than two years.

Installation

npm install ldapjs-client

Usage

To create a new client:

varLdapClient=require('ldapjs-client');varclient=newLdapClient({url: 'ldap://127.0.0.1:389'});
AttributeTypeDescription
urlStringA valid LDAP URL (proto/host/port only)
timeoutNumberMilliseconds client should let operations live for before timing out (Default: Infinity)
tlsOptionsObjectAdditional options passed to TLS connection layer when connecting via ldaps:// (See: The TLS docs for node.js)

add

try{constentry={cn: 'foo',sn: 'bar',email: ['foo@bar.com','foo1@bar.com'],objectclass: 'fooPerson'};awaitclient.add('cn=foo, o=example',entry);}catch(e){console.log('Add failed');}

bind

try{awaitclient.bind('username','password');}catch(e){console.log('Bind failed');}

del

try{awaitclient.del('cn=foo, o=example');}catch(e){console.log(e);}

modify

try{constchange={operation: 'add',// add, delete, replacemodification: {pets: ['cat','dog']}};awaitclient.modify('cn=foo, o=example',change);}catch(e){console.log(e);}

modifyDN

try{awaitclient.modifyDN('cn=foo, o=example','cn=bar');}catch(e){console.log(e);}

search

try{constoptions={filter: '(&(l=Seattle)(email=*@foo.com))',scope: 'sub',attributes: ['dn','sn','cn']};constentries=awaitclient.search('o=example',options);}catch(e){console.log(e);}
AttributeTypeDescription
scopeStringOne of base, one, or sub. Defaults to base
filterStringA string version of an LDAP filter. Defaults to (objectclass=*)
attributesArray of Stringattributes to select and return. Defaults to the empty set, which means all attributes
sizeLimitNumberthe maximum number of entries to return. Defaults to 0 (unlimited)
timeLimitNumberthe maximum amount of time the server should take in responding, in seconds. Defaults to 10. Lots of servers will ignore this
typesOnlyBooleanon whether you want the server to only return the names of the attributes, and not their values. Borderline useless. Defaults to false

unbind

try{awaitclient.unbind();}catch(e){console.log(e);}

destroy

try{awaitclient.unbind();}catch(e){console.log(e);}

Close connection if exists and destroy current client


Pull requests and suggestions are welcome!

License

MIT.

About

LDAP Client API for node.js

Resources

Stars

0 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages