iTwin Users & Access Control

Overview

This node integrates with the iTwin Users and Access Control API to manage user-related operations within the iTwin platform. Specifically, the "Get user" operation retrieves detailed information about a single user by their unique user ID. This is useful in scenarios where you need to fetch user details for auditing, access control verification, or synchronization with other systems.

Practical examples include:

• Retrieving user profile information to display in a dashboard.
• Validating user existence before assigning permissions.
• Synchronizing user data between iTwin and external databases.

Properties

Output

The output is a JSON object containing the retrieved user's details as returned by the iTwin Users API. The structure typically includes user attributes such as name, email, roles, and other metadata associated with the user.

If multiple users were returned (not applicable here since this operation targets a single user), the output would be an array of JSON objects. For this operation, expect a single JSON object representing the user.

No binary data output is produced by this node.

Example output snippet (conceptual):

{
  "id": "user-id",
  "name": "User Name",
  "email": "user@example.com",
  "roles": ["role1", "role2"],
  ...
}

Dependencies

• Requires an API authentication token configured via OAuth2 credentials for the iTwin platform.
• The node depends on the iTwin Users and Access Control API being accessible.
• No additional external services are required beyond the iTwin API.

Troubleshooting

• Common issues:

  • Invalid or missing user ID will cause the operation to fail.
  • Authentication errors if the OAuth2 token is expired or misconfigured.
  • Network connectivity issues preventing access to the iTwin API.

• Error messages:

  • "Unknown operation: get-user": Indicates the operation parameter was not recognized; ensure the operation name is correctly set.
  • API error responses will be passed through; for example, "User not found" if the ID does not exist.
  • If continueOnFail is enabled, errors will be returned in the output JSON under an error field instead of stopping execution.

To resolve errors:

• Verify the user ID is correct and exists.
• Check OAuth2 credential configuration and refresh tokens if needed.
• Ensure network connectivity to the iTwin API endpoint.

Links and References

• iTwin Developer Documentation
• Refer to the iTwin Users and Access Control API docs for detailed user object schema and additional operations.