Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including node-red-contrib-activedirectory with all npm packages installed. Try it out:

node-red-contrib-activedirectory lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:

// require("node-red-contrib-activedirectory/[??]")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

node-red-contrib-activedirectory v0.1.0

Node-RED node collection for Microsoft Active Directory.

ActiveDirectory for Node-RED

build

node-red-contrib-activedirectory is a Node-RED nodes collection for Microsoft Active Directory. It is based on the activedirectory2 ldapjs client for auth (authentication) and authZ (authorization) for Microsoft Active Directory (documentation here).

If you want to contribute in order to add brand new features and/or nodes, do not hesitate to join and submit your merge requests!

Getting started

  1. Install Node-RED (more):
sudo npm install -g node-red
  1. Go to your node-RED conf directory (basically ~/.node-red)
npm install node-red-contrib-activedirectory
  1. There you go! You can run Node-RED with:
node-red

Documentation


Connection

Every node requires LDAP configuration/credentials to create an instance of the client configured according to the following options:

  • url {string}: Active Directory server to connect to, e.g. ldap://ad.example.com.
  • [baseDN] {string}: Optional, The root DN from which all searches will be performed, e.g. dc=example,dc=com.
  • username {string}: An account name capable of performing the operations desired.
  • password {string}: Password for the given username.

image of node credentials

findUser

image of node finduser

Connects to a Microsoft Active Directory and returns the user corresponding to the username/DN set in msg.payload.

Inputs

  • msg.payload {string}: the AD username of the user we want to get information. It also works with DN.
  • msg.ad_attributes {JSON Object}: the attributes we want to return for users and groups. By default:
{
  "user": [
      "dn", "distinguishedName",
      "userPrincipalName", "sAMAccountName", "mail",
      "lockoutTime", "whenCreated", "pwdLastSet", "userAccountControl",
      "employeeID", "sn", "givenName", "initials", "cn", "displayName",
      "comment", "description", "url"
  ],
  "group": [
      "dn", "cn", "description", "distinguishedName", "objectCategory"
  ]
}
  • msg.tlsOptions {JSON Object}: (Optional) Additional options passed to TLS connection layer when connecting via ldaps://. (See: TLS docs for node.js).

Outputs

  • msg.payload {JSON Object}: the standard output of the command, a JSON object that contains all the information about the user.

findGroup

image of node findgroup

Connects to a Microsoft Active Directory and returns the group corresponding to the groupname/DN set in msg.payload.

Inputs

  • msg.payload {string}: the AD groupname of the group we want to get information. It also works with DN.
  • msg.ad_attributes {JSON Object}: the attributes we want to return for users and groups. By default:
{
  "user": [
      "dn", "distinguishedName",
      "userPrincipalName", "sAMAccountName", "mail",
      "lockoutTime", "whenCreated", "pwdLastSet", "userAccountControl",
      "employeeID", "sn", "givenName", "initials", "cn", "displayName",
      "comment", "description", "url"
  ],
  "group": [
      "dn", "cn", "description", "distinguishedName", "objectCategory"
  ]
}
  • msg.tlsOptions {JSON Object}: (Optional) Additional options passed to TLS connection layer when connecting via ldaps://. (See: TLS docs for node.js).

Outputs

  • msg.payload {JSON Object}: the standard output of the command, a JSON object that contains all the information about the group.

query

image of node query

Connects to a Microsoft Active Directory and returns the result of the AD query input set in msg.payload.

Inputs

  • msg.payload {string}: an LDAP query (more information: LDAP query basics).
  • msg.ad_attributes {JSON Object}: the attributes we want to return for users and groups. By default:
{
  "user": [
      "dn", "distinguishedName",
      "userPrincipalName", "sAMAccountName", "mail",
      "lockoutTime", "whenCreated", "pwdLastSet", "userAccountControl",
      "employeeID", "sn", "givenName", "initials", "cn", "displayName",
      "comment", "description", "url"
  ],
  "group": [
      "dn", "cn", "description", "distinguishedName", "objectCategory"
  ]
}
  • msg.tlsOptions {JSON Object}: (Optional) Additional options passed to TLS connection layer when connecting via ldaps://. (See: TLS docs for node.js).

Outputs

  • msg.payload {JSON Object}: the standard output of the command, a JSON object that contains result of the AD query input.
RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free