All Collections
Halo ITSM integration instructions
Halo ITSM integration instructions
Lifecycle Manager syncs your hardware assets from Halo ITSM via API
Randy White avatar
Written by Randy White
Updated over a week ago

This article provides instructions on how to integrate Halo ITSM to Lifecycle Manager.

Administrator user credentials for Halo ITSM and Lifecycle Manager or member permissions of Manage Sync Settings selected are required to add an integration to Lifecycle Manager.

Integration instructions in Halo ITSM

Creating user and role permissions

  1. Log into an account with sufficient permission to configure API integrations

  2. Click the Configuration button (gear icons)

  3. Click Teams & Agents on the left navigation bar.

  4. Under Agents, click New to create a dedicated Lifecycle Manager integrator user account for use with the Lifecycle Manager integration.

    1. Complete the relevant information and click Save.

  5. Under the Core Features section, click the Teams & Agents button and then click Roles on the left navigation bar.

  6. Under Roles, click New to create a new role for use with the Lifecycle Manager integration that has the following permissions:

    1. In the top right corner, click on New

    2. In the New Role screen, enter a Role Name, e.g. LifecycleManager_Role

    3. Assign any agents to the role you created and then click Save.

  7. Switch to the “Permissions” tab and click Edit to enable the required permissions

    1. Under Feature Access, set Users Access Level to Read Only

    2. Under Feature Access, set Assets Access Level to Read and Modify

  8. Click Save to save the new role.

Adding API credentials

Users/admins are required credentials to applications before they can call APIs. For full functionality, you’ll need to gather a total of 5 credentials to integrate the API into Lifecycle Manager.

  1. Under the Home screen, click the **Configuration** button (gear icons)

  2. Under the Integrations section in the Advanced navigation menu, click the HaloITSM API button

Your Resource and Authorisation Server details, including a Tenant ID, are listed in the API Details section. Copy the relevant details for the:

  • Resource Server URL

  • Authorisation Server URL

  • Tenant field

The remaining credentials are generated when you register the application.

Creating the application

  1. In the Applications*section, click the View Applications button.

  2. In the top right corner, click on New.

  3. In the Add an Application screen, enter an Application Name, e.g. Lifecycle Manager

  4. Select Client ID and Secret (Services) as the Authentication Method

  5. Under your newly created application, take note of the Client ID and the Client Secret.

    1. Copy the Client ID

    2. Copy the Client Secret

      Important: The Client Secret for this application will only be shown once. If you forget it you'll need to generate a new one. The Client Secret must be copied be before saving the application. When adding the Halo ITSM integration to Lifecycle Manager, you will need to add the Client ID and Client Secret to the Halo ITSM add integration page.

  6. Select Agent as Login Type.

  7. Select yourself for Agent to login as (or another agent at your discretion)

Adding API permissions

  1. Switch to the “Permissions” tab and enable the required permissions:

    1. Select read:assets

    2. Select read:customers

  2. Click Save at the bottom of the page Important for the application to be active.

Integration steps in Lifecycle Manager

  1. Navigate to the Halo ITSM add integration page and fill in the following information gathered previously:

    1. Resource Server URL

    2. Authorisation Server URL

    3. Tenant field

    4. Client ID

    5. Client Secret

  2. Click Save HaloITSM Setup.

When you click Save HaloITSM Setup, Lifecycle Manager performs a full sync. When finished, you should be able to view your hardware assets in your account, as well as any software assets.

What's next

Did this answer your question?