Capabilities
Gather Breathe credentials
1
In Breathe, open Account settings.
2
Open the API key section.
3
Create an API key and copy its value. Treat it like a password.
4
Note your Breathe API URL. For Breathe accounts this is
https://api.breathehr.com.Configuration fields
Synced resource types
- Employees: people from
/v1/employees. Each employee becomes a user. - Departments: departments from
/v1/departments. Each department becomes a group with a singlememberentitlement. - Department membership: an employee is a member of the department named by
the employee’s
department_id.
Special notes
- Provisioning is not supported. The connector reads employees and departments only.
- The connector authenticates with a single API key sent in the
X-API-KEYrequest header. - An employee whose record marks them as deleted, records an employment end date in the past, or reports a non-active status is synced with a disabled status.
- An employee with no department is synced as a user but holds no department membership.
- Breathe does not list the members of a department directly, so the connector reads each employee’s department from the employee record and matches it to the department.
Configure the Breathe connector
- Cloud-hosted
- Self-hosted
Follow these instructions to use a built-in, no-code connector hosted by C1.Done. Your Breathe connector is now pulling access data into C1.
1
In C1, navigate to Apps > Connectors and click Add connector.
2
Search for Breathe and click Add.
3
Choose where to add the connector: Create a new app, or Add to an existing app (then select the app).If you’re creating a new app, choose whether to link it to an application discovered from your identity provider: select Yes and pick the IdP application, or No to continue with just the connector.
4
Set the connector’s Name and, optionally, a Description.
5
Click the pencil icon next to Owners to choose who can configure and manage this connector.
6
Click Add. The connector is created and its configuration page opens.
7
Find the Settings area of the page and click Edit.
8
Paste the Breathe credentials into the relevant fields:
- Breathe API URL:
https://api.breathehr.com. - API key: The API key you created in Breathe.
9
Click Save.
10
The connector’s label changes to Syncing, followed by
Connected. You can view the logs to ensure that information is
syncing.