Actions37
- Groups Actions
- Members Actions
- Roles Actions
- Permissions Actions
- Jobs Actions
- Shares Actions
- Actions Actions
- Users Actions
Overview
This node operation allows you to create a new iTwin group within the iTwin platform. It is useful for managing user groups, organizing access control, and structuring permissions in an iTwin project or organization. For example, you might use this node to programmatically add a new team or department group with a specific name and description, enabling easier management of users and their roles.
Properties
| Name | Meaning |
|---|---|
| ID | A unique identifier string for the group to be created. |
| Name | The display name of the group. |
| Description | A textual description explaining the purpose or details of the group. |
| Options | Additional options including: |
| - Custom Payload | Allows overriding the default request body with a custom JSON payload for advanced use cases. |
Output
The output of this node is a JSON object representing the newly created iTwin group as returned by the API. This typically includes the group's properties such as its ID, name, description, and any other metadata provided by the iTwin service. If a custom payload is used, the output corresponds to the API response for that payload.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the iTwin platform.
- Needs proper configuration of the iTwin OAuth2 authentication credentials in n8n.
- Depends on the iTwin Users & Access Control API endpoint to create groups.
Troubleshooting
Common issues:
- Missing required fields (ID, Name, Description) will cause the API call to fail.
- Invalid or expired API credentials will result in authentication errors.
- Using an incorrect or malformed custom JSON payload can cause request failures.
Error messages:
"Unknown operation": Indicates the specified operation is not supported; ensure "create-itwin-group" is selected.- API errors related to authorization or validation will be passed through; check your credentials and input values.
Resolutions:
- Verify all required parameters are provided and correctly formatted.
- Ensure the API key or OAuth token is valid and has sufficient permissions.
- When using custom payloads, validate the JSON structure before sending.
Links and References
- iTwin Developer Documentation
- Refer to the iTwin Users & Access Control API docs for detailed information on group creation endpoints and payload structures.