iTwin Users & Access Control icon

iTwin Users & Access Control

Comprehensive iTwin Users and Access Control API

Actions37

Overview

This node integrates with the iTwin Users and Access Control API to manage user memberships within iTwin projects. Specifically, the "Add iTwin owner member" operation allows adding a user as an owner member to an iTwin project by specifying the project ID and the user's email. This is useful in scenarios where you want to programmatically grant ownership access to users for collaboration or administrative purposes on iTwin projects.

Practical examples include:

  • Automating onboarding workflows by adding new team members as owners to specific iTwin projects.
  • Managing access control dynamically based on external triggers or events.
  • Integrating with other systems to synchronize user permissions in iTwin environments.

Properties

Name Meaning
ID The identifier of the iTwin project to which the owner member will be added.
Email The email address of the user to be added as an owner member.
Options Additional options including:
- Custom Payload: Allows overriding the request body with a custom JSON payload for advanced use cases.

Output

The node outputs JSON data representing the result of the add owner member operation. The structure typically contains details about the newly added member or confirmation of the action. If the operation returns multiple items, each is output as a separate JSON object.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Users and Access Control API.
  • The node depends on the iTwin OAuth2 authentication mechanism configured in n8n.
  • Internet connectivity to reach the iTwin API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing project ID or user email can cause the operation to fail.
    • Insufficient permissions or invalid API credentials may result in authorization errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "Unknown operation: add-itwin-owner-member": Indicates the operation name is not recognized; ensure the correct operation is selected.
    • API errors returned from the iTwin service (e.g., 401 Unauthorized, 404 Not Found) should be checked against the provided credentials and input parameters.
    • JSON parsing errors if using the custom payload option incorrectly formatted JSON.

  • Resolutions:

    • Verify that the project ID and email are correctly specified.
    • Confirm that the API credentials have the necessary scopes and are valid.
    • Use the "Custom Payload" option only if you understand the required JSON structure for the API call.

Links and References

Discussion