iTwin Users & Access Control

Overview

This node interacts with the iTwin Users and Access Control API, specifically to retrieve groups based on a search string. It is useful when you want to find all groups whose display names contain a particular substring. For example, if you manage user access in an iTwin environment and need to list or filter groups dynamically by name, this operation helps automate that process.

Properties

Output

The output is an array of JSON objects representing the groups matching the search criteria. Each item in the output corresponds to one group returned by the API. The exact structure of each group object depends on the API response but typically includes details like group ID, display name, and other metadata.

No binary data output is indicated.

Dependencies

• Requires an API key credential for authenticating with the iTwin OAuth2 API.
• The node uses the iTwin Users and Access Control API endpoint.
• Proper configuration of the OAuth2 credentials within n8n is necessary for successful API calls.

Troubleshooting

• Common issues:

  • Missing or invalid API authentication token will cause authorization errors.
  • Providing an empty or invalid search string may result in no results or API errors.
  • Network connectivity problems can prevent the node from reaching the iTwin API.

• Error messages:

  • "Unknown operation: get-groups": This indicates the operation parameter was not recognized; ensure "Get groups" is selected.
  • API errors related to authentication usually indicate misconfigured or expired credentials.
  • If the node returns an error with continueOnFail enabled, check the error message in the output JSON under error.

Links and References

• iTwin Developer Documentation
• Refer to the iTwin Users and Access Control API docs for detailed information on group properties and filtering options.