iTwin Users & Access Control icon

iTwin Users & Access Control

Comprehensive iTwin Users and Access Control API

Overview

This node interacts with the iTwin platform to retrieve detailed information about a specific iTwin group. It is useful in scenarios where you need to programmatically access group data within an iTwin project or environment, such as managing user permissions, auditing group memberships, or integrating group details into other workflows.

For example, you might use this node to fetch a group's metadata by specifying its ID and Group ID, then use that data to automate access control processes or synchronize group information with external systems.

Properties

Name Meaning
ID The unique identifier of the iTwin instance or context in which the group exists.
Group ID The unique identifier of the specific group within the iTwin instance to retrieve data for.

Output

The node outputs JSON data representing the retrieved iTwin group details. This typically includes all relevant properties of the group as returned by the iTwin API, such as group name, description, members, roles, and other metadata.

If multiple groups were returned (though this operation targets a single group), each would be output as a separate JSON object. No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate requests against the iTwin platform.
  • Depends on the iTwin Users & Access Control API.
  • The node internally uses an interpreter module to map operations to API calls.

Troubleshooting

  • Common issues:

    • Providing incorrect or missing ID or Group ID will result in errors or empty responses.
    • Authentication failures if the API key or OAuth2 token is invalid or expired.
    • Network connectivity problems when reaching the iTwin API endpoint.
  • Error messages:

    • "Unknown operation: get-itwin-group" indicates the operation parameter was not recognized; ensure the operation name matches exactly.
    • Errors related to failed API calls will include messages from the iTwin API; verify credentials and input parameters.
  • Resolution tips:

    • Double-check that both ID and Group ID are correctly set and correspond to existing entities in your iTwin environment.
    • Ensure the API authentication token is valid and has sufficient permissions.
    • Use the node's "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion