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, specifically allowing the removal of a member from an iTwin group. It is useful in scenarios where you need to programmatically manage user memberships within iTwin groups, such as automating access control or cleaning up group memberships based on external triggers.

For example, if a user leaves a project or organization, this node can be used to remove their membership from relevant iTwin groups automatically, ensuring that access permissions remain accurate and secure.

Properties

Name Meaning
ID The unique identifier of the member to be removed from the iTwin group.
Group ID The unique identifier of the iTwin group from which the member will be removed.

Output

The node outputs JSON data representing the result of the removal operation. This typically includes confirmation details or status information returned by the iTwin API about the removal action.

The output structure is:

{
  "result": <operation_result_object>
}

Where <operation_result_object> contains the API response confirming the removal.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the iTwin OAuth2 API.
  • The node depends on the iTwin Users and Access Control API being accessible.
  • Proper configuration of the OAuth2 credentials in n8n is necessary for successful API calls.

Troubleshooting

  • Common issues:

    • Invalid or missing ID or Group ID parameters will cause the operation to fail.
    • Authentication errors due to misconfigured or expired API credentials.
    • Network connectivity issues preventing access to the iTwin API.
  • Error messages:

    • "Unknown operation: remove-itwin-group-member": Indicates the operation name was not recognized; ensure the correct operation is selected.
    • API error responses related to authorization or invalid IDs will be passed through; verify the correctness of input parameters and credentials.
  • Resolution tips:

    • Double-check that both ID and Group ID are correctly provided and correspond to existing entities.
    • Ensure the OAuth2 API credentials are valid and have sufficient permissions.
    • Use the node's "Continue On Fail" option to handle errors gracefully during batch operations.

Links and References

Discussion