- Overview
- Configuration
OrangeHRM
Sync OrangeHRM employee records to reduce onboarding delays and errors.
Overview
OrangeHRM is an open-source human resource management system that offers modular capabilities for core HR operations, including personnel data, leave and attendance tracking, recruitment, and performance management. It is commonly used by mid-sized organizations to centralize employee information and streamline HR workflows. Integrating OrangeHRM with ADManager Plus allows HR-driven user data to automatically flow into Active Directory, enabling timely and policy-compliant identity lifecycle operations.
Import employee records
Fetch user data from OrangeHRM to create or update accounts in AD, ensuring HR changes are reflected in IT systems.
Map HR fields to AD attributes
Align fields such as name, department, job title, and status from OrangeHRM to corresponding AD attributes to maintain data consistency.
Support automated offboarding
Use termination or status changes in OrangeHRM to trigger user deactivation or access revocation in AD, reducing risk and manual effort.
How to integrate OrangeHRM with ADManager Plus
Prerequisites:
OrangeHRM uses OAuth 2.0 to authorize API requests. Please ensure to provide the client_id and client_secret with permissions to retrieve desired information and perform tasks in OrangeHRM. Refer to the OrangeHRM API references page for more details.
Privileges:
- To import users (inbound action): Ensure the account used for authorization has permission to read all user accounts.
- To perform any action or query in OrangeHRM (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 Directory/Application Settings.
- Go to Application Integrations, then search and select OrangeHRM.
- Toggle the Enable OrangeHRM Integration button on.
- In the OrangeHRM Configuration page, click Authorization.
- Perform steps to generate client_id and client_secret from OrangeHRM, and paste them in the respective value fields.
- Enter Client Credentials as Grant Type
- In the Auth Token URL field replace {system url} with that of your instance.
- Click Configure.
Inbound webhook configuration
The inbound webhook enables you to get user data from OrangeHRM to ADManager Plus and perform desired action available in Automation feature on them. To configure an inbound webhook for OrangeHRM:
- Under Inbound Webhook, click OrangeHRM Endpoint Configuration.
- In the Endpoint Configuration tab, an endpoint,
OrangeHRM USERS ENDPOINT, comes preconfigured with an Endpoint
URL, API Method, Headers,
and Parameters fields to fetch user accounts from
OrangeHRM. If you would like to use this preconfigured endpoint, replace
{system url} value with URL of your OrangeHRM 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
per OrangeHRM's API references. Click
here to learn how. Note:
- The API key value pair is preconfigured as a header for authenticating API requests as configured during Authorization Configuration.
- Macros: You can add macros to your endpoint configuration to dynamically change it as per your requirement using the macro chooser component
- Refer to OrangeHRM'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 OrangeHRM's API references to know the Parameters that must be configured to fetch specific parameters.
- You can configure multiple endpoints for OrangeHRM 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 OrangeHRM.
- 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 OrangeHRM.
- 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 OrangeHRM or forward required details from OrangeHRM and synchronize them with AD.
- To configure an outbound webhook for OrangeHRM:
- Under Outbound Webhook, click OrangeHRM 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 OrangeHRM's API references for the API details, such as the URL, headers, parameters, and other requirements that will be needed.
- 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 for 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 object 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.