api documentation for activedirectory (v0.7.2)

ActiveDirectory is an ldapjs client for authN (authentication) and authZ (authorization) for Microsoft Active Directory with range retrieval support for large Active Directory installations.

table of contents

  1. module activedirectory
    1. function activedirectory (url, baseDN, username, password, defaults)
    2. function activedirectory.filters.AndFilter (options)
    3. function activedirectory.filters.ApproximateFilter (options)
    4. function activedirectory.filters.EqualityFilter (options)
    5. function activedirectory.filters.ExtensibleFilter (options)
    6. function activedirectory.filters.GreaterThanEqualsFilter (options)
    7. function activedirectory.filters.LessThanEqualsFilter (options)
    8. function activedirectory.filters.NotFilter (options)
    9. function activedirectory.filters.OrFilter (options)
    10. function activedirectory.filters.PresenceFilter (options)
    11. function activedirectory.filters.SubstringFilter (options)
    12. function activedirectory.rangeretrievalspecifierattribute (attribute)
    13. function activedirectory.super_ ()
    14. function activedirectory.user (properties)
    15. object activedirectory.activedirectory.prototype
    16. object activedirectory.filters
    17. object activedirectory.filters.AndFilter.prototype
    18. object activedirectory.filters.AndFilter.super_.prototype
    19. object activedirectory.filters.ApproximateFilter.prototype
    20. object activedirectory.filters.ApproximateFilter.super_.prototype
    21. object activedirectory.filters.EqualityFilter.prototype
    22. object activedirectory.filters.EqualityFilter.super_.prototype
    23. object activedirectory.filters.ExtensibleFilter.prototype
    24. object activedirectory.filters.ExtensibleFilter.super_.prototype
    25. object activedirectory.filters.GreaterThanEqualsFilter.prototype
    26. object activedirectory.filters.GreaterThanEqualsFilter.super_.prototype
    27. object activedirectory.filters.LessThanEqualsFilter.prototype
    28. object activedirectory.filters.LessThanEqualsFilter.super_.prototype
    29. object activedirectory.filters.NotFilter.prototype
    30. object activedirectory.filters.NotFilter.super_.prototype
    31. object activedirectory.filters.OrFilter.prototype
    32. object activedirectory.filters.OrFilter.super_.prototype
    33. object activedirectory.filters.PresenceFilter.prototype
    34. object activedirectory.filters.PresenceFilter.super_.prototype
    35. object activedirectory.filters.SubstringFilter.prototype
    36. object activedirectory.filters.SubstringFilter.super_.prototype
    37. object activedirectory.rangeretrievalspecifierattribute.prototype
    38. object activedirectory.user.prototype
  2. module activedirectory.activedirectory
    1. function activedirectory.activedirectory (url, baseDN, username, password, defaults)
    2. function activedirectory.activedirectory.super_ ()
    3. object activedirectory.activedirectory.filters
  3. module activedirectory.activedirectory.prototype
    1. function activedirectory.activedirectory.prototype._getDefaultAttributes ()
    2. function activedirectory.activedirectory.prototype._getDefaultGroupAttributes ()
    3. function activedirectory.activedirectory.prototype._getDefaultUserAttributes ()
    4. function activedirectory.activedirectory.prototype.authenticate (username, password, callback)
    5. function activedirectory.activedirectory.prototype.find (opts, callback)
    6. function activedirectory.activedirectory.prototype.findDeletedObjects (opts, callback)
    7. function activedirectory.activedirectory.prototype.findGroup (opts, groupName, callback)
    8. function activedirectory.activedirectory.prototype.findGroups (opts, callback)
    9. function activedirectory.activedirectory.prototype.findUser (opts, username, includeMembership, callback)
    10. function activedirectory.activedirectory.prototype.findUsers (opts, includeMembership, callback)
    11. function activedirectory.activedirectory.prototype.getGroupMembershipForGroup (opts, groupName, callback)
    12. function activedirectory.activedirectory.prototype.getGroupMembershipForUser (opts, username, callback)
    13. function activedirectory.activedirectory.prototype.getRootDSE (url, attributes, callback)
    14. function activedirectory.activedirectory.prototype.getUsersForGroup (opts, groupName, callback)
    15. function activedirectory.activedirectory.prototype.groupExists (opts, groupName, callback)
    16. function activedirectory.activedirectory.prototype.isUserMemberOf (opts, username, groupName, callback)
    17. function activedirectory.activedirectory.prototype.userExists (opts, username, callback)
  4. module activedirectory.filters
    1. function activedirectory.filters.AndFilter (options)
    2. function activedirectory.filters.ApproximateFilter (options)
    3. function activedirectory.filters.EqualityFilter (options)
    4. function activedirectory.filters.ExtensibleFilter (options)
    5. function activedirectory.filters.GreaterThanEqualsFilter (options)
    6. function activedirectory.filters.LessThanEqualsFilter (options)
    7. function activedirectory.filters.NotFilter (options)
    8. function activedirectory.filters.OrFilter (options)
    9. function activedirectory.filters.PresenceFilter (options)
    10. function activedirectory.filters.SubstringFilter (options)
    11. function activedirectory.filters.isFilter (filter)
    12. function activedirectory.filters.parse (ber)
    13. function activedirectory.filters.parseString (str)
  5. module activedirectory.filters.AndFilter
    1. function activedirectory.filters.AndFilter (options)
    2. function activedirectory.filters.AndFilter.super_ (options)
  6. module activedirectory.filters.AndFilter.prototype
    1. function activedirectory.filters.AndFilter.prototype._toBer (ber)
    2. function activedirectory.filters.AndFilter.prototype.toBer (ber)
  7. module activedirectory.filters.AndFilter.super_.prototype
    1. function activedirectory.filters.AndFilter.super_.prototype.addFilter (filter)
    2. function activedirectory.filters.AndFilter.super_.prototype.matches (target, strictAttrCase)
    3. function activedirectory.filters.AndFilter.super_.prototype.toString ()
  8. module activedirectory.filters.ApproximateFilter
    1. function activedirectory.filters.ApproximateFilter (options)
    2. function activedirectory.filters.ApproximateFilter.super_ (options)
  9. module activedirectory.filters.ApproximateFilter.prototype
    1. function activedirectory.filters.ApproximateFilter.prototype._toBer (ber)
    2. function activedirectory.filters.ApproximateFilter.prototype.parse (ber)
    3. function activedirectory.filters.ApproximateFilter.prototype.toBer (ber)
  10. module activedirectory.filters.ApproximateFilter.super_.prototype
    1. function activedirectory.filters.ApproximateFilter.super_.prototype.matches ()
    2. function activedirectory.filters.ApproximateFilter.super_.prototype.toString ()
  11. module activedirectory.filters.EqualityFilter
    1. function activedirectory.filters.EqualityFilter (options)
    2. function activedirectory.filters.EqualityFilter.super_ (options)
  12. module activedirectory.filters.EqualityFilter.prototype
    1. function activedirectory.filters.EqualityFilter.prototype._toBer (ber)
    2. function activedirectory.filters.EqualityFilter.prototype.matches (target, strictAttrCase)
    3. function activedirectory.filters.EqualityFilter.prototype.parse (ber)
    4. function activedirectory.filters.EqualityFilter.prototype.toBer (ber)
  13. module activedirectory.filters.EqualityFilter.super_.prototype
    1. function activedirectory.filters.EqualityFilter.super_.prototype.matches (target, strictAttrCase)
    2. function activedirectory.filters.EqualityFilter.super_.prototype.toString ()
  14. module activedirectory.filters.ExtensibleFilter
    1. function activedirectory.filters.ExtensibleFilter (options)
    2. function activedirectory.filters.ExtensibleFilter.super_ (options)
  15. module activedirectory.filters.ExtensibleFilter.prototype
    1. function activedirectory.filters.ExtensibleFilter.prototype._toBer (ber)
    2. function activedirectory.filters.ExtensibleFilter.prototype.parse (ber)
    3. function activedirectory.filters.ExtensibleFilter.prototype.toBer (ber)
  16. module activedirectory.filters.ExtensibleFilter.super_.prototype
    1. function activedirectory.filters.ExtensibleFilter.super_.prototype.matches ()
    2. function activedirectory.filters.ExtensibleFilter.super_.prototype.toString ()
  17. module activedirectory.filters.GreaterThanEqualsFilter
    1. function activedirectory.filters.GreaterThanEqualsFilter (options)
    2. function activedirectory.filters.GreaterThanEqualsFilter.super_ (options)
  18. module activedirectory.filters.GreaterThanEqualsFilter.prototype
    1. function activedirectory.filters.GreaterThanEqualsFilter.prototype._toBer (ber)
    2. function activedirectory.filters.GreaterThanEqualsFilter.prototype.parse (ber)
    3. function activedirectory.filters.GreaterThanEqualsFilter.prototype.toBer (ber)
  19. module activedirectory.filters.GreaterThanEqualsFilter.super_.prototype
    1. function activedirectory.filters.GreaterThanEqualsFilter.super_.prototype.matches (target, strictAttrCase)
    2. function activedirectory.filters.GreaterThanEqualsFilter.super_.prototype.toString ()
  20. module activedirectory.filters.LessThanEqualsFilter
    1. function activedirectory.filters.LessThanEqualsFilter (options)
    2. function activedirectory.filters.LessThanEqualsFilter.super_ (options)
  21. module activedirectory.filters.LessThanEqualsFilter.prototype
    1. function activedirectory.filters.LessThanEqualsFilter.prototype._toBer (ber)
    2. function activedirectory.filters.LessThanEqualsFilter.prototype.parse (ber)
    3. function activedirectory.filters.LessThanEqualsFilter.prototype.toBer (ber)
  22. module activedirectory.filters.LessThanEqualsFilter.super_.prototype
    1. function activedirectory.filters.LessThanEqualsFilter.super_.prototype.matches (target, strictAttrCase)
    2. function activedirectory.filters.LessThanEqualsFilter.super_.prototype.toString ()
  23. module activedirectory.filters.NotFilter
    1. function activedirectory.filters.NotFilter (options)
    2. function activedirectory.filters.NotFilter.super_ (options)
  24. module activedirectory.filters.NotFilter.prototype
    1. function activedirectory.filters.NotFilter.prototype._toBer (ber)
    2. function activedirectory.filters.NotFilter.prototype.toBer (ber)
  25. module activedirectory.filters.NotFilter.super_.prototype
    1. function activedirectory.filters.NotFilter.super_.prototype.addFilter (filter)
    2. function activedirectory.filters.NotFilter.super_.prototype.matches (target, strictAttrCase)
    3. function activedirectory.filters.NotFilter.super_.prototype.toString ()
  26. module activedirectory.filters.OrFilter
    1. function activedirectory.filters.OrFilter (options)
    2. function activedirectory.filters.OrFilter.super_ (options)
  27. module activedirectory.filters.OrFilter.prototype
    1. function activedirectory.filters.OrFilter.prototype._toBer (ber)
    2. function activedirectory.filters.OrFilter.prototype.toBer (ber)
  28. module activedirectory.filters.OrFilter.super_.prototype
    1. function activedirectory.filters.OrFilter.super_.prototype.addFilter (filter)
    2. function activedirectory.filters.OrFilter.super_.prototype.matches (target, strictAttrCase)
    3. function activedirectory.filters.OrFilter.super_.prototype.toString ()
  29. module activedirectory.filters.PresenceFilter
    1. function activedirectory.filters.PresenceFilter (options)
    2. function activedirectory.filters.PresenceFilter.super_ (options)
  30. module activedirectory.filters.PresenceFilter.prototype
    1. function activedirectory.filters.PresenceFilter.prototype._toBer (ber)
    2. function activedirectory.filters.PresenceFilter.prototype.parse (ber)
    3. function activedirectory.filters.PresenceFilter.prototype.toBer (ber)
  31. module activedirectory.filters.PresenceFilter.super_.prototype
    1. function activedirectory.filters.PresenceFilter.super_.prototype.matches (target, strictAttrCase)
    2. function activedirectory.filters.PresenceFilter.super_.prototype.toString ()
  32. module activedirectory.filters.SubstringFilter
    1. function activedirectory.filters.SubstringFilter (options)
    2. function activedirectory.filters.SubstringFilter.super_ (options)
  33. module activedirectory.filters.SubstringFilter.prototype
    1. function activedirectory.filters.SubstringFilter.prototype._toBer (ber)
    2. function activedirectory.filters.SubstringFilter.prototype.parse (ber)
    3. function activedirectory.filters.SubstringFilter.prototype.toBer (ber)
  34. module activedirectory.filters.SubstringFilter.super_.prototype
    1. function activedirectory.filters.SubstringFilter.super_.prototype.matches (target, strictAttrCase)
    2. function activedirectory.filters.SubstringFilter.super_.prototype.toString ()
  35. module activedirectory.rangeretrievalspecifierattribute
    1. function activedirectory.rangeretrievalspecifierattribute (attribute)
  36. module activedirectory.rangeretrievalspecifierattribute.prototype
    1. function activedirectory.rangeretrievalspecifierattribute.prototype.getRangeAttributes (item)
    2. function activedirectory.rangeretrievalspecifierattribute.prototype.hasRangeAttributes (item)
    3. function activedirectory.rangeretrievalspecifierattribute.prototype.isComplete ()
    4. function activedirectory.rangeretrievalspecifierattribute.prototype.isRangeAttribute (attribute)
    5. function activedirectory.rangeretrievalspecifierattribute.prototype.next ()
    6. function activedirectory.rangeretrievalspecifierattribute.prototype.toString ()
  37. module activedirectory.user
    1. function activedirectory.user (properties)
  38. module activedirectory.user.prototype
    1. function activedirectory.user.prototype.isMemberOf (group)

