Help Center Home > Apps and Integrations > Integrate with Kandji

Integrate with Kandji

Use JumpCloud SAML Single Sign On (SSO) to give your users convenient but secure access to all their web applications with a single set of credentials. Automatically provision, update and deprovision users in Kandji from JumpCloud using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in JumpCloud for Kandji. 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 Kandji integration.

Prerequisites

  • A JumpCloud Administrator account.
  • JumpCloud SSO Package or higher or SSO add-on feature.
  • A Kandji user account with administrator permissions.

Important Considerations

  • Kandji SCIM API is based on version 2.0 of the SCIM standard.
  • If you need to update the SCIM token, you must deactivate the IdM integration, update the token, and then reactivate the integration.
  • The following provisioning features are supported for users:
    • Create users
    • Update user attributes
    • Deactivate users
  • Groups are not supported.

Attribute Considerations

  • A default set of attributes are managed for users. See the Attribute Mappings section for more details.

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.

Note:

If this is a Bookmark Application, enter your sign-in URL in the Bookmark URL field.

  1. Optionally, expand Advanced Settings to specify a value for the SSO IdP URL. If no value is entered, it will default to https://sso.jumpcloud.com/saml2/<applicationname>.

Warning:

The SSO IdP URL is not editable after the application is created. You will have to delete and recreate the connector if you need to edit this field at a later time.

  1. Click Save Application.
  2. If successful, click:
    • Configure Application and go to the next section
    • Close to configure your new application at a later time

Configuring the SSO Integration

To configure JumpCloud

  1. Create a new application or select it from the Configured Applications list.
  2. Select the SSO tab.
  3. Replace any instances of YOUR_ID with your Kandji ID.
  4. Add or change any attributes.
  5. Click save.

Download the certificate

  1. Find your application in the Configured Applications list and click anywhere in the row to reopen its configuration window.
  2. Select the SSO tab and click IDP Certificate Valid > Download certificate.

Tip:

The certificate.pem will download to your local Downloads folder.

To configure Kandji

  1. In Kandji, navigate to Settings > Access tab.
  2. Find the Authentication section and click the Add button on the bottom left of the authentication section. (If that section does not appear, SSO is not enabled for your instance.)
  3. In the Add SSO Connection pane, select the Custom SAML option.
  4. Click Next.
  5. Give the connection a Name.
  6. Paste in the Sign In URL you copied from JumpCloud – https://sso.jumpcloud.com/saml2/kandji .
  7. Upload the certificate you downloaded from JumpCloud.
  8. Ensure that the User ID Attribute is set to the default value of: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier
  9. Ensure that Sign Request is set to Yes.
  10. Ensure that Request Algorithm is set to RSA-SHA256.
  11. Ensure that Sign Request Algorithm Digest is set to SHA 256.
  12. Set the Protocol Binding to HTTP-POST.
  13. Click Save.
  14. Click the ellipsis next to the JumpCloud connector.
  15. Click Enable.
  16. Optionally, you can enforce SSO by disabling Standard Authentication for the connector.

Authorizing User SSO Access

Users are implicitly denied access to applications. After you connect an application to JumpCloud, you need to authorize user access to that application. You can authorize user access from the Application Configuration panel or from the Groups Configuration panel. 

To authorize user access from the Application Configuration panel

  1. Log in to the JumpCloud Admin Portal.
  2. Go to USER AUTHENTICATION > SSO Applications, then select the application to which you want to authorize user access.
  3. Select the User Groups tab. If you need to create a new group of users, see Get Started: User Groups.
  4. Select the check box next to the group of users you want to give access.
  5. Click save. 

To learn how to authorize user access from the Groups Configuration panel, see Authorize Users to an SSO Application.

Validating SSO user authentication workflow(s)

IdP-initiated user workflow

  • Access the JumpCloud User Console
  • Go to Applications and click an application tile to launch it
  • JumpCloud asserts the user’s identity to the SP and is authenticated without the user having to log in to the application

