Skip to main content
Code42 Support

LDAP reference

Available in:

StandardPremiumEnterprise
Small Business
Applies to:

Overview

Leverage your organization's existing directory services environment by enabling LDAP integration in Code42 for Enterprise. You must have an on-premises authority server to use LDAP with Code42 for Enterprise.

Advantages

LDAP integration provides the following advantages in Active Directory, OpenDirectory, or LDAP environments:

  • Simplifies the rollout and ongoing administration of your organization's users and devices
  • Simplifies the user experience because the user’s existing LDAP username and password are used to sign in to Code42 for Enterprise

With LDAP integration enabled:

  • The authority server handles all communication with the LDAP server. Devices never communicate with the LDAP server directly, which means your directory services environment can remain behind your firewall.
  • An LDAP-integrated authority server is only allowed to perform search and retrieval operations. LDAP entries in your directory services environment are never modified by Code42 for Enterprise.

The following illustration shows the authentication path between devices, the authority server, and directory services:
LDAP diagram

User management

Password changes
Once LDAP authentication is enabled, any password changes for LDAP-enabled users must be accomplished using the LDAP server.

Enabling LDAP integration enhances user management by:

  • Adding flexibility
  • Simplifying onboarding and offboarding
  • Automating user management

A single Code42 environment can utilize a mix of authentication methods on a per-organization basis:

This provides great flexibility for customizing each organization's environment and simplifies the processes of adding, removing, or suspending user privileges.

Synchronization

The authority server synchronizes with the defined LDAP servers on a regular basis, according to the customizable synchronization schedule. When the authority server synchronizes with an LDAP server, it compares the list of active users in its internal database with the entries in the LDAP directory, and applies rules to determine which users should be deactivated, which org a user should be placed in, and which roles to assign to users. An LDAP-enabled Code42 environment never changes any LDAP entries or attributes.

By default, synchronization automatically deactivates users who are not in the set of users returned by the search filter. In addition, you can configure your authority server to perform other user management operations based upon user LDAP information.

Adding Code42 platform users
LDAP integration helps to manage users, but it does not create them on its own. Create users alongside LDAP integration in one of three ways:

JavaScript to automate user management functions

You can automate the following user management tasks with customizable JavaScript entries:

LDAP settings in the administration console

LDAP settings

Item Description
a LDAP Servers List of your configured LDAP servers. Click the name to edit.
b Add Add a new LDAP server.
c Registrants not found Defines how your Code42 environment handles new account registration attempts from users who are not found in the LDAP search. Options are to Deny Registration or to place the user into an organization that does not use LDAP for authentication.
d Every Defines the LDAP synchronization schedule for the Code42 app. The Code42 app will communicate with the defined LDAP servers according to this schedule. Users who no longer match the search filter, or who are flagged as inactive by the Active Script, will be deactivated during synchronization. If Never is selected, the Code42 app will never synchronize and run the Active, Org name, or Role name scripts automatically, although initial authentication will still occur.
e Last Sync Displays how long ago the most recent LDAP sync ran.
f History View results of previous LDAP sync jobs.
g Synchronize now Initiate LDAP synchronization immediately. Users and associated devices that no longer match the search filter, or which are flagged by the Active Script, will be deactivated immediately.
h Simulate Synchronize Perform the LDAP synchronization search, but do not deactivate users. Run this job to see who would be deactivated if the sync actually ran right now.

Add

LDAP Server Setup

Item Description
a Server Name Label used to describe this LDAP server.
b URL and search base The protocol, host, and port used to communicate with the LDAP server, plus the search base within the LDAP structure where LDAP queries will begin.
c Reachable/unreachable Result of the connection test to verify that the LDAP server is accessible on the defined protocol, host, and port.
LDAP is reachable
LDAP is not reachable.
d Bind anonymously Disabled by default. Enable this option to perform LDAP binds without authenticating.
e Bind DN Used when Bind anonymously is disabled. Enter the full DN for the LDAP user that will bind and perform LDAP queries.
f Bind password Password of the LDAP user (e) performing the bind.
g Bindable/bind failed Results of the test used to verify that the bind user is actually able to bind to LDAP server.
Bind succeeded
Bind failed
h Search filter Defines which LDAP attribute your Code42 environment uses to search for users. The attribute mapping process uses the search filter to determine usernames.
i matches Count of LDAP users that match your LDAP search parameters.
j Timeout seconds How long the authority server should wait for a response before the LDAP lookup times out.

Attribute mapping

Attribute mapping defines how users' LDAP attributes relate to users in your Code42 environment.

LDAP Attribute Mapping

Item Description
k Search results LDAP search results populate on the right of the window to show how the user's LDAP information maps to the user's account information within your Code42 environment.
l Username

Attribute used to determine the username within your Code42 environment. Value is taken from the Search filter field (h).


If you use the mail attribute for Username and the user has multiple email addresses listed in LDAP, a user is created for each email address.

m Email Select which LDAP attribute to set as the user's email address.
n First name Select which LDAP attribute to set as the user's first name.
o Last name Select which LDAP attribute to set as the user's last name.
p Active script1

Javascript that deactivates or activates users based on LDAP attributes. For example, you may want users with an LDAP attribute of terminated=true deactivated within your Code42 environment during the synchronization process.

The Active script must not be left blank. The default entry is function(entry) { return true; }

q Org name script1

(Optional) Javascript that defines the organization a user belongs to.

Using LDAP Org name script organization mapping requires that each organization in your Code42 environment has a unique name.

r Role name script1 (Optional) Javascript that defines which roles a user is granted. For example, grant the Org Admin role to any user with the LDAP attribute employeeType=admin.
s Distinguished name The full distinguished name of the user presented in the search results.
t Username search Search for a specific username within the returned LDAP query results.
u Search pagination Page through search results.

1These settings are not available for Code42 for Enterprise customers with the Code42 CrashPlan Standard product plan.

Do not use regular expressions (regex) in Code42 LDAP scripts
Use of regex syntax causes LDAP sync to take much longer to complete than using other string functions.