Automatically provision, update and deprovision users in TerraTrue from JumpCloud using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in JumpCloud for TerraTrue. 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 TerraTrue integration.
Prerequisites
- A JumpCloud Administrator account
- An updated TerraTrue Enterprise account.
- A TerraTrue user account with administrator permissions.
- Requires SAML 2.0 SSO to use SCIM. See Connecting Applications with JumpCloud using Pre-built Connectors to set up SSO.
Important Considerations
- TerraTrue 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.
- 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
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO Applications.
- Click + Add New Application.
- Type the name of the application in the Search field and select it.
- Click Next.
- 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.
- If this is a Bookmark application, enter its URL in the Bookmark URL field.
- Click Save Application.
- 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
- Configure or ensure SSO is setup between TerraTrue and JumpCloud.
- In TerraTrue, navigate to Organization Settings > Authentication > SCIM or visit https://launch.terratrue.com/settings/auth/scim.
- Enable the SCIM Configuration toggle and click Copy API Key to copy the SCIM API Key.
- Create a new application or select it from the Configured Applications list.
- Select the Identity Management tab.
- Click Configure and paste the API Key in the Token Key field.
- Click activate and then click save.
- You will receive a confirmation that the Identity Management integration has been successfully verified.
After you've successfully integrated TerraTrue with JumpCloud, TerraTrue appears in the Applications list. You can now connect users to the application in JumpCloud to provision them in TerraTrue.
Note: If you need to update the API Token at a later time, you will need to deactivate the integration before you can change the base URL and new API key. After you make the changes, you can re-activate the integration.
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.
Bitwarden User Attributes
JumpCloud Property | JumpCloud UI Field Name | SCIM v2 Mapping | Bitwarden Value |
---|---|---|---|
username | Username | userName | userName |
Company Email | emails: value | emails | |
active | Status | active | active |
displayName | Display Name | displayName | displayName |
employeeIdentifier | Employee ID | externalId |
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.
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application and click to open its configuration panel.
- Select the Identity Management tab.
- Click manual import.
- 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.
- 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.
- 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
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to deactivate and click to open its details panel.
- Under the company name and logo on the left hand panel, click the Deactivate IdM connection link.
- Click confirm.
- If successful, you will receive a confirmation message.
To deactivate the SSO Integration
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to deactivate and click to open its details panel.
- Select the SSO tab.
- Scroll to the bottom of the configuration.
- Click Deactivate SSO.
- Click save.
- If successful, you will receive a confirmation message.
To delete the application
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to delete and click to open its details panel.
- Check the box for the application.
- Click Delete.
- Enter the number of the applications you are deleting
- Click Delete Application.
- If successful, you will see an application deletion confirmation notification.