iTwin Users & Access Control

Overview

This node interacts with the iTwin platform to retrieve information about roles associated with a specific iTwin project or environment. The "Get iTwin roles" operation fetches all roles defined within an iTwin identified by its unique ID. This is useful for managing access control, auditing permissions, or integrating role-based data into workflows.

Practical examples include:

• Automatically listing all roles in an iTwin to synchronize with an external user management system.
• Fetching roles to assign or verify permissions before performing further automated actions.
• Auditing role definitions as part of compliance or governance workflows.

Properties

Output

The node outputs JSON data containing the roles retrieved from the specified iTwin. Each item in the output array corresponds to a role object with details such as role name, permissions, and other metadata as provided by the iTwin API.

If multiple roles are returned, each will be an individual JSON object in the output array. If no roles are found or an error occurs, the output will reflect that accordingly.

The node does not output binary data.

Dependencies

• Requires an API authentication token credential configured in n8n to access the iTwin platform securely.
• Depends on the iTwin Users and Access Control API endpoint to fetch role data.
• The node uses an internal interpreter module to map operations to API calls.

Troubleshooting

• Common issues:

  • Invalid or missing iTwin ID: Ensure the ID is correctly provided and corresponds to an existing iTwin.
  • Authentication errors: Verify that the API key or OAuth2 credentials are valid and have sufficient permissions.
  • Network or API downtime: Check connectivity and iTwin service status.

• Error messages:

  • "Unknown operation: get-iTwin-roles": Indicates the operation parameter was not recognized; ensure the operation name matches exactly.
  • Errors related to failed API calls will typically include the message returned by the iTwin API; review these messages for clues (e.g., permission denied, resource not found).
  • If continueOnFail is enabled, errors will be included in the output JSON under an error field instead of stopping execution.

Links and References

• iTwin Developer Documentation
• Refer to the official iTwin API docs for detailed role schema and permissions information.