Actions37
- Groups Actions
- Members Actions
- Roles Actions
- Permissions Actions
- Jobs Actions
- Shares Actions
- Actions Actions
- Users Actions
Overview
This node operation "Create iTwin Share" allows users to create a share for an iTwin project or resource. It is useful in scenarios where you want to grant access or share specific iTwin resources with others, optionally controlling the share contract and expiration time. For example, a user might create a share link to allow collaborators to view or interact with an iTwin model for a limited time.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iTwin resource to share. |
| Share Contract | The name of the share contract to use. If left empty, it defaults to "Default". |
| Expiration | The expiration date/time for the share. If left empty, it defaults to the maximum allowed by the contract. |
| Options | Additional options including: |
| - Custom Payload (enabled) | Whether to override the request body with a custom JSON payload. |
| - Custom Payload (payload) | The actual custom JSON payload to send to the API if enabled. |
Output
The output is a JSON object representing the result of the share creation operation. This typically includes details about the created share such as its ID, status, expiration, and any other metadata returned by the API. The node does not explicitly handle binary data output.
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 API credentials within n8n is necessary for successful execution.
Troubleshooting
Common issues:
- Missing or invalid ID parameter will cause the operation to fail.
- Incorrect or missing API authentication can lead to authorization errors.
- Providing an invalid share contract name may cause the API to reject the request.
- Malformed custom JSON payloads (if used) can cause parsing errors.
Error messages:
"Unknown operation": Indicates that the specified operation is not supported; ensure "create-itwin-share" is selected.- API errors related to authentication or permissions should be resolved by verifying the API key and user permissions.
- JSON parsing errors when using custom payloads require validating the JSON syntax.
Links and References
- iTwin Developer Documentation
- Refer to the official iTwin API docs for detailed information on share contracts and expiration policies.