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 role permissions associated with an iModel. It is useful for scenarios where you need to programmatically access or audit the permissions assigned to roles within a given iModel in the iTwin ecosystem. For example, it can be used to fetch and review role permissions before making changes or to integrate permission data into other workflows or reporting tools.

Properties

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

Output

The node outputs JSON data representing the role permissions of the specified iModel. The exact structure depends on the API response but generally includes details about roles and their associated permissions within that iModel.

If multiple permissions or roles are returned, they will be output as an array of JSON objects, each describing a role and its permissions.

Dependencies

  • Requires an API authentication token credential to connect to the iTwin Platform.
  • Depends on the iTwin Platform iModels API.
  • The node internally uses an OpenAPI interpreter module to execute the requested 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.
    • Unknown operation error: This occurs if the operation name is incorrect or not supported; ensure the operation is exactly "get-imodel-role-permissions".
  • Error messages:
    • "Unknown operation: get-imodel-role-permissions": Check the operation parameter spelling and casing.
    • API errors related to permissions or access denied usually indicate insufficient rights or invalid credentials.

Links and References

Discussion