iTwin Users & Access Control icon

iTwin Users & Access Control

Comprehensive iTwin Users and Access Control API

Actions37

Overview

This node updates an existing iTwin group by modifying its properties such as name, description, members, and IMS groups. It is useful in scenarios where you need to manage access control dynamically within the iTwin platform, for example, updating group membership or changing group details programmatically as part of an automation workflow.

Practical examples include:

  • Automatically adding or removing users from a group based on external triggers.
  • Updating group descriptions or names to reflect organizational changes.
  • Synchronizing IMS groups with iTwin groups for consistent access management.

Properties

Name Meaning
ID The unique identifier of the resource context (likely the iTwin or project ID).
Group ID The unique identifier of the group to update.
Name The new name for the group.
Description A textual description of the group.
Members JSON array listing users assigned to the group (max 50 users).
Ims Groups JSON array listing IMS groups assigned to the group (max 50 IMS groups).
Options Additional options including:
  Custom Payload Allows overriding the request body with a custom JSON payload instead of using standard fields.

Output

The node outputs JSON data representing the updated group object returned by the iTwin API after the update operation. This typically includes the group's current state with all updated properties.

No binary data output is indicated.

Dependencies

  • Requires an API authentication credential for the iTwin platform (an OAuth2 token or similar).
  • Depends on the iTwin Users & Access Control API.
  • The node internally uses an interpreter class (UsersOpenApiInterpreter) to map operations and execute API calls.

Troubleshooting

  • Common issues:

    • Invalid or missing ID or Group ID parameters will cause the update to fail.
    • Providing malformed JSON in Members or Ims Groups fields can cause parsing errors.
    • Exceeding the maximum allowed size (50) for members or IMS groups may result in API errors.
    • Using the "Custom Payload" option incorrectly (e.g., invalid JSON) can lead to request failures.

  • Error messages:

    • "Unknown operation: update-itwin-group" indicates the operation parameter was not recognized.
    • API errors related to authorization usually mean the API key or token is invalid or expired.
    • JSON parsing errors suggest that the input for members, imsGroups, or custom payload is not valid JSON.

  • Resolutions:

    • Ensure all required IDs are correctly set.
    • Validate JSON inputs before running the node.
    • Refresh or reconfigure API credentials if authorization fails.
    • Use the "Custom Payload" only if you fully understand the API's expected request format.

Links and References

Discussion