Search

HiBob | Token and User ID Authentication

In this article, we help you locate your HiBob Token and User ID so you can finish integrating HiBob with Oyster. HiBob requires you to create an API Service User in order to configure your HiBob integration, this is needed so you do not have to use your personal HiBob account to connect and will allow you a granular control of what data you want to make available specifically for Oyster's integration.

Prerequisites

  • You have completed Steps 1-6 of Connecting HiBob to Oyster
    • You selected to authenticate via HiBob Token and User ID
  • You have Admin access to your company’s HiBob account.
  • You are logged in to HiBob with your admin credentials.

Create the Service User ID and Token

  1. Click the icon on the top left corner.
  2. Select System Settings.
  3. Click Integrations under Flows.
Step 1.png
  1. Click Manage Service users under the Automation section.
Step 4.png
  1. Click Create service user.
  2. Type a Display name.
  3. Click Create. The Service User ID and Token will be displayed.

  4. Copy the ID and Token. You will need them in the next steps.

    ‼️ If you misplace this information you'll have to repeat the above process.

  5. Click Go to permission groups. Skip to step 4 under Create a Permission Group. 
Step 6.png

Create a Permission Group

A Permission Group enables you to specify which service users (and Oyster) have access to HiBob. 

  1. Click the icon on the top left corner.
  2. Select Account.
  3. Select Permission groups.
  4. Click Create permission group.
  5. Select Service user.
Permission group - Step 1.png
  1. Enter a Group name and under Members select service users.
  2. You can add tags or a description (optional). 
  3. Click Create.
  4. Click Confirm.
Permission group - Step 6.png
  1. A new screen will load (Permission groups). Refer to the steps below on how to configure permissions for permission groups.
Permission group - Step 8.png

Configure Permissions for the permissions group

These permissions enables you to specify which data in HiBob the service users (and Oyster) have access to. 

  1. Click People's data. 
  2. Click Select people by condition.
  3. Click Edit.
Permission group - Step 2.png
  1. Edit the condition by selecting the following from the dropdown: Hired, Employed, and Terminated. 
  2. Click Apply.
  3. Click Apply again.
Permission group - Step 4.png
  1. Select the following permissions:

Time Off

  • Balance
    • See selected people's time off and sick leave balances
  • Requests
    • Create, edit, and cancel people's requests that haven't been approved yet
    • Edit and cancel people's future requests that have been approved
    • Edit and cancel people's past requests that have been approved
    • View, approve, or decline requests that are pending approval of others
  • See who's out today
    • See who's out today
    • See who's out because of a private policy

People

  • Address
    • View selected employees' Address sections
    • View selected employees' Address section histories
  • Basic info
    • View selected employees' Basic info sections
  • EEO
    • View selected employees' EEO sections
  • Email
    • Edit selected employees' email addresses
  • Employment
    • View selected employees' Employment section histories
    • View selected employees' Employment sections
  • History
    • View selected employees' profile changes history
  • Home
    • View selected employees' Home sections
  • Identification
    • Edit selected employees' Identification sections (only applicable if you want fully visible SSN numbers.)
    • View selected employees' Identification sections
  • Lifecycle
    • Edit selected employees' Lifecycle sections
    • View selected employees' Lifecycle section histories
    • View selected employees' Lifecycle sections (This is needed to surface Employment Status)
  • Payroll
    • View selected employees' Payroll sections
    • View selected employees' Payroll section histories
  • Personal
    • Edit selected employee's Personal sections (This is needed to surface Date of Birth)
    • View selected employees' Personal sections
  • Personal Contact Details
    • View selected employees' Personal contact details sections
    • Edit selected employees' Personal contact details sections
  • Work
    • View selected employees' Work section histories
  • Work contact details
    • View selected employees' Work contact details section

For time off integration, you must also configure the following items to access company's time off policy types:

  1. click Features > Time Off > Settings
  2. select See company's time off settings
features tab.png
time off option within the features tab.png
settings within the time off features configuration.png
  1. Click Save and Apply the changes.
  1. Return to the HiBob integration in your Oyster account.
  2. Add the User ID and Token you created and saved.
  3. Click Submit.

HiBob is now integrated with Oyster and appears on the My integrations tab.

 hibob-user-id_submit.png

 

Ready to Learn More?

📚 Learn more about:

Was this article helpful?

0 out of 0 found this helpful