Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

User Roles → Get One User Roles

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve information about user roles. Specifically, the "Get One User Roles" operation fetches details for a single user role identified by its ID. This is useful in scenarios where you need to programmatically access role configurations or permissions assigned to users within the Halo PSA system.

Practical examples include:

  • Automating audits of user roles and permissions.
  • Synchronizing user role data with other systems.
  • Displaying detailed role information in custom dashboards or reports.

Properties

Name Meaning
Id The unique identifier (number) of the user role to retrieve.
Includedetails Optional flag to include additional details in the response. Accepts values as query parameter.

Output

The node outputs JSON data representing the user role object retrieved from the Halo PSA API. The structure typically includes role attributes such as name, description, permissions, and possibly nested details if Includedetails is set.

If the node encounters an error during the request, it outputs a JSON object with an error field containing the error message.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • Needs configuration of base URL, tenant identifier, client ID, and client secret for the Halo PSA service.
  • Uses HTTP requests to communicate with the Halo PSA REST API.

Troubleshooting

  • No credentials returned!: Ensure that the API authentication credentials are properly configured in n8n.
  • Resource or Operation not found: Verify that the resource is set to "User Roles" and the operation to "Get One User Roles".
  • Invalid or missing Id: The Id property is required; ensure it is provided and valid.
  • API request errors: Network issues, invalid credentials, or insufficient permissions can cause request failures. Check the error message output for details.
  • If continueOnFail is enabled, errors will be returned as part of the output JSON instead of stopping execution.

Links and References

Discussion