Create a service type user for taking API actions, without affecting headcount or the people directory.

What is an API service user?

An API service user is a user type in bob whose sole purpose is to manage APIs in bob. Multiple service users can be created with unique permissions for each.

A service user stays active regardless of the status of the person who created the service user, unlike user tokens.

Tip: Check our API documentation to find out which APIs support service users.

How to create a new service user

Creation

  1. Navigate to the Settings > Integrations area
  2. Select the Automation category on the left hand side
  3. Click on the Service Users tile

4. Enter a unique Name and a Display Name in the dialog box that opens

5. Click Save

6. The new service user’s ID and token are now displayed - make sure to

keep the token in a safe place, you will not be able to access it again

7. Click Done

8. Define the service user permissions by going to Settings > Roles & Permissions.

By default each new service user is assigned to the ‘All Employees’ permission

group, you can change the permission group or create a dedicated permission

group for service users and set which permissions you would like service users to have. Learn more about permission groups and how to configure them here.

Using service users in bob

A service user must be used with basic access authentication.

The request should contain a header field in the form of Authorization: Basic <credentials>, where credentials is the Base64 encoding of ID and token joined by a single colon :

Authorization: Basic Base64.encode(SERVICE-202:Qe8q89RwbzeS7mmhMcAsN1crM73m6MdbjewGCCUY)

Tip: To remove a service user, click the three dot menu to the right of the service user you’d like to remove and press Delete.

Tip: You can refresh a user’s token - just click the three dot menu to the right of the service user and press Refresh Token. Note that the previous token will be revoked.

Need more help? If you're unsure about anything please send us a message through the chat icon below.

Did this answer your question?