HAP

Overview

This node interacts with the Hyper Application Platform (HAP) API to manage roles within the platform. Specifically, the "Role: Create" operation allows users to create a new role by specifying its name and an optional description. This is useful in scenarios where you want to programmatically define user roles for access control or organizational purposes within HAP.

Practical examples include:

• Automating the setup of roles during onboarding processes.
• Creating custom roles dynamically based on external data or workflows.
• Managing role definitions as part of a larger application deployment pipeline.

Properties

Output

The node outputs JSON data representing the newly created role object returned from the HAP API. This typically includes the role's unique identifier, name, description, and any other metadata provided by the API.

If the node supports binary data output, it would generally relate to attachments or files associated with roles, but this operation focuses on JSON data only.

Dependencies

• Requires an API key credential for authenticating with the HAP API.
• The node expects the HAP API endpoint to be accessible and properly configured.
• No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

• Authentication errors: Ensure that the API key credential is valid and has sufficient permissions to create roles.
• Validation errors: The "Name" property is mandatory; missing or empty values will cause the API to reject the request.
• API connectivity issues: Verify network access to the HAP API endpoint.
• Unexpected API responses: Check if the API version or schema has changed, which might require updating the node or its configuration.

Links and References

• Hyper Application Platform (HAP) API Documentation (example placeholder link)