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 retrieve information about users and groups within an iTwin environment. Specifically, the "Get iTwin group members" operation fetches the list of members belonging to a specified iTwin group. This is useful for managing access control, auditing group memberships, or integrating user data into workflows.

Practical examples include:

  • Automatically retrieving all members of a project group to send notifications.
  • Auditing group membership changes over time.
  • Synchronizing iTwin group members with other systems like CRM or identity providers.

Properties

Name Meaning
ID The unique identifier of the iTwin group whose members you want to retrieve.

Output

The output is a JSON array where each item represents a member of the specified iTwin group. Each member object contains details as returned by the iTwin Users API, such as user identifiers, roles, and other relevant metadata.

If multiple members are returned, each will be an individual JSON object in the output array.

Dependencies

  • Requires an API authentication token credential configured in n8n to access the iTwin Users & Access Control API.
  • The node depends on the iTwin OAuth2 API credentials to authenticate requests.
  • Internet connectivity to reach Bentley's iTwin API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing group ID: Ensure the "ID" property is correctly set to a valid group identifier.
    • Authentication errors: Verify that the API key or OAuth2 credentials are properly configured and have sufficient permissions.
    • Network issues: Confirm that your environment can reach the iTwin API servers.
  • Error messages:

    • "Unknown operation: get-itwin-group-members": This indicates the operation name was not recognized; ensure the operation parameter is correctly set.
    • API errors related to authorization or invalid IDs will be surfaced from the iTwin API; check the error message for details and verify credentials and input parameters.

Links and References

Discussion