探花大神

Contact Us
Help Center Home > Apps and Integrations > Integrate with Heap

Integrate with Heap

Use 探花大神 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 and groups in Heap from 探花大神 using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in 探花大神 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 探花大神 administrator account
  • 探花大神 SSO Package or higher or SSO 脿 la carte option
  • A Heap user account with administrator permissions
  • Heap Premier plan and Heap ID

Important Considerations

  • SAML SSO must be configured to use SCIM
  • Once SSO is enabled, it will be enforced as mandatory for all non-Admins in your Heap workspace
  • 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 探花大神
  • Heap does not currently support updating a user鈥檚 email or username once it has been set. Trying to update a user鈥檚 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.

Creating a new 探花大神 Application Integration

  1. Log in to the .
  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. 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 探花大神

  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 Heap 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. Go to SSO tab > Actions > Download certificate.

Tip:

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

To configure Heap

  1. In Heap, navigate to Account > Manage > Account settings.
  2. Enter the following information: 
    • Your SAML Identity Provider certificate - copy and paste the contents of the certificate downloaded in the previous section
    • Remote login URL - copy and paste the 探花大神 IDP URL
    • Logout landing URL (optional) - enter https://console.jumpcloud.com/userconsole
  3. Click Save Configuration.
  4. Test the SSO connection by navigating to Account > Manage > .

Authorizing User SSO Access

Users are implicitly denied access to applications. After you connect an application to 探花大神, you need to authorize user access to that application. You can authorize user access from the Applications, Users List or User Groups 辫补驳别.听

To authorize user access from the Application’s page

  1. Log in to the .
  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 desired group of users to which you want to give access.
  5. Click Save.听

To learn how to authorize user access from the听Users or User Groups听pages, see听Authorize Users to an SSO Application.

Validating SSO user authentication workflow(s)

IdP-initiated user workflow

  • Access the
  • Go to听Applications and click an application tile to launch it
  • 探花大神 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 探花大神 where the user enters their 探花大神 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 Heap

  1. Configure or ensure SSO is setup between Heap and 探花大神. 
  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.

Warning:

The Client ID and Secret (token) may only be shown once. Copy them to a secure location, like the 探花大神 Password Manager, for future reference.

To configure 探花大神

  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 探花大神.
  4. Click Configure.
  5. You鈥檙e 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.
  6. Click Activate.
  7. You will receive a confirmation that the Identity Management integration has been successfully verified.
  8. You can now connect user groups to the application in 探花大神 to provision the members of that group in Heap. Learn how to .

To update your token

  1. After generating a new token in your SP, log in to the听.
  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. Expand the Configuration Settings section.
  6. In the Token Key field, paste your updated token.

Note:

This may also be called API Key or Bearer Token.

  1. Click Update.

Warning:

Clicking Save will not update your token. You must click Update.

  1. You will get a message saying your Identity Management integration has been successfully verified.

Attribute Mappings

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

Learn about 探花大神 Properties and how they work with system users in our . 

Heap Attributes

探花大神 Property 探花大神 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

探花大神 Property 探花大神 UI Field Name SCIM v2 Mapping Application Value
name Name displayName Name

Group Management 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 探花大神.

Group Provisioning and Syncing 
  • Empty groups are not created
  • 探花大神 takes over management of existing groups in the application when the user group name in 探花大神 matches the name of the group in the application
  • All user groups associated with the application in 探花大神 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 探花大神, 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 探花大神
Group Deletion
  • Managed groups deleted in 探花大神 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 探花大神
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
  • 探花大神 stops sending group membership information for the user, but the user鈥檚 identity will continue to be managed from 探花大神

Importing Users

This functionality is helpful if users have already been created in the application听but have not been created in 探花大神.

Important:

Users that are suspended in the application will not be created in 探花大神.

  1. Log in to the .
  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 探花大神 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 探花大神

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, 探花大神 will send you an email when your import is complete
  1. You can now connect and grant users access to all their 探花大神 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 探花大神 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 探花大神.

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 .

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 探花大神 tries to create a new user in service provider application.
user_update_provision Logged when 探花大神 tries to update an existing user in service provider application.
user_deprovision Logged when 探花大神 tries to change an existing user to inactive in the service provider application.
user_delete_provision Logged when 探花大神 tries to delete an existing user in service provider application.
user_lookup_provision Logged when 探花大神 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 探花大神 tries to create a new group in service provider application.
group_update_provision Logged when 探花大神 tries to update an existing group in service provider application.
group_delete_provision Logged when 探花大神 tries to delete an existing group in service provider application.

Removing the Integration

Important:

These are steps for removing the integration in 探花大神. 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 探花大神 may result in users losing access to the application.

To deactivate the IdM Integration

  1. Log in to the .
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you鈥檇 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 .
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you鈥檇 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 .
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you鈥檇 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