iTwin iModels icon

iTwin iModels

Interact with iTwin Platform iModels API for managing iModels, changesets, named versions, and more

Actions54

Overview

This node interacts with the iTwin Platform's iModels API, specifically to update user permissions on an iModel. It allows users to modify access rights for different users on a given iModel by sending an array of user permission objects. This is useful in scenarios where you need to programmatically manage who can view or edit an iModel within your digital twin environment.

Practical examples include:

  • Automating permission updates when team members change roles.
  • Integrating permission management into CI/CD pipelines for infrastructure models.
  • Bulk updating user permissions based on external user management systems.

Properties

Name Meaning
ID The unique identifier of the iModel to update permissions for.
User Permissions An array of user permission objects defining the new permissions to apply to the iModel.
Options Additional options including:
- Custom Payload Allows overriding the request body with a custom JSON payload instead of the default one.

Details on "User Permissions"

  • Expected as a JSON array.
  • Each element represents a user's permission settings (structure depends on API requirements).

Details on "Options"

  • Custom Payload: If enabled, lets you provide a fully custom JSON payload to send to the API, bypassing the standard userPermissions array.

Output

The node outputs JSON data representing the response from the iModels API after attempting to update user permissions. The structure typically reflects the updated state or confirmation of the operation.

If the API returns binary data (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON responses.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Platform iModels API.
  • Needs the iTwinOAuth2Api credential configured in n8n for OAuth2 authentication.
  • Depends on the bundled IModelsOpenApiInterpreter module to interpret and execute API operations.

Troubleshooting

  • Common issues:
    • Invalid or missing iModel ID will cause the API call to fail.
    • Malformed user permissions JSON may result in request errors.
    • Insufficient permissions on the API key or OAuth token can lead to authorization errors.
  • Error messages:
    • "Unknown operation": Indicates the specified operation name is incorrect or unsupported.
    • API errors returned from the iTwin service will be passed through; check the error message for details.
  • Resolutions:
    • Verify the iModel ID is correct and exists.
    • Ensure the user permissions JSON is valid and matches expected schema.
    • Confirm that the API credentials have sufficient scopes/permissions.

Links and References

Discussion