Actions37
- Groups Actions
- Members Actions
- Roles Actions
- Permissions Actions
- Jobs Actions
- Shares Actions
- Actions Actions
- Users Actions
Overview
This node operation "Add iTwin group members" allows users to add multiple members to a specified iTwin group by providing the group's ID and a list of members. It is useful in scenarios where you need to programmatically manage access control by updating group memberships within the iTwin platform, such as automating user onboarding or synchronizing group membership with external systems.
Practical examples include:
- Adding a batch of new users to a project team group.
- Automating group membership updates based on organizational changes.
- Integrating with HR systems to reflect current team compositions in iTwin groups.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iTwin group to which members will be added. |
| Members | A JSON array representing the list of group members to add. Each member should be defined according to the API's expected format. |
| Options | Additional optional settings: |
| Custom Payload | Allows overriding the default request body with a custom JSON payload. Useful for advanced use cases requiring specific API request structures. |
Output
The node outputs an array of JSON objects representing the result of the add members operation. Each output item corresponds to the response from the API after attempting to add members to the specified group.
If the operation returns binary data (not indicated here), it would represent related files or attachments, but this node primarily deals with JSON responses reflecting success or failure of the membership addition.
Dependencies
- Requires an API key credential for authenticating with the iTwin platform's Users and Access Control API.
- The node depends on the iTwin OAuth2 authentication mechanism configured in n8n.
- Network connectivity to the iTwin API endpoints is necessary.
Troubleshooting
Common issues:
- Invalid or missing group ID can cause the API to reject the request.
- Malformed JSON in the "Members" property may lead to parsing errors.
- Insufficient permissions or expired API tokens can result in authorization failures.
Error messages:
"Unknown operation": Indicates the operation parameter is incorrect or unsupported.- API errors returned in the response JSON will be passed through; check the message for details.
Resolutions:
- Verify the group ID is correct and exists in the iTwin environment.
- Ensure the "Members" JSON is well-formed and matches the expected schema.
- Refresh or reconfigure API credentials if authorization errors occur.
- Use the "Custom Payload" option carefully to avoid malformed requests.
Links and References
- iTwin Developer Documentation
- iTwin Users and Access Control API Reference (general link; specific endpoint docs should be consulted there)