New Xton Documentation Center
Xton help has moved. Please visit the current version of this page for the most recent updates. Our new documentation center can be found at help.xtontech.com.
How to configure JumpCloud LDAP-as-a-Service Integration with XTAM
To integrate Jump Cloud’s LDAP-as-a-Service with XTAM you will need to perform the following procedure.
Pre-requisites
- A JumpCloud account that this configured as an LDAP Binding User. Please reference this JumpCloud article (external link) for more information.
- A connection and account to login to the XTAM host server to run commands, update configuration files and restart services.
- A JumpCloud account to test the integration.
Login to JumpCloud to retrieve your LDAP Binding User and the required parameters to perform the integration. This includes the LDAP Binding Account (DN), LDAP Binding Account password and your JumpCloud OrgID. For additional information, please review this JumpCloud article: https://support.jumpcloud.com/support/s/article/using-jumpclouds-ldap-as-a-service1#createuser
On the XTAM host server, open a command prompt and navigate to $XTAM_HOME
From the $XTAM_HOME directory, execute the following command, replace the placeholders with your actual JumpCloud vaules.
For Windows, substitute your <CONNECTION_NAME>, <LDAP_BINDING_USER>, <YOUR_ORG_ID> and <LDAP_BINDING_USER_PASSWORD> values and issue:
bin\PamDirectory.cmd LdapConnect web <CONNECTION_NAME> ldaps://ldap.jumpcloud.com:636 "uid=<LDAP_BINDING_USER>,ou=Users,o=<YOUR_ORG_ID>,dc=jumpcloud,dc=com" <LDAP_BINDING_USER_PASSWORD>
For Unix or Linux, substitute your <CONNECTION_NAME>, <LDAP_BINDING_USER>, <YOUR_ORG_ID> and <LDAP_BINDING_USER_PASSWORD> values and issue:
bin/pamdirectory.sh LdapConnect web <CONNECTION_NAME> ldaps://ldap.jumpcloud.com:636 "uid=<LDAP_BINDING_USER>,ou=Users,o=<YOUR_ORG_ID>,dc=jumpcloud,dc=com" <LDAP_BINDING_USER_PASSWORD>
When the command executes successfully (it will return an Ok response), next open the file $XTAM_HOME/web/conf/catalina.properties file in a text editor. You will need to manually update a few parameters to complete the integration.
Locate the section of this file that is specific to your JumpCloud (it will probably be at the bottom). Update your parameters to match those from below. Take note of the areas highlighted in red.
ldap.name=CONNECTION_NAME ldap.url=ldaps://ldap.jumpcloud.com:636 ldap.rootDn=ou=Users,o=YOUR_ORG_ID,dc=jumpcloud,dc=com ldap.baseDn=ou=Users,o=YOUR_ORG_ID,dc=jumpcloud,dc=com ldap.managerDn=uid=LDAP_BINDING_USER,ou=Users,o=YOUR_ORG_ID,dc=jumpcloud,dc=com ldap.managerPassword=LDAP_BINDING_USER_PASSWORD ldap.domain=jumpcloud.com ldap.roleBase=o=YOUR_ORG_ID,dc=jumpcloud,dc=com #ldap.authn.searchFilter=uid={0} (Uncomment this line (remove #) if you want to login using UID) #ldap.authn.searchFilter=mail={0} (Uncomment this line (remove #) if you want to login using Email Address) ldap.roleName=cn ldap.roleSearch=(member={0}) ldap.groupSearch=(&(cn={0})(objectClass=groupOfNames))
After the updates have been made, save and close the file.
Restart the PamManagement (Windows) or pammanager (Linux) service to complete the integration.
When the service comes back online (2-5 minutes), test your login using a JumpCloud account.