Actions37
- Groups Actions
- Members Actions
- Roles Actions
- Permissions Actions
- Jobs Actions
- Shares Actions
- Actions Actions
- Users Actions
Overview
This node allows updating an iTwin role by modifying its properties such as display name, description, and permissions. It is useful in scenarios where you need to manage access control dynamically within your iTwin environment, for example, updating roles to reflect changes in team responsibilities or project requirements.
Practical examples include:
- Changing the display name of a role to better represent its purpose.
- Updating the description to provide more context about the role.
- Modifying the permissions assigned to a role to grant or restrict access to certain features or data.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iTwin instance where the role exists. |
| Role ID | The unique identifier of the specific iTwin role to update. |
| Display Name | The new display name for the role. |
| Description | A textual description providing details about the role. |
| Permissions | A JSON array defining the permissions associated with the role. |
| Options | Additional options including: |
| Custom Payload | Allows overriding the request body with a custom JSON payload if enabled. |
Output
The node outputs JSON data representing the updated role object returned from the API after the update operation. This typically includes the updated fields such as the role's ID, display name, description, and permissions.
If a custom payload is used, the output reflects the response based on that payload.
No binary data output is involved.
Dependencies
- Requires an API authentication token credential configured in n8n to authorize requests against the iTwin Users and Access Control API.
- Depends on the iTwin Users OpenAPI interpreter module internally to map and execute the update operation.
Troubleshooting
Common issues:
- Providing invalid or missing iTwin ID or Role ID will cause the update to fail.
- Incorrectly formatted permissions JSON may result in API errors.
- Using a custom payload without proper JSON structure can lead to request failures.
Error messages:
"Unknown operation": Indicates the specified operation is not recognized; ensure "update-iTwin-role" is selected.- API errors related to authorization or invalid input will be surfaced; verify credentials and input correctness.
Resolution tips:
- Double-check required fields (ID and Role ID) are correctly set.
- Validate JSON syntax for permissions and custom payloads before execution.
- Ensure the API key or token has sufficient permissions to perform role updates.
Links and References
- iTwin Developer Documentation
- Refer to the official iTwin Users and Access Control API docs for detailed role management endpoints and payload structures.