iTwin Users & Access Control icon

iTwin Users & Access Control

Comprehensive iTwin Users and Access Control API

Actions37

Overview

This node updates a member of an iTwin group by modifying their assigned roles. It is useful in scenarios where you need to manage access control within an iTwin project, such as changing the permissions or responsibilities of a user within a specific group. For example, if a team member's role changes from viewer to editor, this node can update their group membership accordingly.

Properties

Name Meaning
ID The unique identifier of the member to update.
Group ID The unique identifier of the iTwin group containing the member.
Role Ids A JSON array listing the role IDs to assign to the member within the group.
Options Additional optional settings:
- Custom Payload Allows overriding the request body with a custom JSON payload for advanced use cases.

Output

The node outputs JSON data representing the result of the update operation. This typically includes confirmation details about the updated member and their new roles. If a custom payload is used, the output reflects the API response based on that payload.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Users & Access Control API.
  • The node depends on the iTwin OAuth2 authentication mechanism configured in n8n.
  • Internet connectivity to reach the iTwin API endpoints.

Troubleshooting

  • Common Issues:

    • Invalid or missing member ID or group ID will cause the update to fail.
    • Incorrectly formatted roleIds JSON array may lead to request errors.
    • Insufficient permissions in the API credentials can prevent successful updates.

  • Error Messages:

    • "Unknown operation": Indicates the specified operation is not supported; ensure "Update iTwin group member" is selected.
    • API errors related to authorization or invalid input will be returned from the iTwin API and surfaced in the node output.

  • Resolution Tips:

    • Verify all required fields are correctly filled.
    • Ensure the roleIds property contains a valid JSON array of role identifiers.
    • Confirm that the API credentials have sufficient privileges to modify group members.

Links and References

  • iTwin Developer Documentation
  • Refer to the official iTwin Users & Access Control API docs for detailed information on roles and group management.

Discussion