Help Center Home > Apps and Integrations > Integrate with OneTrust

Integrate with OneTrust

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

Prerequisites

  • A JumpCloud administrator account
  • JumpCloud SSO Package or higher or SSO à la carte option
  • A OneTrust Enterprise account
  • Your OneTrust subdomain name

Important Considerations

  • SSO must be enabled to use SCIM
  • If you need to update the SCIM token, you must deactivate the IdM integration, update the token, and then reactivate the integration
  • OneTrust recommends selecting a default role that has the minimum level of permissions that you want to grant users by default
  • Groups are supported

Attribute Considerations

  • A default set of attributes are managed for users. See the Attribute Mappings section for more details
  • In OneTrust, the userName and email attributes are the same
  • For the userType attribute, expected values are either Internal or External. This attribute will determine whether users are provisioned as either internal or external users in the OneTrust application
  • The following attributes are not supported by JumpCloud:
    • manager
    • division
    • roles
    • officelocation

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_SUBDOMAIN with your OneTrust subdomain name.
  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 OneTrust

  1. Login to your OneTrust account.
  2. Navigate to Settings > Global Settings > Access Management > Single Sign-On. 
  3. Enable Single Sign-On.
  4. In the Notification Recipient field, select the user(s) and/or user group(s) to be notified when action is required regarding the SSO configuration. User(s) or user group(s) must be selected in this field in order to save changes to your SSO configuration.
  5. In the OneTrust Service Provider Details section, complete the following fields:
    • Response Binding Type - select Post
    • Sign SAML Response - enabled
  6. In the Identity Provider Configuration section, complete the following fields:
    • Name - cut and paste the JumpCloud Entity ID
    • Signon URL - cut and paste the IDP URL
    • Optionally, Signout URL - enter https://console.jumpcloud.com/userconsole/ - this will send users back to the JumpCloud User Portal when they sign out
  7. In the Upload Certificate section, click Upload to browse to and select the certificate downloaded in the previous section.
  8. Click Save and then Ok.

Verify Domain Ownership

You will also need to add your domains and verify domain ownership on the Domains tab on the Single Sign-On screen within the OneTrust application to successfully complete the SSO Configuration process. For accounts with a custom subdomain or fully qualified domain name (FQDN), domains added on the Domains tab will be automatically placed in Accepted status.

  1. Navigate to the Domains tab. The Domain Verification section appears.
  2. Click the Add Domain button. The Add Domain modal appears.
  3. In the Domain field, enter the domain to be claimed.
  4. (Optional) In the Description field, enter a description for the domain.
  5. Click the Add button. The Verification Token modal appears.
  6. In the TXT Token field, click the Copy button to copy the TXT validation token to your computer's clipboard.
  7. Click the Close button. The domain appears in the Domain Verification section in Pending status.
  8. Log in to your domain name system (DNS) provider.
  9. Add the TXT validation token into a TXT record file in your DNS provider.

Note:

If the domain is verified by you through this process, the domain will display in Verified status. If the domain is verified by OneTrust Support, the domain will display in Accepted status. Both statuses indicate verified domain ownership and no further action is needed.

  1. Return to the Domains tab in the OneTrust application.
  2. Hover over the row of the domain you want to validate, and click the Context Menu icon (...) that appears.
  3. On the Context menu, select Verify. When the domain verification is successful, the domain displays in Verified status.

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 OneTrust

  1. Click the gear icon and select Global Settings. 
  2. Select User Management > User Provisioning and copy or select the following information:
    • SCIM Base URL - click the Copy URL button to copy the SCIM Base URL to your computer's clipboard
    • Organization - select the default organizational group to which users should be assigned on creation through SCIM
    • Role - select the default role to which users should be assigned on creation through SCIM
  3. Click Save.

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 OneTrust from JumpCloud. 
  4. Click Configure.
  5. You’re presented with two fields:
    • Base URL - paste the SCIM Base URL you copied when configuring OneTrust (e.g., https://{SUBDOMAIN}.onetrust.com/api/scim/v3)
    • Token Key - paste the SCIM Token you generated per Managing OAuth 2.0 API Keys
  6. Click Activate.

Tip:

It's highly recommended to set the API Key Lifetime to 1 Year. Be sure to set up a reminder in your calendar before the token expires - you will not receive a notification when it expires and your integration will stop working.

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. 

OneTrust User Attributes

JumpCloud Property JumpCloud UI Field Name SCIM v2 Mapping OneTrust Value
username Username userName userName
email Company Email emails:value emails
active Status active active
firstname First Name name.givenName First Name
lastname Last Name name.familyName Last Name
displayName Display Name displayName displayName
department Department department Department
jobTitle Job Title title Job title
employeeType employeeType userType userType
company Company organization Organization
employeeIdentifier Employee ID externalID externalID

Group Attributes

JumpCloud Property JumpCloud 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 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

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