Actions54
- Resource Actions
- Userpermissions Actions
- Baselinefile Actions
- Locks Actions
- Briefcases Actions
- Checkpoint Actions
- Thumbnail Actions
- Extendeddata Actions
- Changesets Actions
- Changesetgroups Actions
- Permissions Actions
- Recents Actions
- Namedversions Actions
- Shares Actions
- Rolepermissions Actions
- Users Actions
- Favorites Actions
- Fork Actions
- Clone Actions
- Create Actions
Overview
This node interacts with the iTwin Platform's iModels API, specifically to retrieve users associated with a given iModel. It is useful in scenarios where you need to list or manage users who have access to or are involved with a particular iModel project. For example, it can be used to audit user permissions, synchronize user data with other systems, or generate reports on iModel collaborators.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel for which you want to retrieve the users. This is a required string input. |
| Continuation Token | A token used to fetch the next page of results in a paginated response. This token is generated by the service and must be sent exactly as received. It is mutually exclusive with the skip parameter (not shown here). To start using continuation tokens, provide an empty value for this property on the first request. |
| Order By | Specifies the sorting order of the returned users collection. You can sort ascending (default) or descending by 'givenName' and/or 'surname'. For descending order, append 'desc' after the property name, e.g., givenName desc,surname desc. |
Output
The output is an array of JSON objects representing users associated with the specified iModel. Each object contains user details as returned by the iModels API. If pagination is used, multiple calls may be needed to retrieve all users using the continuation token.
The node does not output binary data.
Dependencies
- Requires an API authentication credential for the iTwin Platform (an OAuth2 API key or similar).
- The node depends on the iTwin Platform iModels API.
- Proper configuration of the API credentials within n8n is necessary for successful execution.
Troubleshooting
- Common issues:
- Missing or invalid iModel ID will cause the operation to fail.
- Incorrect or expired API credentials will result in authentication errors.
- Improper use of continuation tokens (e.g., mixing with skip parameters) may lead to unexpected pagination behavior.
- Error messages:
"Unknown operation": Indicates that the specified operation is not recognized; ensure "Get iModel Users" is selected.- Authentication errors typically indicate invalid or missing API credentials.
- Pagination errors may occur if continuation tokens are malformed or misused; verify token usage according to the API documentation.
Links and References
- iTwin Platform Developer Documentation
- iModels API Reference (for detailed API query options and pagination)