LDAP Authentication

npm Enterprise supports most LDAP corporate directories, including Active Directory and OpenLDAP.

It's important to note that, when using LDAP integration, your npm Enterprise instance(s) should typically be running on the same subnet as your LDAP servers.

Note that you can also use LDAP integration for logging into the admin console (port :8800) as well. If you'd like to set that up, visit the /create-password page once you're logged in, choose LDAP, and enter the settings just as you would below.

Server Settings

LDAP Type

Required: What type of LDAP does your corporate directory use?

Options are OpenLDAP, Active Directory, and Other.

Hostname

Required: The hostname or domain name that represents your LDAP server.

Port

Required: The port that should be used when accessing the LDAP server.

Default is 389.

Encryption Type

Required: The type of encryption your LDAP provider supports.

Options are Plain, StartTLS, and LDAPS.

Search user

Required: The user, in distinguished name (DN) format, that npm Enterprise should use to log into LDAP. When users attempt to authenticate against the private npm registry or website, npm Enterprise will use this user to query the corporate directory service. This should typically include at least one common name (CN) representing a read-only service or admin user.

Search Password

Required: The password associated with the "Search user" above.

LDAP Schema

Base DN

Required: The root node, in distinguished name (DN) format, in the LDAP tree. The root node should be a parent of the "User search DN" below.

User Search DN

Required: The tree node, in distinguished name (DN) format, relative to the "Base DN" above, that all npm Enterprise users should belong to. This is typically a single common name (CN) or organizational unit (OU).

Restricted User Group

Optional: A group name that users must be a part of, used as an additional criterion in the LDAP query when looking up users. This is typically not a distinguished name (DN).

Username Field

Required: The attribute of a user entry that represents the username to be used when authenticating. Active Directory uses sAMAccountName as its default.

Test LDAP Settings

You can test your LDAP configuration directly from the admin console UI. Just provide a test username and password and click the Test LDAP button. The result of the test will be displayed next to the button.

Test Username

The username value to test LDAP configuration with.

Test Password

The password value to test LDAP configuration with.

Example Configuration