Actions28
- Action Actions
- Country Actions
- Event Actions
- Language Actions
- Product Actions
- Profile Actions
- Task Actions
- Timezone Actions
- User Management Actions
- kSuite Actions
Overview
This node operation allows you to invite a new user to an existing account within the User Management resource of the Infomaniak API. It is useful in scenarios where you want to programmatically add users to your organization's account, assign them roles, and optionally configure their team memberships, permissions, and notification settings.
Typical use cases include:
- Automating onboarding workflows by sending invitations to new employees or collaborators.
- Managing user access and roles centrally via automation.
- Integrating user invitation processes into larger business workflows.
For example, you can invite a user with the email "john.doe@example.com" as an Admin role to a specific account, optionally adding them to certain teams and configuring their permissions.
Properties
| Name | Meaning |
|---|---|
| Account ID | The identifier of the account to which the user will be invited (required). |
| Email address of the user to invite (required). | |
| First Name | First name of the user to invite (required). |
| Last Name | Last name of the user to invite (required). |
| Locale | Language/locale for the invitation. Options: French (France), English (UK), German (Germany), Italian (Italy), Spanish (Spain) (required). |
| Role Type | Role type assigned to the invited user. Options: Owner, Admin, Normal User (required). |
| Additional Options | A collection of optional parameters: |
| - Silent | Boolean indicating whether the invitation email should be sent (true = no email sent). |
| - Strict | Boolean indicating if the user must register with the same email address (true/false). |
| - Teams | Comma-separated list of team IDs to add the user to upon invitation. |
| - Notifications | JSON object configuring notifications for the user. |
| - Permissions | JSON object configuring permissions for the user. |
Output
The output is a JSON array containing the response data from the API after attempting to invite the user. On success, it includes details about the created invitation or invited user.
If the invitation fails, an error is thrown with a descriptive message.
No binary data output is produced by this operation.
Dependencies
- Requires an API authentication token credential for the Infomaniak API.
- The node makes HTTP requests to the Infomaniak API endpoints.
- Proper network connectivity to
https://api.infomaniak.comis required.
Troubleshooting
- Missing Required Parameters: The node validates that Account ID, Email, First Name, and Last Name are provided and non-empty. If any are missing, it throws an error.
- Invalid Email Format: The email parameter is validated against a basic email regex pattern. Invalid formats cause an error.
- JSON Parsing Errors: If the Notifications or Permissions options are provided as strings, they must be valid JSON. Otherwise, an error is thrown.
- API Errors (422 status): If the API returns a 422 Unprocessable Entity error (e.g., duplicate invitation or invalid data), the node surfaces this with details including the Account ID and Email.
- General API Failures: Other failures to invite the user result in a generic error message indicating failure.
To resolve errors:
- Ensure all required fields are correctly filled.
- Validate JSON inputs for Notifications and Permissions.
- Check API credentials and network connectivity.
- Review API error messages for specific issues.
Links and References
- Infomaniak API Documentation (general reference)
- User Management API - Invitations (for detailed API endpoint info)
This summary is based on static analysis of the node's source code and input property definitions for the "User Management" resource and "Invite User" operation.