Actions54
- Resource Actions
- Userpermissions Actions
- Baselinefile Actions
- Locks Actions
- Briefcases Actions
- Checkpoint Actions
- Thumbnail Actions
- Extendeddata Actions
- Changesets Actions
- Changesetgroups Actions
- Permissions Actions
- Recents Actions
- Namedversions Actions
- Shares Actions
- Rolepermissions Actions
- Users Actions
- Favorites Actions
- Fork Actions
- Clone Actions
- Create Actions
Overview
This node interacts with the iTwin Platform's iModels API, specifically to update role permissions for an iModel. It allows users to modify the access control settings by specifying an array of role permissions associated with a particular iModel ID.
Common scenarios where this node is beneficial include:
- Automating permission updates when roles or team structures change.
- Integrating iModel access management into broader workflows, such as project onboarding or auditing.
- Bulk updating permissions across multiple iModels programmatically.
For example, a user might use this node to update the permissions of a design review team on a specific iModel by providing the iModel ID and a JSON array defining the new role permissions.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel for which role permissions are being updated. |
| Role Permissions | An array of role permissions in JSON format that defines the new permissions to apply. |
| Options | Additional optional settings: |
| - Custom Payload | Allows overriding the request body with a custom JSON payload instead of the default one. |
Output
The node outputs JSON data representing the response from the iTwin Platform API after attempting to update the role permissions. This typically includes confirmation of the update or details about the updated permissions.
If a custom payload is used, the output reflects the API's response to that payload.
No binary data output is involved.
Dependencies
- Requires an API authentication token credential configured in n8n to authenticate with the iTwin Platform API.
- Depends on the iTwin Platform's iModels API endpoint for updating role permissions.
- Uses an internal interpreter module (
IModelsOpenApiInterpreter) to map operations and execute API calls.
Troubleshooting
Common Issues:
- Invalid or missing iModel ID can cause the API call to fail.
- Malformed JSON in the "Role Permissions" property will result in parsing errors.
- Insufficient permissions or invalid API credentials may lead to authorization errors.
- Using a custom payload incorrectly formatted can cause unexpected API errors.
Error Messages:
"Unknown operation": Indicates the specified operation name is not recognized; ensure "update-imodel-role-permissions" is selected.- API error messages related to authentication or validation will be passed through; verify credentials and input data correctness.
- JSON parsing errors if the "Role Permissions" JSON is invalid; validate JSON syntax before input.
Links and References
- iTwin Platform Developer Documentation
- iModels API Reference (general reference for iModel operations)