iTwin iModels icon

iTwin iModels

Interact with iTwin Platform iModels API for managing iModels, changesets, named versions, and more

Actions54

Overview

This node interacts with the iTwin Platform's iModels API, specifically to retrieve user permissions for a given iModel. It is useful in scenarios where you need to programmatically check or audit which users have access rights to an iModel within the iTwin ecosystem. For example, it can be used in automated workflows that verify user access before performing operations on an iModel or to generate reports of user permissions.

Properties

Name Meaning
ID The unique identifier of the iModel for which user permissions are being requested. This is a required string input.

Output

The node outputs JSON data representing the user permissions associated with the specified iModel. The structure typically includes details about users and their permission levels on the iModel. If multiple permissions or users are returned, the output will be an array of JSON objects, each describing a user permission entry.

No binary data output is produced by this node.

Dependencies

  • Requires an API authentication token credential configured in n8n to access the iTwin Platform API.
  • Depends on the iTwin Platform's iModels API endpoint for fetching user permissions.
  • The node internally uses an OpenAPI interpreter module to execute the operation.

Troubleshooting

  • Common issues:

    • Invalid or missing iModel ID: Ensure the "ID" property is correctly set to a valid iModel identifier.
    • Authentication errors: Verify that the API key or OAuth2 credentials are properly configured and have sufficient permissions.
    • Network or API availability issues: Check connectivity to the iTwin Platform API and confirm service status.
  • Error messages:

    • "Unknown operation: get-imodel-user-permissions": Indicates the operation name might be misspelled or not supported; ensure the operation parameter is exactly as expected.
    • Errors related to permission denied or unauthorized access usually mean the provided credentials lack necessary scopes or roles.
    • If the node returns an error object in the output JSON, inspect the error message for details and adjust inputs or credentials accordingly.

Links and References

Discussion