Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

User Roles → Delete Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the User Roles resource and the Delete Undefined operation, it deletes a user role identified by its ID. This is useful in scenarios where you need to programmatically remove obsolete or undefined user roles from your system to maintain clean access control.

Practical examples include:

  • Automating cleanup of user roles that are no longer valid.
  • Integrating with other systems to synchronize user role deletions.
  • Managing user permissions dynamically based on external triggers.

Properties

Name Meaning
Id The numeric identifier of the user role to delete. This property is required.

Output

The node outputs JSON data representing the response from the Halo PSA API after attempting to delete the specified user role. The structure typically contains confirmation of deletion or error details if the operation failed.

If an error occurs and "Continue On Fail" is enabled, the output JSON will contain an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • Needs configuration of the 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 endpoints.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause authentication failures.
    • Providing an invalid or non-existent user role ID will result in an error from the API.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "No credentials returned!": Indicates that the node could not retrieve the necessary API credentials. Ensure credentials are properly configured.
    • "Resource User Roles not found" or "Operation Delete Undefined not found for resource User Roles": Suggests misconfiguration of resource or operation parameters.
    • API error messages returned in the error field of the output JSON provide details on why deletion failed (e.g., role not found, permission denied).

To resolve errors, verify credentials, confirm the user role ID exists, and check network connectivity.

Links and References

Discussion