iTwin Users & Access Control

Overview

This node interacts with the iTwin Users and Access Control API, specifically allowing management of user memberships within iTwin projects. The "Remove iTwin user member" operation removes a specified user (member) from an iTwin project or context identified by an ID. This is useful in scenarios where you need to revoke access or remove users from collaborative environments managed via iTwin.

Practical examples include:

• Automatically removing a user from an iTwin project when they leave an organization.
• Managing user access dynamically based on project roles or statuses.
• Cleaning up user memberships as part of automated workflows for project lifecycle management.

Properties

Output

The output JSON contains the result of the removal operation. It can be either:

• An object representing the response from the API after attempting to remove the user member.
• If the operation returns multiple results (unlikely in this case), each result is output as a separate JSON item.
• In case of failure and if the node is set to continue on error, the output includes an error message describing the failure.

No binary data output is indicated.

Dependencies

• Requires an API authentication credential for the iTwin OAuth2 service.
• Depends on the iTwin Users OpenAPI interpreter module internally to map and execute operations.
• The node requires proper configuration of the OAuth2 credentials in n8n to authenticate API requests.

Troubleshooting

• Common issues:

  • Invalid or missing ID or Member ID parameters will cause the operation to fail.
  • Authentication errors if the OAuth2 token is expired or misconfigured.
  • Network or API endpoint issues may cause request failures.

• Error messages:

  • "Unknown operation: <operation>": Indicates that the requested operation name is not recognized; ensure the operation parameter is correctly set to "remove-itwin-user-member".
  • Errors returned from the API are passed through; these might indicate permission issues or invalid IDs.
  • If the node is configured to continue on failure, errors will appear in the output JSON under an error field with a descriptive message.

To resolve errors:

• Verify that both ID and Member ID are correct and correspond to existing entities.
• Check OAuth2 credentials and refresh tokens if necessary.
• Review API permissions to ensure the authenticated user has rights to remove members.

Links and References

• iTwin Developer Documentation
• Refer to the iTwin Users & Access Control API documentation for detailed API behavior and error codes.