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 and retrieve information about users within an iTwin environment. The "Get iTwin user members" operation fetches the members associated with a specified iTwin user ID. This is useful in scenarios where you need to programmatically access user membership details for auditing, reporting, or managing access control within iTwin projects.

Practical examples include:

  • Retrieving all members of a particular iTwin user group to verify permissions.
  • Automating user management workflows by fetching user membership data.
  • Integrating iTwin user data into other systems for consolidated user administration.

Properties

Name Meaning
ID The unique identifier of the iTwin user whose members you want to retrieve. This is a required string input.

Output

The output is a JSON object (or an array of objects) representing the members associated with the specified iTwin user ID. Each item in the output contains detailed information about a user member as returned by the iTwin Users API.

If multiple members are returned, the output will be an array of JSON objects, each corresponding to one member. If a single object is returned, it will be wrapped in a JSON object under the json field.

No binary data output is indicated.

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 user ID: Ensure the "ID" property is correctly set and corresponds to an existing iTwin user.
    • Authentication failures: Verify that the OAuth2 API credentials are correctly configured and have sufficient permissions.
    • Network or API errors: Check connectivity and API status.
  • Error messages:

    • "Unknown operation: get-itwin-user-members": This indicates the operation name might be incorrect or not supported; ensure the operation parameter is exactly "get-itwin-user-members".
    • Errors related to authentication typically indicate misconfigured or expired credentials.
    • If the node returns an error with "iTwin Users execution failed", check the error message for specifics and validate input parameters.

Links and References

Discussion