BambooHR
Visualize BambooHR users and files, map BambooHR users to employees and managers, and monitor changes through queries and alerts.
- Installation guide
- BambooHR data model
Installation
For this integration, you will need to generate a REST API key before initiating the integration in JupiterOne. Once the API key has been retrieved, proceed to JupiterOne to continue.
As described in the BambooHR documentation, the API key will have the permissions of the associated user. This means the user must have sufficient permissions to create an API key, list users metadata, and list employee files (we do not read the content).
To complete the BambooHR integration in JupiterOne, navigate to the Integrations tab in JupiterOne and select BambooHR. Click New Instance to begin configuring the integration.
Creating an BambooHR instance requires the following:
The Account Name used to identify the BambooHR account in JupiterOne. Ingested entities will have this value stored in
tag.AccountName
when theAccountName
toggle is enabled.Description to assist in identifying the integration instance, if desired.
Polling Interval that you feel is sufficient for your monitoring needs. You may leave this as
DISABLED
and manually execute the integration.Client Namespace (subdomain) for your BoombooHR account.
The BambooHR API Key generated for use with JupiterOne.
Click Create once all values are provided to finalize the integration.
The users listing API includes user records of employees that have been terminated (status: 'disabled'
, active: false
in the User entity). BambooHR employee records also have an employeeNumber
that is assigned when the employee is created and which may later be modified. There is a permanent id
property that does not change and very likely is not equal to the employeeNumber
.
Next steps
Now that your integration instance has been configured, it will begin running on the polling interval you provided, populating data within JupiterOne. Continue on to our Instance management guide to learn more about working with and editing integration instances.
Data Model
Entities
The following entities are created:
Resources | Entity _type | Entity _class |
---|---|---|
Account | bamboohr_account | Account |
Employee | bamboohr_employee | Record |
File | bamboohr_file | DataObject |
User | bamboohr_user | User |
Relationships
The following relationships are created:
Source Entity _type | Relationship _class | Target Entity _type |
---|---|---|
bamboohr_account | HAS | bamboohr_employee |
bamboohr_account | HAS | bamboohr_file |
bamboohr_account | HAS | bamboohr_user |
bamboohr_user | IS | bamboohr_employee |
bamboohr_user | HAS | bamboohr_file |