iTwin Users & Access Control

Comprehensive iTwin Users and Access Control API

Overview

This node integrates with the iTwin Users and Access Control API to manage user memberships within an iTwin project. Specifically, the "Add iTwin user members" operation allows adding multiple users as members to a specified iTwin project or resource by providing their details. This is useful in scenarios where you want to programmatically invite or add users to collaborate on an iTwin project, automating user management workflows.

Practical examples include:

Automatically adding new team members to an iTwin project when they join your organization.
Bulk inviting external collaborators by providing a list of their user information.
Sending customized welcome messages to new members upon addition.

Properties

Name	Meaning
ID	The identifier of the iTwin project or resource to which members will be added.
Members	A JSON array representing the list of members to add. Each member typically includes user details such as email, role, etc.
Custom Message	A string containing a custom message that will be included in the welcome email sent to new members.
Options	Additional options for the request:
- Custom Payload	Allows overriding the default request body with a custom JSON payload. Useful for advanced use cases where the standard parameters are insufficient.

Output

The node outputs JSON data representing the result of the add members operation. This typically includes confirmation details about the added members or any response returned by the iTwin API. If the operation returns multiple items, each is output as a separate JSON object in the output array.

No binary data output is indicated.

Dependencies

Requires an API authentication token credential configured in n8n to authenticate with the iTwin API.
Depends on the iTwin Users and Access Control API being accessible.
Uses an internal interpreter module (UsersOpenApiInterpreter) to map operations and execute API calls.

Troubleshooting

Common issues:
- Invalid or missing ID parameter can cause the API call to fail because the target iTwin project/resource is not specified.
- Malformed JSON in the Members property may lead to parsing errors or API rejection.
- Insufficient permissions or invalid API credentials will result in authorization errors.
- Using the "Custom Payload" option incorrectly (e.g., invalid JSON structure) can cause unexpected API errors.
Error messages:
- "Unknown operation: <operation>": Indicates the specified operation name is not recognized; ensure the operation is correctly set to "add-itwin-user-members".
- API error messages related to authentication or validation will be passed through; verify API keys and input data correctness.
- Node execution failure messages include "iTwin Users execution failed" with error details; check the error message for specifics.

Links and References

iTwin Developer Documentation
Refer to the official iTwin Users and Access Control API docs for detailed API request/response formats and permissions.