Automatically provision, update and deprovision users in Bonusly from JumpCloud using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in JumpCloud for Bonusly. 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 Bonusly integration.
Prerequisites
- A Bonusly administrator account.
- A JumpCloud administrator account.
Important Considerations
- Bonusly requires content-type as application/json in headers for all API requests.
- The initial sync takes longer to perform than subsequent syncs, which occur approximately every 40 minutes as long as the provisioning service is running.
- Deprovisioning a user in JumpCloud will not impact the user in Bonusly.
- Deletion of the user in JumpCloud will deactivate the user in Bonusly.
Attribute Considerations
- A default set of attributes are managed for users. See the Attribute Mappings section for more details.
- The following attributes are not supported by JumpCloud:
- manager
- division
- role
- user_mode
- business_unit
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
To obtain the Bonusly Secret Token
- In Bonusly, navigate to Admin > Company > Integrations.
- In the If you want to code section, click on API > Create New API Access Token to create a new Secret Token.
- Type a name for the access token in the provided text box, then press Create Api key.
- The new access token will appear for a few seconds in a pop-up.
Warning: The secret (token) may only be shown once. Copy it to a secure location, like the JumpCloud Password Manager, for future reference.
To configure JumpCloud
- Create a new application or select it from the Configured Applications list.
- Select the Identity Management tab.
- Click Configure and paste the API access token generated in the previous section.
- Click Activate and if successful, click save.
- You will receive a confirmation that the Identity Management integration has been successfully verified.
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.
Bonusly User Attributes
JumpCloud Property | JumpCloud UI | SCIM v2 Mapping | Bonusly Value |
---|---|---|---|
username | Username | userName | |
firstname | First Name | name.givenName | First Name |
lastname | Last Name | name.familyName | Last Name |
department | Department | department | Department |
Company Email | emails: value | Emails | |
active | Status | active | active |
addresses.country | Work Country | addresses.country | addresses.country |
location | Location | location | location |
jobTitle | Job Title | title | Job title |
employeeIdentifier | Employee ID | externalId | externalId |
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 IdM Integration
To deactivate the IdM Integration
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO.
- 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.
- You can now delete the application.
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.