User Management with Okta

Our Okta integration can be used both for single sign on and user management purposes!

Adrianne Hipsher avatar
Written by Adrianne Hipsher
Updated over a week ago

What is a user management integration?

A user management integration will keep your Bonusly user-list in sync. This is a great way to reduce the administrative overhead of your employee recognition program. As you add, edit or remove employees internally, your Okta integration will make the corresponding changes in Bonusly. πŸŽ‰This Okta integration is separate from the Single Sign-On integration, which you can learn more about here.Β 

How does the user management integration with Okta work?

IMPORTANT❗️ If you aren't familiar with Okta and user provisioning, we suggest connecting with your representative at Okta. Bonusly cannot support troubleshooting for Okta and can only support the integration connection.

The Okta user management integration is done via API. You can view our API documentation here.Β 

Here is a list of the actionable items you can accomplish with this integration:Β 

  • Creating users

  • Activate deactivated users

  • Update user information

The attributes you can send to the API when creating or updating a user are names defined by SCIM. We map those attributes to the corresponding fields on our User model.

Below is a list of SCIM Β attributes accepted by our API, followed by the field on User that they map to:

  • userName Β => emailΒ 

  • name.givenName β†’ first_name

  • name.familyName β†’ last_name

  • urn:scim:schemas:extension:enterprise:1.0.department β†’ custom_properties.department

  • urn:scim:schemas:extension:bonusly:1.0:User.location β†’ custom_properties.location

  • urn:scim:schemas:extension:bonusly:1.0:User.employee_id β†’ custom_properties.employee_id

  • urn:scim:schemas:extension:bonusly:1.0:User.role β†’ custom_properties.role

  • urn:scim:schemas:extension:bonusly:1.0:User.job_title β†’ custom_properties.job_title

  • urn:scim:schemas:extension:bonusly:1.0:User.division β†’ custom_properties.division

  • urn:scim:schemas:extension:bonusly:1.0:User.business_unit β†’ custom_properties.business_unit

  • urn:scim:schemas:extension:bonusly:1.0:User.user_mode β†’ user_mode

  • urn:scim:schemas:extension:bonusly:1.0:User.manager_email β†’ manager association

    Note the SCIM attributes above are case sensitive.

What does the integration process look like?Β 

1. Create an API access token:Β 

To integrate Bonusly and Okta you must have an API access token* for an active Bonusly account. You can learn more about creating an API access token here.Β 

*If you decide to create a read-only token your integration will not be able to create, update, activate, or deactivate users in Bonusly.

2. Add the API access token in Okta:

In the β€œGeneral” tab of the Bonusly app page, click on β€œIntegration” and enter your Bonusly API access token. Select "Save".

3. Edit Integration set up:Β 

Next, click on β€œTo App” and check the checkboxes for β€œCreate Users”, β€œUpdate Users”, and β€œDeactivate Users” to enable those actions. Select "Save".Β 

4. Set up the integration in Bonusly

Finally, in the β€œSign On” tab click on β€œApplication username format” and select β€œEmail” from the dropdown. Select "Save".

That's it! πŸ‘ Okta will now provide automated user management for your users in Bonusly. Hooray! πŸŽ‰

Did this answer your question?