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 to manage user-related operations within the iTwin platform. The "Get iTwin user member" operation retrieves detailed information about a specific user member associated with an iTwin project or organization.

Common scenarios for this node include:

  • Fetching user details for auditing or reporting purposes.
  • Verifying membership status of a user in an iTwin project.
  • Integrating user data retrieval into automated workflows for access control management.

For example, you might use this node to get the profile information of a team member by specifying their unique member ID and the related iTwin user ID.

Properties

Name Meaning
ID The unique identifier of the iTwin user whose member information you want to retrieve.
Member ID The unique identifier of the member within the specified iTwin user context.

Output

The output is a JSON object containing the retrieved user member's details from the iTwin platform. This typically includes all relevant properties of the user member such as name, email, roles, status, and other metadata defined by the iTwin Users API.

If multiple results are returned (though unlikely for a single member fetch), each will be output as a separate JSON object in the array.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the iTwin platform via an OAuth2 API credential.
  • The node depends on the iTwin Users OpenAPI interpreter module internally to map and execute API calls.
  • Proper configuration of the OAuth2 credentials in n8n is necessary to authenticate requests.

Troubleshooting

  • Common issues:

    • Invalid or missing IDs: Ensure that both the "ID" and "Member ID" fields are correctly provided and correspond to existing entities in the iTwin system.
    • Authentication errors: Verify that the OAuth2 credentials are valid and have sufficient permissions.
    • Network or API downtime: Check connectivity and iTwin service status if requests fail unexpectedly.
  • Error messages:

    • "Unknown operation: <operation>": Indicates an unsupported or misspelled operation name; verify the operation parameter.
    • Errors related to failed API calls will be caught and can be output as error objects if "Continue On Fail" is enabled, helping to debug issues without stopping the workflow.

Links and References

Discussion