Support Home > Apps and Integrations > Integrate with Heap

Integrate with Heap

Automatically provision, update and deprovision users and groups in Heap from JumpCloud using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in JumpCloud for Heap. 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 Heap integration.

Prerequisites

  • A JumpCloud administrator account.
  • A Premier plan.
  • A Heap user account with administrator permissions
  • An existing Jumpcloud SAML SSO configuration. See SSO using Pre-built Connectors.

Important Considerations

  • Heap SCIM API is based on version 2.0 of the SCIM standard.
  • If a user already has a Heap account outside your organization, they will need to delete their account and have their account re-made in the correct organization.
  • Once SCIM provisioning is enabled, you will be unable to add or remove teammates in Heap and can only add or remove them via JumpCloud.
  • Heap does not currently support updating a user’s email or username once it has been set. Trying to update a user’s email will result in a new, separate account being created for the new email.
  • Groups are supported.

Attribute Considerations

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

Group Management Important Considerations

Enabling Group Management

You must select the Enable management of User Groups and Group Membership in this application option to manage groups and group membership in the application from JumpCloud.

Group Provisioning and Syncing 

  • Empty groups are not created.
  • JumpCloud takes over management of existing groups in the application when the user group name in JumpCloud matches the name of the group in the application.
  • All user groups associated with the application in JumpCloud are synced. Syncing occurs whenever there is a membership or group change event.
  • Group renaming is supported.
  • If a user group is disassociated from the application in JumpCloud, syncing immediately stops and the group is left as-is in the application. All members of that user group are deactivated in the application unless they are associated with another active application group that is managed from JumpCloud.

Group Deletion

  • Managed groups deleted in JumpCloud are deleted in the application.
  • All members of the deleted group are deactivated in the application, unless they are associated with another active application group that is managed from JumpCloud.

Disabling Group Management

  • You can disable group and group membership management by unchecking the Enable management of User Groups and Group Membership in this application option.
  • The managed groups and group membership are left as-is in the application.
  • JumpCloud stops sending group membership information for the user, but the user’s identity will continue to be managed from JumpCloud.

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 Heap

  1. Configure or ensure SSO is setup between Heap and JumpCloud. 
  2. In Heap, go to Account > Manage > Account settings.
  3. Click Enable SCIM Provisioning in the Single Sign-On section.
  4. Select the role you would like new users to be given by default. This can be edited later and individual users can be given different roles after they have been added to Heap.
  5. Copy the Bearer Token.

To configure JumpCloud

  1. Create a new application or select it from the Configured Applications list.
  2. Select the Identity Management tab.
  3. Select the Enable management of User Groups and Group Membership in this application checkbox if you want to provision, manage, and sync groups in Heap from JumpCloud.
  4. Click Configure.
  5. You’re presented with two fields:
  • *Base URL: Enter the Provisioning URL for Heap. (e.g., https://heapanalytics.com/scim/v2/[tenant])
  • Token Key: Paste the Bearer Token you generated/copied when configuring Heap.
  1. Click Activate.
  2. You will receive a confirmation that the Identity Management integration has been successfully verified.
  3. Click save.
  4. You can now connect user groups to the application in JumpCloud to provision the members of that group in Heap. 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. 

Heap Attributes

JumpCloud Property JumpCloud UI Field Name SCIM v2 Mapping Heap Value
username Username userName userName
firstname First Name name.givenName First Name
lastname Last Name name.familyName Last Name
    role Heap Role

Group Attributes

JumpCloud Property JumpCloud UI Field Name SCIM v2 Mapping Application Value
name Name displayName Organization

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 Integration

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

  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 tab.
  5. Scroll to the bottom of the configuration.
  6. Click Deactivate SSO. 
  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 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