From 62f9ff30643769099a30b9997a25dc3b84832540 Mon Sep 17 00:00:00 2001 From: Fabio Poloni Date: Mon, 19 Nov 2018 06:15:38 +0100 Subject: [PATCH] fixed headings --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 1361451..feb57c6 100755 --- a/README.md +++ b/README.md @@ -62,6 +62,7 @@ Documentation --------------------------------------- + ### authenticate(username, password, callback) Authenticates the username and password by doing a simple bind with the specified credentials. @@ -97,6 +98,7 @@ ad.authenticate(username, password, function(err, auth) { --------------------------------------- + ### isUserMemberOf(opts, username, groupName, callback) Checks to see if a user is a member of the specified group. This function will also check for group membership inside of a group. Even if a user is not explicity listed as a member of a particular group, if a group that the user is a member of belongs to the group, then this function will return true. @@ -127,6 +129,7 @@ var ad.isUserMemberOf(username, groupName, function(err, isMember) { --------------------------------------- + ### groupExists(opts, groupName, callback) Checks to see if the specified group exists. @@ -155,6 +158,7 @@ ad.groupExists(groupName, function(err, exists) { --------------------------------------- + ### userExists(opts, username, callback) Checks to see if the specified user exists. @@ -183,6 +187,7 @@ ad.userExists(username, function(err, exists) { --------------------------------------- + ### getUsersForGroup(opts, groupName, callback) For the specified group, retrieve all of the users that belong to the group. If the group contains groups, then the members of those groups are recursively retrieved as well to build a complete list of users that belong to the specified group. @@ -215,6 +220,7 @@ ad.getUsersForGroup(groupName, function(err, users) { --------------------------------------- + ### getGroupMembershipForUser(opts, username, callback) For the specified username, retrieve all of the groups that a user belongs to. If a retrieved group is a member of another group, then that group is recursively retrieved as well to build a complete hierarchy of groups that a user belongs to. @@ -244,6 +250,7 @@ ad.getGroupMembershipForUser(sAMAccountName, function(err, groups) { --------------------------------------- + ### getGroupMembershipForGroup(opts, groupName, callback) For the specified group, retrieve all of the groups that the group is a member of. If a retrieved group is a member of another group, then that group is recursively retrieved as well to build a complete hierarchy of groups that a user belongs to. @@ -273,6 +280,7 @@ ad.getGroupMembershipForGroup(groupName, function(err, groups) { --------------------------------------- + ### find(opts, callback) Perform a generic search for the specified LDAP query filter. This function will return both @@ -320,6 +328,7 @@ ad.find(query, function(err, results) { --------------------------------------- + ### findDeletedObjects(opts, callback) If tombstoning (recycle bin) is enabled for the Active Directory installation, use findDeletedObjects to retrieve @@ -361,6 +370,7 @@ ad.findDeletedObjects(opts, function(err, result) { --------------------------------------- + ### findUser(opts, username, callback) Looks up or finds a username by their sAMAccountName, userPrincipalName, distinguishedName (dn) or custom filter. If found, the returned object contains all of the requested attributes. By default, the following attributes are returned: @@ -397,6 +407,7 @@ ad.findUser(sAMAccountName, function(err, user) { --------------------------------------- + ### findUsers(opts, callback) Perform a generic search for users that match the specified filter. The default LDAP filter for users is @@ -428,6 +439,7 @@ ad.findUsers(query, function(err, users) { --------------------------------------- + ### findGroup(opts, groupName, callback) Looks up or find a group by common name (CN) which is required to be unique in Active Directory or optionally by the distinguished name. Supports groups with range retrieval specifiers. The following attributes are returned by default for the group: @@ -467,6 +479,7 @@ ad.findGroup(groupName, function(err, group) { --------------------------------------- + ### findGroups(opts, callback) Perform a generic search for groups that match the specified filter. The default LDAP filter for groups is @@ -498,6 +511,7 @@ ad.findGroups(query, function(err, groups) { --------------------------------------- + ### getRootDSE(url, attributes, callback) Retrieves the root DSE for the specified url. Can be called statically. @@ -638,6 +652,7 @@ ad.findUser(opts, 'userPrincipalName=bob@domain.com', function(err, user) { ``` + ### Optional Parameters / Extended Functionality Any method which takes an 'opts' parameter allows for additional options. Options for both activedirectory.js