module activedirectory

function activedirectory (url, baseDN, username, password, defaults)

function activedirectory.filters.AndFilter (options)

function activedirectory.filters.ApproximateFilter (options)

function activedirectory.filters.EqualityFilter (options)

function activedirectory.filters.ExtensibleFilter (options)

function activedirectory.filters.GreaterThanEqualsFilter (options)

function activedirectory.filters.LessThanEqualsFilter (options)

function activedirectory.filters.NotFilter (options)

function activedirectory.filters.OrFilter (options)

function activedirectory.filters.PresenceFilter (options)

function activedirectory.filters.SubstringFilter (options)

function activedirectory.rangeretrievalspecifierattribute (attribute)

function activedirectory.super_ ()

function activedirectory.user (properties)

module activedirectory.activedirectory

function activedirectory.activedirectory (url, baseDN, username, password, defaults)

function activedirectory.activedirectory.super_ ()

module activedirectory.activedirectory.prototype

function activedirectory.activedirectory.prototype._getDefaultAttributes ()

function activedirectory.activedirectory.prototype._getDefaultGroupAttributes ()

function activedirectory.activedirectory.prototype._getDefaultUserAttributes ()

function activedirectory.activedirectory.prototype.authenticate (username, password, callback)

function activedirectory.activedirectory.prototype.find (opts, callback)

function activedirectory.activedirectory.prototype.findDeletedObjects (opts, callback)

function activedirectory.activedirectory.prototype.findGroup (opts, groupName, callback)

function activedirectory.activedirectory.prototype.findGroups (opts, callback)

function activedirectory.activedirectory.prototype.findUser (opts, username, includeMembership, callback)

function activedirectory.activedirectory.prototype.findUsers (opts, includeMembership, callback)

function activedirectory.activedirectory.prototype.getGroupMembershipForGroup (opts, groupName, callback)

function activedirectory.activedirectory.prototype.getGroupMembershipForUser (opts, username, callback)

function activedirectory.activedirectory.prototype.getRootDSE (url, attributes, callback)

function activedirectory.activedirectory.prototype.getUsersForGroup (opts, groupName, callback)

function activedirectory.activedirectory.prototype.groupExists (opts, groupName, callback)

function activedirectory.activedirectory.prototype.isUserMemberOf (opts, username, groupName, callback)

function activedirectory.activedirectory.prototype.userExists (opts, username, callback)

module activedirectory.filters

function activedirectory.filters.AndFilter (options)

function activedirectory.filters.ApproximateFilter (options)

function activedirectory.filters.EqualityFilter (options)

function activedirectory.filters.ExtensibleFilter (options)

