Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Licence Role → List Of Licence Role

AI-generated

Overview

This node integrates with the Halo PSA API to perform operations related to software license roles. Specifically, the "List Of Licence Role" operation retrieves a list of license roles associated with a given software license ID. This is useful in scenarios where you need to manage or audit software licenses and their assigned roles within an IT service management context.

Practical examples include:

  • Fetching all roles linked to a specific software license to display or process them further.
  • Automating license compliance checks by retrieving role assignments.
  • Integrating license role data into reporting or asset management workflows.

Properties

Name Meaning
Softwarelicence Id The identifier of the software license for which to list associated license roles.

Output

The node outputs JSON data representing the response from the Halo PSA API for the requested license roles. Each item in the output corresponds to a license role object as returned by the API. The exact structure depends on the API but typically includes details such as role identifiers, names, and associated metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects configuration of the following credentials parameters:
    • Base URL of the Halo PSA API instance.
    • Tenant identifier.
    • Client ID.
    • Client Secret.

These must be set up in n8n's credentials manager before using the node.

Troubleshooting

  • No credentials returned!
    This error indicates that the required API authentication credentials are missing or not properly configured. Ensure that the API key credential is created and selected in the node settings.

  • Resource or Operation not found
    If the specified resource ("Licence Role") or operation ("List Of Licence Role") is not recognized, verify that the node version supports these and that the correct values are used.

  • API request errors
    Errors returned from the Halo PSA API (e.g., authorization failures, invalid IDs) will be surfaced in the node output. Check that the software license ID provided is valid and that the API credentials have sufficient permissions.

  • JSON parsing errors
    If additional fields or query parameters are provided as JSON strings, ensure they are correctly formatted.

Links and References

Discussion