iTwin Users & Access Control icon

iTwin Users & Access Control

Comprehensive iTwin Users and Access Control API

Actions37

Overview

This node operation "Get iTwin Share" is designed to retrieve detailed information about a specific share within the iTwin platform. It is useful in scenarios where users need to programmatically access metadata or status of shared resources identified by unique IDs. For example, it can be used to verify sharing permissions, audit shared content, or integrate share details into other workflows.

Properties

Name Meaning
ID The unique identifier of the resource related to the share you want to retrieve.
Share ID The unique identifier of the specific share instance to fetch details for.

Output

The output JSON contains the detailed data of the requested iTwin share. This typically includes all relevant metadata and attributes associated with that share, such as permissions, share status, timestamps, and any other properties returned by the iTwin API for a share entity.

No binary data output is indicated or expected from this operation.

Dependencies

  • Requires an API authentication token credential configured in n8n to access the iTwin platform.
  • Depends on the iTwin Users & Access Control API.
  • The node internally uses an interpreter module to map operations to API calls (not fully shown here).

Troubleshooting

  • Common issues:

    • Missing or invalid ID or Share ID parameters will cause the operation to fail.
    • Authentication errors if the API key or OAuth2 token is not properly configured.
    • Network or API endpoint issues may result in request failures.

  • Error messages:

    • "Unknown operation: get-itwin-share" indicates the operation name was not recognized; ensure correct spelling and casing.
    • Errors containing "iTwin Users execution failed" suggest problems during API interaction; check credentials and parameter values.

  • Resolution tips:

    • Verify that both ID and Share ID are correctly provided and correspond to existing shares.
    • Confirm that the API authentication credential is valid and has necessary permissions.
    • Enable "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion