iTwin Users & Access Control

Overview

This node interacts with the iTwin Users and Access Control API, specifically allowing retrieval of detailed information about a particular iTwin role. It is useful in scenarios where you need to programmatically access role definitions within an iTwin project or environment, such as for auditing permissions, synchronizing roles with other systems, or automating user access management.

For example, you might use this node to fetch the details of a specific role by its ID within a given iTwin instance, enabling downstream workflow steps to make decisions based on role attributes or to display role information in reports.

Properties

Output

The node outputs JSON data representing the retrieved iTwin role's details. This typically includes all properties returned by the iTwin API for that role, such as role name, permissions, description, and any metadata associated with it.

If multiple roles were somehow returned (though this operation targets a single role), each would be output as a separate JSON object in the array. No binary data output is indicated.

Dependencies

• Requires an API authentication token credential configured in n8n to access the iTwin Users and Access Control API.
• Depends on the iTwin OAuth2 API credentials for authorization.
• Uses an internal interpreter module (UsersOpenApiInterpreter) to map operations and execute API calls.

Troubleshooting

• Common issues:

  • Providing incorrect or invalid ID or Role ID values will result in errors or empty responses.
  • Missing or misconfigured API credentials will cause authentication failures.
  • Network connectivity problems can prevent successful API calls.

• Error messages:

  • "Unknown operation: get-itwin-role" indicates the operation parameter was not recognized; ensure the operation name matches exactly.
  • Errors related to authentication usually indicate missing or invalid API keys or tokens; verify credential setup.
  • If the node returns an error with message "iTwin Users execution failed", check the input parameters and API availability.

Links and References

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