Upon integrating HaloITSM with ADManager Plus, you can:

Integration

Follow these steps to integrate ADManager Plus and HaloITSM:

1. Open ADManager Plus and go to the Automation tab and click HCM Integrations from the left-side panel.

2. Under HCM Applications, click Custom HCM to add a new HCM integration.

3. In the Custom HCM Integration page, add the Name and Description of the integration. You can also add a custom logo for the HaloITSM tile.

4. Click Save.

5. Now, the HaloITSM tile will appear under HCM Applications. Click the tile to configure API authorization methods, endpoints, and LDAP data mapping.

6. Under the Authorization section, select OAuth2.0 from the Authorization Type drop-down menu. Refer to HaloITSM's authorization document here.

7. Enter the following details:
   

1. Header Prefix: Specify a prefix value for your authorization header.
   

2. OAuth 2.0 Grant Type: The authorization code is the default grant type.
   

3. Callback URL: The Callback URL is where you will be redirected to after authentication. This should be registered with the API provider.
   

4. Auth URL: Specify the Authorization Endpoint URL. (https://aus-trial.haloitsm.com/authorize?tenant=<tenantname>)
   

5. ​Access Token URL: Enter the OAuth server URL where the application can exchange the authorization code for an access token. (https://aus-trial.haloitsm.com/token?tenant=<tenantname>)
   

5. Client ID and Client Secret: Enter a valid ID and its secret key.
   

6. Scope: Specify the permissions you want for the required action.
   

7. Click Advanced Options and choose the headers and query parameters from the Add To drop-down menu.
   

8. In the API Endpoint Configuration section, add the following:
   

1. Endpoint URL: Enter the Endpoint URL. (https://<host>/api/Users)
   

            Note: Click here to view HaloITSM's API references.

2. Click Advanced Options to add headers and parameters.

3. Method: Choose between the HTTP request methods Get and Post.

4. Headers: Click and configure the respective HTTP headers.

5. Parameters: Cick and configure the query parameters.

6. Message type: Select None.

7. You can also check the Repeat calling this Endpoint option to repeatedly call the API until you get the required response, if needed. From the drop-down menu, select the parameter and specify the increment value. You can also set a condition, which when satisfied, calls the endpoint repeatedly. This step is required only when the complete user list retrieval needs repeated calls.
   

9. Once done, click Test & Save. A response window will display all the requested elements.

10. Click Data Source - LDAP Attribute Mapping to match endpoints and to map AD LDAP attributes with the respective attributes in the HCM solution.

11. Enter the Configuration Name and Description, and select the Automation Category from the drop-down menu.

12. In the Select Endpoint field, choose those columns that are unique to users (employeeIdenifier, username, etc.). The values in these columns should be consistent across all the endpoints.

13. In the Attribute Mapping field, select the attribute from the LDAP Attribute Name drop-down menu and map it with the respective column in the HCM solution.

14. Click Save.

Steps to generate the client ID and the client secret in HaloITSM

1. From the home page of HaloITSM application, navigate to the menu bar in the left-hand corner and choose Configuration.

2. Then, go to Integrations → HaloITSM API and choose View Applications → New.

3. In the Details page, select the required Authentication Method (e.g., Authorization code). You can now find the Client ID, Client Secret, Redirect URI, and other information required for authentication.
   

4. In the Permissions page, select the required permissions. These permissions define what features this application can access. They must be specified in the scope parameter of any authentication request.

Required credentials:

• OAuth URL:    https://aus-trial.haloitsm.com/authorize?tenant=<tenantname>

• Access Token URL:  https://aus-trial.haloitsm.com/token?tenant=<tenantname>

• "response_type" - Must be "authorization_code"

• "client_id" - Must be your applications client id

• "redirect_uri" - Must be your applications redirect URI

• "scope" - Must include any application permissions that are required by your application; if unsure, set to "all”

1. Navigate to Postman (postman.com).

2. Fill in all the required parameters and click Get New Access Token.

3. In the HaloITSM login page that appears, enter your login credentials and authenticate yourself.

4. Once the authentication is completed, the server should respond with Status code 200 if the credentials are valid. This response will contain the Access Token and Expiry Time as well as a Refresh Token if the offline_access is specified.

5. Once you get the Access Token, you can use it in the API request. Here is an example of API integration to retrieve all the users:

1. Method:   GET

2. API:   https://<host>/api/Users

Sample response

{

    "record_count": 1,

    "users": [

         {

            "id": 26,

            "name": "Baskar Balaji",

            "site_id": 18.0,

            "site_name": "Main",

            "client_name": "DemoDoftware",

            "firstname": "Baskar",

            "surname": "Balaji",

            "initials": "BB",

            "emailaddress": "baskar.elumalai@zohocorp.com",

            "phonenumber_preferred": "9092409380",

            "sitephonenumber": "",

            "phonenumber": "9092409380",

            "telpref": 0,

            "activedirectory_dn": "",

            "onpremise_activedirectory_dn": "",

            "login": "",

            "inactive": false,

            "colour": "#2bd3c6",

            "isimportantcontact": false,

            "neversendemails": false,

            "priority_id": 0,

            "linked_agent_id": 3,

            "isserviceaccount": false,

            "isimportantcontact2": false,

            "connectwiseid": 0,

            "autotaskid": -1,

            "use": "user",

            "client_id": 12

        }

         ]

}