iTwin Users & Access Control icon

iTwin Users & Access Control

Comprehensive iTwin Users and Access Control API

Overview

This node interacts with the iTwin Users and Access Control API to manage user-related data within the iTwin platform. Specifically, for the "Get iTwin member invitations" operation under the "Members" resource, it retrieves the list of invitations sent to members of a specified iTwin project or organization. This is useful for administrators who want to track pending invitations or audit access requests.

Practical examples include:

  • Fetching all outstanding invitations to monitor who has been invited but not yet accepted.
  • Integrating invitation status checks into automated workflows for onboarding or auditing purposes.

Properties

Name Meaning
ID The unique identifier (ID) of the iTwin project or entity for which member invitations are being retrieved. This is a required string input.

Output

The output is a JSON array containing the details of the member invitations associated with the specified ID. Each item in the array represents an individual invitation with its relevant properties as returned by the iTwin API.

The node does not output binary data; all outputs are structured JSON objects representing invitation data.

Dependencies

  • Requires an API authentication token credential configured in n8n to access the iTwin Users and Access Control API.
  • The node depends on the iTwin OAuth2 API for authorization.
  • No additional external dependencies beyond the bundled code and the configured credentials.

Troubleshooting

  • Common issues:

    • Providing an invalid or empty ID will likely result in an error or no data returned.
    • Missing or incorrect API authentication credentials will cause authorization failures.
    • Network connectivity issues can prevent successful API calls.
  • Error messages:

    • "Unknown operation: get-itwin-member-invitations" indicates that the operation name was not recognized; ensure the operation parameter is correctly set.
    • Errors related to authentication typically suggest checking the API key or OAuth2 token configuration.
    • If the node returns an error object in the output JSON, enabling "Continue On Fail" allows the workflow to proceed while capturing the error details.

Links and References

  • iTwin Developer Documentation
  • Refer to the iTwin Users and Access Control API documentation for detailed information on member invitations and other user management operations.

Discussion