Integrate with Lattice

Automatically provision, update and deprovision users in Lattice from JumpCloud using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in JumpCloud for Lattice. Save time and avoid mistakes, as well as potential security risks, related to manually creating users.

Read this article to learn how to setup the Lattice integration.


Important Considerations

  • Lattice SCIM API is based on version 2.0 of the SCIM standard.
  • If you need to update your token, you must deactivate the IdM integration, update the token, and then reactivate the IdM integration.
  • Group provisioning, bulk user updates, and Group imports are not supported at this time.
  • In Lattice, a users display name is derived from their customized preferred name and will not be pulled from Jumpcloud.
  • Lattice SCIM API supports:
    • create
    • update
    • deactivate users

Attribute Considerations

  • A default set of attributes are managed for users. See the Attribute Mappings section for more details.
  • The following attributes are not supported by JumpCloud:
    • manager
    • division
    • startDate
    • birthDate
    • gender
    • Office Location
    • Tee Shirt Size

Creating a new JumpCloud Application Integration

  1. Log in to the JumpCloud Admin Portal.
  2. Go to USER AUTHENTICATION SSO Applications.
  3. Click + Add New Application.
  4. Type the name of the application in the Search field and select it.
  5. Click Next.
  6. In the Display Label, type your name for the application. Optionally, you can enter a Description, adjust the User Portal Image and choose to hide or Show in User Portal.
  7. If this is a Bookmark application, enter its URL in the Bookmark URL field.
  8. Click Save Application.
  9. If successful, click:
    • Configure Application and go to the next section.
    • Close to configure your new connector at a later time.

Configuring the Identity Management Integration

To configure Lattice

  1. In Lattice, navigate to Admin > Settings > Integrations.
  2. Click Enable SCIM.
  3. Navigate to Admin > Organization > Settings > API keys.
  4. Click Generate API Key.
  5. Copy the API Key to use in the next section.

To configure JumpCloud 

  1. Create a new application or select it from the Configured Applications list.
  2. Select the Identity Management tab.
  3. Click Configure and paste the API Key in the Token Key field.
  4. Click activate and then click save.
  5. You will receive a confirmation that the Identity Management integration has been successfully verified.
  6. You can now connect user groups to the application in JumpCloud to provision the members of that group in Lattice. Learn how to Authorize Users to an Application.

Attribute Mappings

The following table lists attributes that JumpCloud sends to the application. See Attribute Considerations for more information regarding attribute mapping considerations. 

Learn about JumpCloud Properties and how they work with system users in our API

Lattice User Attributes

JumpCloud Property JumpCloud UI Field Name SCIM v2 Mapping Lattice Value
username Username userName Email address
active Status active active
employeeIdentifier Employee ID externalId externalId
firstname First Name name.givenName First Name
lastname Last Name name.familyName Last Name
firstname/lastname First Name/Last Name name.formatted Display Name
nickName nickName nickName Nickname
jobTitle Job Title jobTitle title
email Company Email emails: value emails
phoneNumbers.value Work Phone phoneNumbers.value Phone Number
department Department department Department

Importing Users

This functionality is helpful if users have already been created in the application but have not been created in JumpCloud.

  1. Log in to the JumpCloud Admin Portal.
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application and click to open its configuration panel. 
  4. Select the Identity Management tab.
  5. Click manual import.
  6. Select the users you want to create in JumpCloud from the application from the list of users that appear. Users in the list have two import statuses:
  • New – The user has not been imported.
  • Imported – user has been imported and has an account in JumpCloud.

Tip: Try using the New Users-only filter when selecting users to import. This will move all of your new users to the top of the list, making them easier to identify and select.

  1. Click import.
  • If you are importing less than 100 users, your import results will display in real time and you can continue onboarding your users. 
  • If you have more than 100 users being imported, JumpCloud will send you an email when your import is complete.
  1. You can now connect and grant users access to all their JumpCloud resources. Learn more in the Authorize Users to an Application and Connecting Users to Resources articles.

Warning: Imported users must be members of a user group bound to an application for JumpCloud to manage their identity in, and access to, the application.

Removing the IdM Integration

To deactivate the IdM Integration

  1. Log in to the JumpCloud Admin Portal.
  3. Search for the application that you’d like to deactivate and click to open its details panel. 
  4. Under the company name and logo on the left hand panel, click the Deactivate IdM connection link.
  5. Click confirm
  6. If successful, you will receive a confirmation message.
  7. You can now delete the application.

To delete the application

  1. Log in to the JumpCloud Admin Portal.
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you’d like to delete and click to open its details panel.
  4. Check the box for the application.
  5. Click Delete.
  6. Enter the number of the applications you are deleting
  7. Click Delete Application.
  8. If successful, you will see an application deletion confirmation notification.

List IconIn this Article

Still Have Questions?

If you cannot find an answer to your question in our FAQ, you can always contact us.

Submit a Case