- Overview
- Configuration
Breathe HR
Reduce data entry errors by connecting Breathe HR accounts with directories.
Overview
Integrating Breathe HR with Active Directory via ADManager Plus helps organizations eliminate redundant data entry, reduce onboarding delays, and maintain tighter control over user access. By syncing employee information between the HR system and Active Directory, this integration ensures that user accounts are created, updated, and deactivated automatically in response to HR-driven events. It not only improves operational efficiency but also enhances compliance and reduces the risk of human error in managing user identities.
Streamlined onboarding
Automatically create AD accounts when new employees are added in Breathe HR, complete with pre-configured access.
Accurate role updates
Reflect department or role changes in real time to ensure permissions remain aligned with job responsibilities.
Secure offboarding
Instantly disable or delete AD accounts when employees are removed from Breathe HR, preventing unauthorized access.
Configuration Document: Integrating Breathe HR with ADManager Plus
Prerequisites:
Please ensure to provide an API key with permissions to retrieve desired information and perform tasks in Breathe HR. Refer to Breathe HR's API references for more details.
Privileges:
- To import users from Breathe HR (Inbound action): Ensure the account used for authorization has permission to read all user accounts.
- To perform any action or query in Breathe HR (Outbound Action): Ensure the account used for authorization has permission to perform the desired action.
Authorization configuration
- Log in to ADManager Plus and navigate to the Automation tab.
- In the left pane, under Configuration, click Application Integrations.
- Under Enterprise Applications, click Breathe HR.
- Toggle the Enable Breathe HR Integration button on.
- In the Breathe HR Configuration page, click Authorization.
- Perform the steps to generate the API Keys and API Token in Breathe HR and enter the X-API-KEY in the value field .
- Click Configure.
Inbound webhook configuration
Inbound webhook enables you to fetch user data from Breathe HR to ADManager Plus. To configure an inbound webhook for Breathe HR:
- Under Inbound Webhook, click Breathe HR Endpoint Configuration.
- In the Endpoint Configuration tab, an endpoint, Breathe HR GET EMPLOYEES ENDPOINT, comes pre-configured with an Endpoint URL, API Method, Headers, and Parameters fields to fetch user accounts from Breathe HR. If you would like to use this pre-configured endpoint, replace {id} with the domain name of your Breathe HR instance in the Endpoint URL field. However, if you would like to use a new endpoint to import users, you can configure one using the + Add API endpoint button and filling in the required fields as per Breathe HR's API references. Click here to learn how. Note:
- The API key value pair is pre-configured as a header for authenticating API requests as configured during Authorization Configuration.
- Refer to Breathe HR's API references and configure additional headers and parameters, if required.
- Once done, click Test & Save. A response window will display all the requested parameters that can be fetched using the API call. Click Proceed. Note:
- Refer to Breathe HR's API references to know the Parameters that must be configured to fetch only specific parameters.
- You can configure multiple endpoints for Breathe HR using the + Add API endpoint button. Click here to learn how.
- Click Data Source - LDAP Attribute Mapping to match endpoints and to map AD LDAP attributes with the respective attributes in Breathe HR. [ADManager Plus also lets you customize attribute format from Breathe HR]
- Click + Add New Configuration and perform the following:
- Enter the Configuration Name and Description and select the Automation Category from the drop-down menu.
- In the Select Endpoint field, select the desired endpoint and a Primary Key that is unique to a user (e.g. employeeIdentifier). Note: When multiple endpoints are configured, this attribute must hold the same value in all the endpoints.
- In the Attribute Mapping field, select the attribute from the LDAP Attribute Name drop-down menu and map it with the respective column in Breathe HR.
- If you would like to create a new custom format for this, click Mapping Attribute.
- Click Save.
Outbound webhook configuration
Outbound webhook enables you to update the changes made in AD using ADManager Plus to Breathe HR or fetch/forward required details from Breathe HR and synchronize them with AD. To configure an outbound webhook for Breathe HR:
- Under Outbound Webhook, click Breathe HR Webhook Configuration.
- Click + Add Webhook.
- Enter a name and description for this webhook.
- Decide on the action that has to be performed and refer to Breathe HR's API references for the API details, such as the URL, headers, parameters, and other requirements that will be needed. Enter the employee details value in the parameter field.
- Select the HTTP method that will enable you to perform the desired action on the endpoint from the drop-down menu.
- Enter the endpoint URL.
- Configure the Headers, Parameters, and Message Type in the appropriate format based on the API call that you would like to perform.
- Click Test and Save.
- A pop-up window will then display a list of AD users and groups to test the configured API call. Select the desired user or group over which this API request has to be tested and click OK. This will make a real time call to the endpoint URL, and the selected objects will be modified as per the configuration.
- The webhook response and request details will then be displayed. Verify them for the expected API behavior and click Save.