Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

NHD Roles → Get One NHD Roles

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a specific "NHD Role" by its unique identifier. It is designed to fetch one particular NHD Role, optionally including additional details based on user input.

Common scenarios for this node include:

  • Fetching role details for user management or auditing within an IT service management workflow.
  • Integrating role data into dashboards or reports.
  • Automating role-based access control checks or synchronizations.

For example, you might use this node to get the configuration and permissions of a specific role in your Halo PSA system before assigning it to a new user or updating existing roles.

Properties

Name Meaning
Id The unique identifier of the NHD Role to retrieve. This is required.
Includedetails Optional flag to specify whether to include detailed information about the role.
Isconfig Optional flag to indicate if the request should consider configuration-specific details.

Output

The node outputs a JSON object representing the requested NHD Role. The structure corresponds directly to the data returned by the Halo PSA API for that role, which typically includes fields such as role ID, name, description, permissions, and possibly configuration details if requested.

If the Includedetails or Isconfig flags are set, the output may contain more comprehensive nested information about the role's settings and associated metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs valid API credentials including base URL, tenant identifier, client ID, and client secret.
  • The node expects these credentials to be configured in n8n prior to execution.

Troubleshooting

  • Missing Credentials Error: If no credentials are provided or they are invalid, the node will throw an error indicating missing credentials. Ensure that the API key credential is properly set up in n8n.
  • Resource or Operation Not Found: Errors occur if the specified resource ("NHD Roles") or operation ("Get One NHD Roles") is not recognized. Verify that the correct resource and operation names are used.
  • Invalid Id Parameter: Since the Id property is required, omitting it or providing an incorrect value will cause the API call to fail. Double-check the Id value.
  • API Request Failures: Network issues, incorrect tenant/client credentials, or insufficient permissions can cause request failures. Review API access rights and network connectivity.
  • JSON Parsing Issues: If additional query parameters or request bodies are malformed JSON, the node may throw parsing errors. Validate JSON inputs carefully.

Links and References

Discussion