function activedirectory.filters.GreaterThanEqualsFilter (options)

function activedirectory.filters.LessThanEqualsFilter (options)

function activedirectory.filters.NotFilter (options)

function activedirectory.filters.OrFilter (options)

function activedirectory.filters.PresenceFilter (options)

function activedirectory.filters.SubstringFilter (options)

function activedirectory.filters.isFilter (filter)

function activedirectory.filters.parse (ber)

function activedirectory.filters.parseString (str)

module activedirectory.filters.AndFilter

function activedirectory.filters.AndFilter (options)

function activedirectory.filters.AndFilter.super_ (options)

module activedirectory.filters.AndFilter.prototype

function activedirectory.filters.AndFilter.prototype._toBer (ber)

function activedirectory.filters.AndFilter.prototype.toBer (ber)

module activedirectory.filters.AndFilter.super_.prototype

function activedirectory.filters.AndFilter.super_.prototype.addFilter (filter)

function activedirectory.filters.AndFilter.super_.prototype.matches (target, strictAttrCase)

function activedirectory.filters.AndFilter.super_.prototype.toString ()

module activedirectory.filters.ApproximateFilter

function activedirectory.filters.ApproximateFilter (options)

function activedirectory.filters.ApproximateFilter.super_ (options)

module activedirectory.filters.ApproximateFilter.prototype

