Actions37
- Groups Actions
- Members Actions
- Roles Actions
- Permissions Actions
- Jobs Actions
- Shares Actions
- Actions Actions
- Users Actions
Overview
This node interacts with the iTwin Users and Access Control API to retrieve user information based on a search query. It is designed to find users whose name or email contains a specified search string. This functionality is useful in scenarios where you need to filter or look up users dynamically, such as managing access control lists, auditing user accounts, or integrating user data into workflows.
For example, you might use this node to:
- Search for all users containing "john" in their name or email.
- Retrieve user details before assigning permissions in an automated process.
- Filter users for reporting or notification purposes.
Properties
| Name | Meaning |
|---|---|
| Search | Find all users that have the search string anywhere in the name or email. Must be 3 to 200 characters long. |
Output
The output is an array of JSON objects representing the users found by the search query. Each object corresponds to a user record returned by the iTwin Users API. The exact structure depends on the API response but typically includes user details such as name, email, ID, and other relevant attributes.
If multiple users are found, each user is output as a separate JSON item in the array.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the iTwin OAuth2 service.
- Needs proper configuration of the iTwin OAuth2 API credentials within n8n.
- Depends on the iTwin Users and Access Control API being accessible and the provided credentials having sufficient permissions.
Troubleshooting
Common issues:
- Providing a search string shorter than 3 characters or longer than 200 characters will likely cause the API to reject the request.
- Invalid or expired API credentials will result in authentication errors.
- Network connectivity problems can prevent successful API calls.
Error messages:
"Unknown operation: get-users": Indicates the operation parameter was not recognized; ensure the operation is set correctly.- Errors related to authentication failures suggest checking the API key or OAuth token validity.
- If the node returns an error with
errorfield in JSON, enabling "Continue On Fail" allows workflow continuation while logging the issue.
Links and References
- iTwin Developer Documentation
- Refer to the iTwin Users & Access Control API documentation for detailed API usage and response formats.