• Overview
  • Configuration

Related-apps

Sage HR

Enhance HR efficiency with Sage HR and ADManager Plus integration

Identity provisioning AD & HR sync

Sage HR is a cloud-based human resources management system designed to simplify and streamline HR processes for businesses of all sizes. Integrating ADManager Plus with Sage HR enables efficient employee onboarding by automating the creation of user accounts in Active Directory based on data from Sage HR. The user-friendly interface and customizable workflows of ADManager Plus seamlessly integrate with the intuitive nature of Sage HR, providing a cohesive experience for HR professionals and administrators.

 

Centralized management

ADManager Plus allows organizations to centralize employee information by synchronizing data between Sage HR and Active Directory. This ensures consistency and accuracy of employee records across both platforms.

 

Advanced reports

ADManager Plus complements Sage HR's reporting and analytics capabilities by leveraging employee data stored in Active Directory. HR professionals can generate insightful reports and make data-driven decisions.

 

How to integrate Sage HR with ADManager Plus

Prerequisites

Provide an API key with permissions to retrieve the desired information and perform tasks in Sage HR. Refer to Sage HR's API references for more details.

Privileges

  • To import users from Sage HR (inbound action): Ensure the account used for authorization has permission to read all user accounts.
  • To perform any action or query in Sage HR (outbound action): Ensure the account used for authorization has permission to perform the desired action.
Note: ADManager Plus comes with a preconfigured set of APIs that helps perform basic actions with the integration. If the action you require is not available, please gather the necessary API details from Sage HR's API references to set up inbound or outbound webhooks to perform the required actions.

Authorization configuration

  • Log in to ADManager Plus and navigate to Directory/Application Settings.
  • Go to Application Integrations, then search for and select Sage HR.
  • Toggle the Enable Sage HR Integration button on.
  • In the Sage HR Configuration page, click Authorization.
  • Generate the API key and API token in Sage HR, and paste the generated value in the Value field for the X-Auth-Token.
  • Click Configure.

Inbound webhook configuration

An inbound webhook enables you to fetch user data from Sage HR and send it to ADManager Plus. To configure an inbound webhook for Sage HR:

  • Under Inbound Webhook, click Sage HR Endpoint Configuration.
  • An endpoint, Sage HR USERS ENDPOINT, comes preconfigured with Endpoint URL, HTTP Method, Headers, and Parameters fields to fetch user accounts from Sage HR. If you prefer to use a new endpoint to import users, you can configure one by clicking + Add API Endpoint and filling in the required fields according to Sage HR's API references. To learn how, see this help document. Note:
    • The API key-value pair is preconfigured as a header for authenticating API requests as configured during authorization configuration.
    • Refer to Sage HR's API references and configure additional headers and parameters, if needed.
    • Macros can be added to the endpoint URL, headers, parameters, and message body to dynamically modify the configuration using the macro chooser.
  • Once done, click Test & Save to validate and save the endpoint, or click Save as Draft to store the configuration as a draft without testing the endpoint. If you choose Test & Save, a response window will be displayed with the following tabs:
    • Response: Displays API response parameters in a tree structure. You can set the datatype for each field:
      • Text (default)
      • Number
      • Timestamp
      • Array
      Note: Text, Number, and Timestamp fields are used for advanced filter criteria. Array is used to select a specific value from a response array (refer to JSON conditional parsing).
    • Response Details: Displays the complete response message in text format.
    • Request: Displays the request headers, parameters, and message body.
  • Click Save. Note: You can configure multiple endpoints for Sage HR using the + Add API Endpoint button. To learn how, see this help document.
  • Click Data Source - LDAP Attribute Mapping to match endpoints and to map AD LDAP attributes with the respective attributes in Sage HR. ADManager Plus also lets you customize the attribute format from Sage 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 to the corresponding column in Sage HR. Macros are also supported in attribute mapping. To create a new custom format, click Add New Format.
    • Click Save.
Note: The attribute mapping configured in this section can be selected as the data source during automation configuration to perform the desired action on the list of users received from the API response.

Outbound webhook configuration

An outbound webhook enables you to update the changes made in AD using ADManager Plus in Sage HR or fetch or forward required details from Sage HR and synchronize them with AD. To configure an outbound webhook for Sage HR:

  • Under Outbound Webhook, click Sage HR Webhook Configuration.
  • Click + Add Webhook.
  • Enter a name and description for this webhook.
  • Decide on the action that will be performed and refer to Sage HR's API references for the API details, such as the URL, headers, parameters, and other requirements. 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. Note: Macros can be added to the endpoint URL, headers, parameters, and message body to dynamically modify the configuration using the macro chooser.
  • Click Test & Save to validate and save the webhook, or click Save as Draft to store the webhook as a draft without testing.
  • If you select Test & Save, a response window is displayed. Choose the user or group on which the API request should be tested and click OK. This triggers a real-time call to the endpoint URL, allowing you to verify whether the macros are applied correctly. You may skip selecting a user or group. However, if you do make a selection, the macros present in the webhook will be parsed using the selected object’s values:
    • Response: Displays API response parameters in a tree structure. You can set the datatype for each field:
      • Text (default)
      • Number
      • Timestamp
      Note: Text, Number, and Timestamp fields are used for advanced filter criteria.
    • Response Details: Displays the complete response message in text format.
    • Request: Displays the request headers, parameters, and message body.
  • Verify them for the expected API behavior and click Save.
Note: The webhooks configured in this section can be used in workflows, orchestration templates, event-driven automations, and scheduled automations. They can also be applied directly to desired users to perform a sequence of actions on them (under Management > Advanced Management > Orchestration).

Actions supported

Upon integration of ADManager Plus with Sage HR, the following actions can be executed:

  • Create user accounts
  • Add users to groups
  • Modify user attributes
  • Remove users from groups
  • Modify user accounts by Template
  • Create mailbox
  • Reset passwords
  • Disable or delete mailbox
  • Unlock user accounts
  • Move Home Folder
  • Enable user accounts
  • Delete Home Folder
  • Disable user accounts
  • Revoke Microsoft 365 licenses
  • Delete user accounts
  • Manage users' photos
  • Run custom scripts
  • Disable Lync accounts
  • Move users across groups
  • Auto-reply settings