Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

NHD Roles → List Of NHD Roles

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the "NHD Roles" resource and the "List Of NHD Roles" operation, it retrieves a list of roles from the system, optionally filtered by certain query parameters.

Common scenarios where this node is beneficial include:

  • Automating role management workflows by fetching current roles.
  • Integrating role data into other systems or dashboards.
  • Filtering roles based on access control levels, agent IDs, or configuration flags.

For example, you could use this node to fetch all roles with a specific access control level to audit permissions or to synchronize roles with an external identity provider.

Properties

Name Meaning
Access Control Level Filter roles by their access control level.
Agentid Filter roles associated with a specific agent ID.
Isconfig Filter roles based on whether they are configuration roles (true/false).

These properties are sent as query parameters in the API request to filter the list of NHD roles returned.

Output

The node outputs an array of JSON objects, each representing an NHD role retrieved from the Halo PSA API. The exact structure depends on the API response but typically includes details such as role identifiers, names, access levels, and related metadata.

No binary data output is produced by this operation.

Example output snippet (conceptual):

[
  {
    "roleId": "123",
    "roleName": "Administrator",
    "accessControlLevel": "High",
    "agentId": "456",
    "isConfig": true
  },
  {
    "roleId": "124",
    "roleName": "User",
    "accessControlLevel": "Low",
    "agentId": "789",
    "isConfig": false
  }
]

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate requests via custom headers.
  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request capabilities.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot retrieve the required API credentials. Ensure that the API key credential is properly configured in n8n.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("NHD Roles") and operation ("List Of NHD Roles") are selected.

  • API request errors
    Errors from the API (e.g., authentication failures, invalid query parameters) will be returned in the node output if "Continue On Fail" is enabled; otherwise, they will stop execution. Check the API credentials and parameter values.

  • Invalid JSON in parameters
    If using JSON parameters for queries or request bodies, ensure the JSON syntax is correct to avoid parsing errors.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion