Actions9
Overview
The node provides actions related to account roles within the Pulse API. Specifically, the "Update Account Role" operation allows users to modify an existing account role by specifying its ID and updating properties such as the role name and associated scopes (permissions). This is useful in scenarios where user roles need to be adjusted dynamically, for example, changing a staff member's role from "Staff" to "Lead" or updating the permissions assigned to a role.
Practical examples:
- Updating the role name of an account role to reflect a change in organizational structure.
- Modifying the scopes (permissions) of a role to grant or restrict access to certain projects or resources.
Properties
| Name | Meaning |
|---|---|
| Account Role ID * | The unique identifier of the account role to update. |
| Role Name * | The new name for the role. Options: Admin, HR Staff, Staff, Lead, Office Manager, Production Manager, Client. |
| Additional Fields | Optional additional fields to update. |
| - Scopes | A JSON string defining the scopes (resources and permissions) for the role. Example: {"project": ["project_id_1", "project_id_2"]} |
Output
The node outputs a JSON object representing the updated account role after the operation completes successfully. This JSON typically includes details such as the role ID, role name, and any updated scopes or permissions.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the Pulse API.
- The node depends on the Pulse API helper utilities bundled within the node's codebase to perform API requests.
- Proper configuration of the API credential in n8n is necessary for successful execution.
Troubleshooting
Common issues:
- Providing an invalid or non-existent Account Role ID will likely result in an error indicating that the role could not be found.
- Malformed JSON in the "Scopes" field can cause parsing errors or API request failures.
- Insufficient permissions associated with the API key may prevent updating roles.
Error messages and resolutions:
"The operation "updateAccountRole" is not supported for resource "accountRole"!"— This indicates a misconfiguration of the operation parameter; ensure the operation is correctly set to "updateAccountRole".- Errors related to authentication usually mean the API key credential is missing or invalid; verify and reconfigure the credential.
- JSON parsing errors for scopes can be resolved by ensuring the input is valid JSON format.
Links and References
- Pulse API Documentation (for account roles and permissions management) — [Link to official API docs]
- JSON Validator tools (to validate scopes input) — e.g., https://jsonlint.com/