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 permissions associated with a specific iTwin project or resource. The "Get my iTwin permissions" operation fetches the permission details for the authenticated user on a given iTwin ID. This is useful in scenarios where you need to verify or audit what access rights you have on an iTwin, such as read, write, or administrative privileges.

Practical examples include:

  • Automatically checking your access level before performing further automated operations on an iTwin.
  • Auditing permissions across multiple iTwins to ensure compliance.
  • Integrating permission checks into workflows that conditionally execute based on user rights.

Properties

Name Meaning
ID The unique identifier of the iTwin for which to retrieve the current user's permissions.

Output

The output is a JSON object containing the permissions data related to the specified iTwin ID for the authenticated user. The exact structure depends on the iTwin API response but typically includes details about the types of permissions granted (e.g., read, write, admin) and possibly metadata about the permission scope.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate 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:

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

    • "Unknown operation: get-iTwin-permissions": Indicates the operation name might be misspelled or not supported; confirm the operation parameter.
    • Errors related to permission retrieval usually indicate either invalid ID or insufficient access rights.

Links and References

Discussion