HaloITSM

See more

How to integrate HaloITSM with ADManager Plus

Prerequisites

HaloITSM uses OAuth 2.0 to authorize API requests. Please provide the client ID and client secret with permissions to retrieve desired information and perform tasks in HaloITSM. Refer to HaloITSM's 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 HaloITSM (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 help perform basic actions with the integration. If the action you require is not available, please gather the necessary API details from HaloITSM's API documentation to configure the 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 HaloITSM.
• Toggle the Enable HaloITSM Integration button on.
• On the HaloITSM Configuration page, click Authorization.
• The Access Token URL is preconfigured and is used to exchange the authorization code for an access token from the OAuth server. Update the URL by replacing {tenantname} with your tenant name.
• Perform steps to generate a client ID and client secret from HaloITSM, and paste them in the respective Value fields.
• Click Configure.

Inbound webhook configuration

Inbound webhooks enable you to fetch user data from HaloITSM and send it to ADManager Plus. To configure an inbound webhook for HaloITSM:

• Under Inbound Webhook, click HaloITSM Endpoint Configuration.
• Two endpoint configurations—HALO_ITSM USERS ENDPOINT and HALO_ITSM List Tickets ENDPOINT—are available to fetch user information and retrieve ticket details from HaloITSM. These endpoints include the required Endpoint URL, HTTP Method, Headers, and Parameters to send user account data from ADManager Plus to HaloITSM. To use the preconfigured endpoint, replace {Host-Name} with the hostname of your HaloITSM server in the Endpoint URL field.
• 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 HaloITSM's API references. Click here to learn how. Note:
  • The Authorization Header is preconfigured for authenticating API requests as formatted during authorization configuration.
  • Refer to HaloITSM's API references and configure additional headers and parameters, if required.
  • 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. This response window includes 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

    Text, Number, and Timestamp 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 HaloITSM 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 HaloITSM. ADManager Plus also lets you customize attribute format from HaloITSM.
• 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 HaloITSM. 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

Outbound webhooks enable you to update the changes made in AD using ADManager Plus to HaloITSM or fetch or forward required details from HaloITSM and synchronize them with AD. To configure an outbound webhook for HaloITSM:

• Under Outbound Webhook, click HaloITSM Webhook Configuration.
• Three endpoint configurations—HALO_ITSM Add Ticket Endpoint, HALO_ITSM Update Ticket Endpoint, and HALO_ITSM Delete Ticket Endpoint—are available to create, update, and delete tickets in HaloITSM. To use the preconfigured endpoint, replace {Host-Name} with the hostname of your HaloITSM server and {id} with the domain name of your HaloITSM instance in the Endpoint URL field.
• Alternatively, if you prefer to create a new endpoint, click + Add Webhook.
• Enter a name and description for this webhook.
• Decide on the action that has to be performed and refer to HaloITSM'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. 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 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

    Text, Number, and Timestamp 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).