function activedirectory.filters.ApproximateFilter.prototype._toBer (ber)

function activedirectory.filters.ApproximateFilter.prototype.parse (ber)

function activedirectory.filters.ApproximateFilter.prototype.toBer (ber)

module activedirectory.filters.ApproximateFilter.super_.prototype

function activedirectory.filters.ApproximateFilter.super_.prototype.matches ()

function activedirectory.filters.ApproximateFilter.super_.prototype.toString ()

module activedirectory.filters.EqualityFilter

function activedirectory.filters.EqualityFilter (options)

function activedirectory.filters.EqualityFilter.super_ (options)

module activedirectory.filters.EqualityFilter.prototype

function activedirectory.filters.EqualityFilter.prototype._toBer (ber)

function activedirectory.filters.EqualityFilter.prototype.matches (target, strictAttrCase)

function activedirectory.filters.EqualityFilter.prototype.parse (ber)

function activedirectory.filters.EqualityFilter.prototype.toBer (ber)

module activedirectory.filters.EqualityFilter.super_.prototype

function activedirectory.filters.EqualityFilter.super_.prototype.matches (target, strictAttrCase)

function activedirectory.filters.EqualityFilter.super_.prototype.toString ()

module activedirectory.filters.ExtensibleFilter

function activedirectory.filters.ExtensibleFilter (options)

function activedirectory.filters.ExtensibleFilter.super_ (options)

module activedirectory.filters.ExtensibleFilter.prototype

function activedirectory.filters.ExtensibleFilter.prototype._toBer (ber)

function activedirectory.filters.ExtensibleFilter.prototype.parse (ber)

function activedirectory.filters.ExtensibleFilter.prototype.toBer (ber)

module activedirectory.filters.ExtensibleFilter.super_.prototype

function activedirectory.filters.ExtensibleFilter.super_.prototype.matches ()

function activedirectory.filters.ExtensibleFilter.super_.prototype.toString ()

module activedirectory.filters.GreaterThanEqualsFilter

function activedirectory.filters.GreaterThanEqualsFilter (options)

function activedirectory.filters.GreaterThanEqualsFilter.super_ (options)

module activedirectory.filters.GreaterThanEqualsFilter.prototype

function activedirectory.filters.GreaterThanEqualsFilter.prototype._toBer (ber)

function activedirectory.filters.GreaterThanEqualsFilter.prototype.parse (ber)

function activedirectory.filters.GreaterThanEqualsFilter.prototype.toBer (ber)

module activedirectory.filters.GreaterThanEqualsFilter.super_.prototype

function activedirectory.filters.GreaterThanEqualsFilter.super_.prototype.matches (target, strictAttrCase)

function activedirectory.filters.GreaterThanEqualsFilter.super_.prototype.toString ()

module activedirectory.filters.LessThanEqualsFilter

function activedirectory.filters.LessThanEqualsFilter (options)

