Actions31
- Option Set Actions
- Public Query Actions
- Record Actions
- Role Actions
- Workflow Actions
- Worksheet Actions
Role → Create
AI-generatedOverview
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 new 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
| Name | Meaning |
|---|---|
| Name | The name of the role to create. This is a required string input. |
| Description | An optional description providing details about the role. |
Output
The node outputs JSON data representing the newly created role object returned from the HAP API. This typically includes properties such as the role's unique identifier, name, description, and possibly metadata related to creation time or permissions. The exact structure depends on the HAP API response but generally provides all relevant information about the created role.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to the HAP API via an API key credential configured in n8n.
- The node expects the HAP API to be accessible and properly authenticated.
- No additional external dependencies are indicated.
Troubleshooting
Common issues:
- Missing or invalid API credentials will cause authentication failures.
- Providing an empty or missing "Name" property will likely result in validation errors from the API.
- Network connectivity problems can prevent successful API calls.
Error messages:
- Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
- Validation errors from the API may mention missing required fields like "Name"; ensure all required inputs are provided.
- Timeout or network errors suggest connectivity issues; check network settings and API availability.
Links and References
- Hyper Application Platform (HAP) API Documentation (example placeholder link)
- n8n documentation on Creating Custom Nodes