iTwin Users & Access Control icon

iTwin Users & Access Control

Comprehensive iTwin Users and Access Control API

Overview

This node enables the deletion of a specific iTwin group within the "Groups" resource. It is useful in scenarios where you need to programmatically remove groups from an iTwin project or environment, such as cleaning up unused groups or managing access control dynamically.

For example, if you have a workflow that manages user permissions and groups, this node can be used to delete groups that are no longer needed based on certain conditions or triggers.

Properties

Name Meaning
ID The identifier of the iTwin instance or context in which the group exists.
Group ID The unique identifier of the group to be deleted within the specified iTwin instance.

Output

The output JSON contains the result of the delete operation. Typically, this will be a confirmation object or status indicating whether the group was successfully deleted. If the operation fails, the output may contain an error message describing the failure.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the iTwin platform.
  • The node depends on the iTwin Users & Access Control API.
  • Proper configuration of the OAuth2 authentication credentials is necessary to authorize the delete request.

Troubleshooting

  • Common issues:

    • Invalid or missing ID or Group ID parameters will cause the operation to fail.
    • Insufficient permissions or invalid API credentials can lead to authorization errors.
    • Attempting to delete a non-existent group will result in an error response from the API.
  • Error messages:

    • "Unknown operation": This indicates the operation parameter is incorrect or unsupported; ensure "delete-itwin-group" is selected.
    • Authorization errors typically indicate problems with the API key or OAuth token; verify credentials and permissions.
    • Network or API errors might occur due to connectivity issues or service downtime; retry or check service status.

Links and References

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

Discussion