function activedirectory.filters.LessThanEqualsFilter.super_ (options)

module activedirectory.filters.LessThanEqualsFilter.prototype

function activedirectory.filters.LessThanEqualsFilter.prototype._toBer (ber)

function activedirectory.filters.LessThanEqualsFilter.prototype.parse (ber)

function activedirectory.filters.LessThanEqualsFilter.prototype.toBer (ber)

module activedirectory.filters.LessThanEqualsFilter.super_.prototype

function activedirectory.filters.LessThanEqualsFilter.super_.prototype.matches (target, strictAttrCase)

function activedirectory.filters.LessThanEqualsFilter.super_.prototype.toString ()

module activedirectory.filters.NotFilter

function activedirectory.filters.NotFilter (options)

function activedirectory.filters.NotFilter.super_ (options)

module activedirectory.filters.NotFilter.prototype

function activedirectory.filters.NotFilter.prototype._toBer (ber)

function activedirectory.filters.NotFilter.prototype.toBer (ber)

module activedirectory.filters.NotFilter.super_.prototype

function activedirectory.filters.NotFilter.super_.prototype.addFilter (filter)

function activedirectory.filters.NotFilter.super_.prototype.matches (target, strictAttrCase)

function activedirectory.filters.NotFilter.super_.prototype.toString ()

module activedirectory.filters.OrFilter

function activedirectory.filters.OrFilter (options)

function activedirectory.filters.OrFilter.super_ (options)

module activedirectory.filters.OrFilter.prototype

function activedirectory.filters.OrFilter.prototype._toBer (ber)

function activedirectory.filters.OrFilter.prototype.toBer (ber)

module activedirectory.filters.OrFilter.super_.prototype

function activedirectory.filters.OrFilter.super_.prototype.addFilter (filter)

function activedirectory.filters.OrFilter.super_.prototype.matches (target, strictAttrCase)

function activedirectory.filters.OrFilter.super_.prototype.toString ()

module activedirectory.filters.PresenceFilter

function activedirectory.filters.PresenceFilter (options)

function activedirectory.filters.PresenceFilter.super_ (options)

module activedirectory.filters.PresenceFilter.prototype

function activedirectory.filters.PresenceFilter.prototype._toBer (ber)

function activedirectory.filters.PresenceFilter.prototype.parse (ber)

function activedirectory.filters.PresenceFilter.prototype.toBer (ber)

module activedirectory.filters.PresenceFilter.super_.prototype

function activedirectory.filters.PresenceFilter.super_.prototype.matches (target, strictAttrCase)

function activedirectory.filters.PresenceFilter.super_.prototype.toString ()

module activedirectory.filters.SubstringFilter

function activedirectory.filters.SubstringFilter (options)

function activedirectory.filters.SubstringFilter.super_ (options)

module activedirectory.filters.SubstringFilter.prototype

function activedirectory.filters.SubstringFilter.prototype._toBer (ber)

function activedirectory.filters.SubstringFilter.prototype.parse (ber)

function activedirectory.filters.SubstringFilter.prototype.toBer (ber)

module activedirectory.filters.SubstringFilter.super_.prototype

function activedirectory.filters.SubstringFilter.super_.prototype.matches (target, strictAttrCase)

function activedirectory.filters.SubstringFilter.super_.prototype.toString ()

module activedirectory.rangeretrievalspecifierattribute

function activedirectory.rangeretrievalspecifierattribute (attribute)

module activedirectory.rangeretrievalspecifierattribute.prototype

function activedirectory.rangeretrievalspecifierattribute.prototype.getRangeAttributes (item)

function activedirectory.rangeretrievalspecifierattribute.prototype.hasRangeAttributes (item)

function activedirectory.rangeretrievalspecifierattribute.prototype.isComplete ()

function activedirectory.rangeretrievalspecifierattribute.prototype.isRangeAttribute (attribute)

function activedirectory.rangeretrievalspecifierattribute.prototype.next ()

function activedirectory.rangeretrievalspecifierattribute.prototype.toString ()

module activedirectory.user

function activedirectory.user (properties)

module activedirectory.user.prototype

function activedirectory.user.prototype.isMemberOf (group)

[ this document was created with utility2 ]