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 details about a user associated with an iModel. It is useful in scenarios where you need to fetch information about a particular user within an iModel context, such as auditing user activity, managing permissions, or integrating user data into workflows.
For example, you might use this node to get detailed information about a user who has access to a specific iModel, enabling automated reporting or synchronization of user data with other systems.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel for which the user details are requested. |
| User ID | The unique identifier of the user whose details you want to retrieve. |
Output
The output is a JSON object containing the details of the specified user within the given iModel. The exact structure depends on the iModels API response but typically includes user attributes such as name, email, roles, and other metadata related to the user's association with the iModel.
No binary data output is indicated by the source code.
Dependencies
- Requires an API key credential for authenticating with the iTwin Platform iModels API.
- The node depends on the
IModelsOpenApiInterpretermodule internally to map and execute the API operations. - Proper configuration of OAuth2 credentials for the iTwin Platform is necessary.
Troubleshooting
Common issues:
- Invalid or missing iModel ID or User ID parameters will cause the operation to fail.
- Authentication errors if the API key or OAuth2 token is not configured correctly.
- Network or API availability issues may result in request failures.
Error messages:
"Unknown operation: <operation>": This indicates that the specified operation is not recognized by the node. Ensure the operation name matches exactly.- Errors returned from the API will be included in the output JSON under an
errorfield if "Continue On Fail" is enabled.
Resolution tips:
- Double-check the input parameters for correctness.
- Verify that the API credentials are valid and have sufficient permissions.
- Enable "Continue On Fail" to handle errors gracefully in workflows.
Links and References
- iTwin Platform Developer Documentation
- iModels API Reference (general reference)