ºÚÁϺ£½Ç91Èë¿Ú

Integrate with Bonusly

Use ºÚÁϺ£½Ç91Èë¿Ú 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 in Bonusly from ºÚÁϺ£½Ç91Èë¿Ú using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in ºÚÁϺ£½Ç91Èë¿Ú 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 ºÚÁϺ£½Ç91Èë¿Ú administrator account
  • ºÚÁϺ£½Ç91Èë¿Ú SSO Package or higher or SSO à la carte option
  • A Bonusly user account with administrator permissions
  • Bonusly Pro subscription and Bonusly App ID

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 ºÚÁϺ£½Ç91Èë¿Ú will not impact the user in Bonusly
  • Deletion of the user in ºÚÁϺ£½Ç91Èë¿Ú will deactivate the user in Bonusly
  • If you need to update the SCIM token, you must deactivate the IdM integration, update the token, and then reactivate the integration

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 ºÚÁϺ£½Ç91Èë¿Ú:
    • manager
    • division
    • role
    • user_mode
    • business_unit

Creating a new ºÚÁϺ£½Ç91Èë¿Ú 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.

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 ºÚÁϺ£½Ç91Èë¿Ú

  1. Create a new application or select it from the Configured Applications list.
  2. Select the SSO tab.
  3. Replace any instances of YOUR_APP_ID with your Bonusly App ID.
  4. Add or change any attributes.
  5. Click save.

Copy the metadata URL

  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 Copy Metadata URL.
  3. The URL will be copied to your clipboard.

To configure Bonusly

  1. Log in to Bonusly as an administrator.
  2. Navigate to Admin > Settings > Integration.
  3. Select SAML.
  4. Enter the following information:
    • IdP Metadata URL - paste the metadata URL copied in the previous section
    • IdP Issuer (Entity ID) - enter ºÚÁϺ£½Ç91Èë¿Ú
  5. Click save.

Authorizing User SSO Access

Users are implicitly denied access to applications. After you connect an application to ºÚÁϺ£½Ç91Èë¿Ú, 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 .
  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
  • Go to Applications and click an application tile to launch it
  • ºÚÁϺ£½Ç91Èë¿Ú 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 ºÚÁϺ£½Ç91Èë¿Ú where the user enters their ºÚÁϺ£½Ç91Èë¿Ú 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 Bonusly

  1. In Bonusly, navigate to Admin > Company > Integrations.
  2. In the If you want to code section, click on API > Create New API Access Token to create a new Secret Token. 
  3. Type a name for the access token in the provided text box, then press Create Api key.
  4. The new access token will appear for a few seconds in a pop-up.

Warning:

The Client ID and Secret (token) may only be shown once. Copy them to a secure location, like the ºÚÁϺ£½Ç91Èë¿Ú Password Manager, for future reference.

To configure ºÚÁϺ£½Ç91Èë¿Ú

  1. Create a new application or select it from the Configured Applications list.
  2. Select the Identity Management tab.
  3. Click Configure and paste the API access token generated in the previous section.
  4. °ä±ô¾±³¦°ìÌýActivate.
  5. You will receive a confirmation that the Identity Management integration has been successfully verified.

Attribute Mappings

The following table lists attributes that ºÚÁϺ£½Ç91Èë¿Ú sends to the application. See Attribute Considerations for more information regarding attribute mapping considerations. 

Learn about ºÚÁϺ£½Ç91Èë¿Ú Properties and how they work with system users in our . 

Bonusly User Attributes

ºÚÁϺ£½Ç91Èë¿Ú Property ºÚÁϺ£½Ç91Èë¿Ú UI SCIM v2 Mapping Bonusly Value
username Username userName Email
firstname First Name name.givenName First Name
lastname Last Name name.familyName Last Name
department Department department Department
email 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 ºÚÁϺ£½Ç91Èë¿Ú.

  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 ºÚÁϺ£½Ç91Èë¿Ú from the application from the list of users that appear. Users in the list have two import statuses:
    • ±·±ð·ÉÌý- user has not been imported
    • ±õ³¾±è´Ç°ù³Ù±ð»åÌý- user has been imported and has an account in ºÚÁϺ£½Ç91Èë¿Ú

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, ºÚÁϺ£½Ç91Èë¿Ú will send you an email when your import is complete
  1. You can now connect and grant users access to all their ºÚÁϺ£½Ç91Èë¿Ú 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 ºÚÁϺ£½Ç91Èë¿Ú 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 ºÚÁϺ£½Ç91Èë¿Ú.

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 ºÚÁϺ£½Ç91Èë¿Ú tries to create a new user in service provider application.
user_update_provision Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to update an existing user in service provider application.
user_deprovision Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to change an existing user to inactive in the service provider application.
user_delete_provision Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to delete an existing user in service provider application.
user_lookup_provision Logged when ºÚÁϺ£½Ç91Èë¿Ú 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 ºÚÁϺ£½Ç91Èë¿Ú tries to create a new group in service provider application.
group_update_provision Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to update an existing group in service provider application.
group_delete_provision Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to delete an existing group in service provider application.

Removing the Integration

Important:

These are steps for removing the integration in ºÚÁϺ£½Ç91Èë¿Ú. 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 ºÚÁϺ£½Ç91Èë¿Ú 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’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 .
  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 .
  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