Skip to content

Commit df37d92

Browse files
committed
Update HiBob user guide to clarify blueprint creation and authentication process
1 parent 5a746b5 commit df37d92

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/guides/all/map-hibob-users-to-port-accounts.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This guide assumes the following:
2727

2828
To represent HiBob users in your portal, we need to create a HiBob User blueprint that can store HiBob user data and optionally link to Port user accounts.
2929

30-
<h3> Create the HiBob User blueprint</h3>
30+
<h3>Create the HiBob User blueprint</h3>
3131

3232
1. Go to the [data model](https://app.getport.io/settings/data-model) page of your portal.
3333

@@ -132,7 +132,7 @@ To represent HiBob users in your portal, we need to create a HiBob User blueprin
132132

133133
5. Click on `Save` to create the blueprint.
134134

135-
<h3> Enhance the Port User blueprint</h3>
135+
<h3>Enhance the Port User blueprint</h3>
136136

137137
Now we need to enhance the Port User blueprint to add a relation to the HiBob User blueprint and mirror properties to display HiBob information.
138138

@@ -191,11 +191,14 @@ Now let's add your HiBob credentials to Port's secrets:
191191
3. Click on the `Secrets` tab.
192192
4. Click on `+ Secret` and add the following secrets:
193193
- `HIBOB_API_URL` - Your HiBob API base URL (e.g., https://api.hibob.com/v1)
194-
- `HIBOB_SERVICE_USER_ID` - Your HiBob service user ID
195-
- `HIBOB_SERVICE_USER_TOKEN` - Your HiBob service user token
194+
- `HIBOB_BASIC_AUTH` - Your base64 encoded credentials (base64(HIBOB_SERVICE_USER_ID:HIBOB_SERVICE_USER_TOKEN))
195+
196+
```bash
197+
echo -n "HIBOB_SERVICE_USER_ID:HIBOB_SERVICE_USER_TOKEN" | base64
198+
```
196199

197200
:::info HiBob Authentication
198-
HiBob uses service user authentication with both an ID and token. You'll need to create a service user in HiBob with appropriate permissions to access employee data. Learn more about [creating HiBob service users](https://apidocs.hibob.com/docs/api-service-users).
201+
HiBob uses Basic Authentication with base64 encoding. You'll need to create a service user in HiBob with appropriate permissions to access employee data, then encode the credentials as base64(service_user_id:service_user_token). Learn more about [creating HiBob service users](https://apidocs.hibob.com/docs/api-service-users).
199202
:::
200203

201204

0 commit comments

Comments
 (0)