Infomaniak Core Ressource icon

Infomaniak Core Ressource

Interact with Infomaniak Core Ressource API

Actions73

User Management → Invite A User

AI-generated

Summary

Invite a user to an Infomaniak account by providing required identity, role, and locale details.

Inputs

  • authentication — Authentication method to use for the API request. Defaults to OAuth2 if not specified. Options: OAuth2, API Key.
  • path_account (required) — Unique identifier of the Account to which the user will be invited.
  • body_email (required) — The email address of the user being invited.
  • body_first_name (required) — The first name of the user being invited.
  • body_last_name (required) — The last name of the user being invited.
  • body_locale (required) — The locale code for the language of the invitation the user will receive. Options: de_DE, en_GB, es_ES, fr_FR, it_IT.
  • body_role_type (required) — The role to assign to the user upon invitation. Options: admin, normal, owner.
  • queryParameters — Allows loading additional data about a resource, which may include related resources. Optional parameter 'query_with' accepts a string value.
  • bodyParameters — Additional user configuration. Sub-options include: body_notifications (json), body_permissions (json), body_silent (boolean, default false), body_strict (boolean, default false), body_teams (json).
  • returnFullResponse — If true, the full API response will be returned instead of just the parsed result. Defaults to false.

Output shape

Returns the invitation result. When returnFullResponse is enabled, the complete API response body is included; otherwise, the operation returns a standard success/failure indicator.

The node invokes the Infomaniak API via the infomaniakApiRequest helper to create the user invitation. Exact endpoint and request method are handled internally by the node's execute function.

Links

Discussion