HiBob Authorization Guide: Setting up and Adding credentials in BrynQ
Introduction
In this guide we cover how to set up the your Hibob credentials in BrynQ for an interface.
Please make sure to study the Hibob documentation concerning permissions, it shows how Hibob permission settings work in detail.
It is strongly recommended, in general, to be familiar with the core concepts of the underlying systems.
In this guide we focus on what permissions are needed for an interface in BrynQ and how to enter the the credentials in BrynQ, rather than showing how all the settings work in hibob itself.
Good to know
A wrong setup of premissions leads to missing data in the interface, as BrynQ does not have the rights to (fully) extract the data.
In Hibob, refreshing the sandbox environment leads to loss of service users and
permission groups, meaning authorisation needs to be set up again.
The process of setting up permissions is generally the same for both the hibob sandbox and live environments, however, make sure to annotate the 'test' status correctly in BrynQ.
Guide
Step 1: Create a service user in Hibob and enter it in BrynQ.
1. Log into Hibob (url may differ for the sandbox).
2. Go to 'System Settings'
3. Under 'Intergrations', Find 'Service users' and click 'Manage'.
4. Create
new service user, it is recommended to give it a clear name like “BrynQ Hibob Interface”.
5. After pressing create, A dialog will
appear with the credentials: an ID and a Token.
Copy
the credentials into the corresponding fields of the Hibob authorization dialog
on BrynQ. (Name of your connection is arbitrary
).
).
In BrynQ toggle the 'Test Environment' radio button if you are using Hibobs' sandbox.
If you got stuck in hibob, please consult.
Step 2: Set up the permissions group in Hibob to give BrynQ access to the right data
It is crucial to have the right permissions in Hibob set, before development, testing and deployment can start. If data is missing, always check the permissions in Hibob.
Your specific interface may require other permissions to be allowed, but this guide concerns a general setup suitable for most interfaces.
1A. Still have the service user dialog open? - Click the “Go to permission groups” button in
the service user dialog.
Then "Create a new Permission Group" for the Service User we have just created.
1B. Did you close the service user dialog? - Go to "System
settings" > "Account" > "Permission groups".
Create a new Permission Group for Service User we have just created.
3. Give the group a clear name, like “BrynQ HiBob Integration"
4. Under members, find the Service User you just created.
Check the corresponding box, click apply.
On the dialog, click Create and Confirm
5. The newly created permission group will open and you will see permissions you can
assign.
Getting the following section of the guide right is crucial.
6. In the Features tab, Grant all permissions for the three sections: ‘Advanced Analytics’, ‘Docs’ and ‘Time Off’.
Do this by checking every box under these three sections, except the ones marked as “Admin only”.
You can identify admin-only permissions by hovering over the checkbox,
which will display a note indicating that the permission is restricted.
7. Go to the 'People’s data' tab.
8. Select Docs, assign all Shared Docs rights
9. Under People, assign all View rights.
For reading the birth date from the personal data, edit rights are necessary
for Personal.
11. Click Save. A pop-up will apear.
12. Click Apply in the pop-up.
Troubleshooting
1. BrynQ reports data fields are missing or returning unexpected values when calling the HiBob API
Ensure the connection points to the intended sandbox or production system.
Check that the correct service user credentials have been entered in BrynQ.
Ensure the service user is assigned to the correct permission group in HiBob.
Confirm the permission group includes all permissions described above in HiBob. Adapt as needed if more permissions are required for your interface.
In some cases, certain fields only appear when the service user has edit rights instead of view rights.
2. Fields return 'null' values, despite data being shown in HiBob
- Verify data has been entered for the field
Confirm the field is actually populated in HiBob. - Verify that the field has not been renamed
A renamed field may no longer match what BrynQ is looking for. - Verify that the 'standard' field has not been replaced by a custom field
If this is the case:
- Preferred solution: Move the data from the custom field to the standard field in HiBob.
- Alternative (if unavoidable): Remove the standard field from the BrynQ template and replace it with the corresponding custom field.