SP-initiated user workflow

  • Go to the SP application login – generally, there is either a special link or an adaptive username field that detects the user is authenticated through SSO

Note:

This varies by SP.

  • Login redirects the user to JumpCloud where the user enters their JumpCloud credentials
  • After the user is logged in successfully, they are redirected back to the SP and automatically logged in

Configuring the Identity Management Integration

To configure Kandji

  1. Log into Kandji and navigate to Integrations in the left-hand navigation bar.
  2. Click Discover integrations in the upper-right of the Integrations page. 
  3. On the SCIM tile, click Add and configure.
  4. Click Get started.
  5. Enter a unique name for the SCIM integration.
  6. Click Generate token. 
  7. Click Copy token. You will need this later when configuring JumpCloud.
  8. Confirm that you have copied the token and that you know you will need to change it if you want to see the token details again.
  9. Click Done. 
  10. Back on the Integrations page, click the ellipse on the SCIM integration you just created.
  11. Select View Details.
  12. Copy the SCIM API URL (this is the Base URL in JumpCloud), e.g., https://{subdomain}.kandji.io/api/v1/scim
  13. Click Close.

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. There are two fields:
    • *Base URL: Enter the SCIM Endpoint with the IdP id you copied when configuring Kandji. (e.g., https://{subdomain}.kandji.io/api/v1/scim)
    • Token Key: Paste the token you generated when configuring Kandji.
  4. 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 Kandji. 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. 

Kandji User Attributes

JumpCloud Property JumpCloud UI Field Name SCIM v2 Mapping Kandji Value
displayName Display Name displayName displayName
username Username userName Email
active Status active active
email Company Email emails.value emails
firstname/lastname First Name/Last Name name.formatted name.formatted

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 – 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.

SCIM Directory Insights Events

The following Directory Insights (DI) events provide visibility into failures and detailed information about the user and group data being added or updated from HR or other external solutions to JumpCloud.

Note:

Customers with no package or the Device Management Package will need to add the Directory Insights à la carte option. Directory Insights is included in all other packages.

SCIM DI Integration Events

Event Name Event Description
idm_integration_activate Logged when an IT admin attempts to activated new SCIM Identity Management integration.
idm_integration_update Logged when an IT admin attempts to update a configured and activated SCIM Identity Management integration.
idm_integration_reauth Logged when an IT admin attempts to change the credentials for an activated SCIM Identity Management integration.
idm_integration_delete Logged when an IT admin attempts to deactivate an activated SCIM Identity Management integration.

SCIM DI User Events

Event Name Event Description
user_create_provision Logged when JumpCloud tries to create a new user in service provider application.
user_update_provision Logged when JumpCloud tries to update an existing user in service provider application.
user_deprovision Logged when JumpCloud tries to change an existing user to inactive in the service provider application.
user_delete_provision Logged when JumpCloud tries to delete an existing user in service provider application.
user_lookup_provision Logged when JumpCloud encounters an issue when trying to lookup a user to determine if the user needs to be created or updated.

SCIM DI Group Events

Important:

These DI events will only be present if SCIM Groups are supported.

Event Name Event Description
group_create_provision Logged when JumpCloud tries to create a new group in service provider application.
group_update_provision Logged when JumpCloud tries to update an existing group in service provider application.
group_delete_provision Logged when JumpCloud tries to delete an existing group in service provider application.

Removing the Integration

Important:

These are steps for removing the integration in JumpCloud. Consult your SP's documentation for any additional steps needed to remove the integration in the SP. Failure to remove the integration successfully for both the SP and JumpCloud may result in users losing access to the application.

To deactivate the IdM Integration

  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 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.

To deactivate the SSO Integration or Bookmark

  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 deactivate and click to open its details panel. 
  4. Select the SSO or Bookmark tab.
  5. Scroll to the bottom of the configuration.
  6. Click Deactivate SSO or Deactivate Bookmark. 
  7. Click save. 
  8. If successful, you will receive a confirmation message.

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.
  4. Check the box next to the application to select it.
  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.
Back to Top

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