iTwin Users & Access Control icon

iTwin Users & Access Control

Comprehensive iTwin Users and Access Control API

Actions37

Overview

This node interacts with the iTwin platform to retrieve information about groups associated with a specified iTwin project or context. Specifically, the "Get iTwin groups" operation fetches details of groups by their unique identifier. This is useful in scenarios where you need to manage or audit group memberships, permissions, or roles within an iTwin environment.

Practical examples include:

  • Automating access control audits by retrieving group details.
  • Integrating group information into other workflows for reporting or synchronization.
  • Managing user permissions by fetching group data before applying changes.

Properties

Name Meaning
ID The unique identifier of the iTwin group to retrieve. This is a required string input that specifies which group's details to fetch.

Output

The node outputs JSON data representing the details of the requested iTwin group. The structure typically includes group metadata such as its name, description, members, and related attributes as provided by the iTwin API.

If multiple groups were returned (not typical for this operation since it requires a single ID), the output would be an array of group objects. Otherwise, the output is a single JSON object with the group's information.

No binary data output is indicated.

Dependencies

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

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent group ID will likely result in an error or empty response.
    • Missing or incorrect API credentials will cause authentication failures.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "Unknown operation: get-itwin-groups" indicates the operation parameter was not recognized; ensure the operation name matches exactly.
    • Errors related to authentication usually suggest checking the API key or OAuth2 token configuration.
    • If the node returns {error: "...", nodeInfo: "iTwin Users execution failed"}, enabling "Continue On Fail" allows the workflow to proceed despite errors, but the error message should be reviewed for specifics.

Links and References

Discussion