iTwin Users & Access Control icon

iTwin Users & Access Control

Comprehensive iTwin Users and Access Control API

Overview

This node integrates with the iTwin Users and Access Control API to manage user data. Specifically, the "Get users by id list" operation allows retrieving multiple user details by providing a list of user IDs in the request body. This is useful when you need to fetch detailed information about specific users in bulk, for example, to synchronize user profiles or audit access rights.

Practical examples:

  • Fetching user details for a batch of user IDs obtained from another system.
  • Retrieving user information to display in a dashboard or report.
  • Validating user existence before performing further operations.

Properties

Name Meaning
Body JSON string representing the request body containing the list of user IDs to retrieve.
Options Collection of optional settings:
  Custom Payload Allows overriding the default request body with a custom JSON payload. You can enable this and provide any JSON structure to send instead of the standard body.

Output

The node outputs an array of JSON objects, each representing a user retrieved from the API. The exact structure depends on the API response but typically includes user details such as ID, name, email, roles, and other metadata.

If the node encounters errors during execution and "Continue On Fail" is enabled, it outputs JSON objects containing error messages and node info.

No binary data output is indicated.

Dependencies

  • Requires an API authentication credential (OAuth2 token) configured in n8n to access the iTwin Users and Access Control API.
  • Depends on the bundled UsersOpenApiInterpreter module to interpret and execute API operations.
  • The node expects valid JSON input for the request body or a custom JSON payload if overridden.

Troubleshooting

  • Common issues:
    • Invalid JSON in the "Body" property will cause parsing errors.
    • Providing user IDs that do not exist may result in empty or partial responses.
    • Missing or invalid API credentials will cause authentication failures.
  • Error messages:
    • "Unknown operation: <operation>": Indicates the specified operation is not supported; verify the operation name.
    • Errors related to JSON parsing: Ensure the "Body" field contains valid JSON.
    • API errors returned from the service will be included in the output if "Continue On Fail" is enabled; otherwise, they will stop execution.

Links and References

Discussion