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 permissions associated with a given iModel. It is useful when you need to programmatically access or audit the permission settings of an iModel within the iTwin ecosystem. For example, you might use this node to check who has access to a particular iModel before sharing it or to verify permission changes as part of an automated workflow.

Properties

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

Output

The node outputs JSON data representing the permissions of the specified iModel. The structure typically includes details about users or groups and their respective access rights to the iModel. If the operation returns multiple permission entries, they will be output as an array of JSON objects, each describing a permission record.

Dependencies

  • Requires an API authentication token credential to connect to the iTwin Platform.
  • Depends on the iTwin Platform's iModels API endpoint for fetching permissions.
  • The node uses an internal interpreter module to map operations to API calls.

Troubleshooting

  • Common issues:
    • Providing an invalid or empty iModel ID will result in errors or no data returned.
    • Missing or incorrect API authentication credentials will cause authorization failures.
  • Error messages:
    • "Unknown operation: get-imodel-permissions" indicates the operation name was not recognized; ensure the correct operation is selected.
    • Errors related to API connectivity or permissions usually indicate problems with the provided API key or network issues.
  • Resolution tips:
    • Verify that the iModel ID is correct and exists in your iTwin environment.
    • Ensure the API authentication token is valid and has sufficient permissions.
    • Check network connectivity and API endpoint availability.

Links and References

Discussion