Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation allows you to invite a new user to an existing account by specifying their email and role within that account. It is useful in scenarios where you need to programmatically add team members or collaborators to an account, assigning them appropriate permissions such as Admin, Accounting, or Employee roles. For example, a finance manager could automate inviting accounting staff to the company’s financial account system.

Properties

Name Meaning
Account Id Identifier of the account to which the user will be invited.
Email Email address of the user to invite to the account.
Role Role assigned to the invited user. Options: Admin, Accounting, Employee.
First Name (Optional) First name of the user being invited.
Last Name (Optional) Last name of the user being invited.

Output

The node outputs JSON data representing the result of the invitation request. This typically includes confirmation details about the invited user or the status of the invitation process. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating requests to the external service managing accounts.
  • The node sends HTTP requests with JSON payloads to the service's API endpoint configured via credentials.
  • Proper configuration of the base URL and authentication token in n8n credentials is necessary.

Troubleshooting

  • Common issues:
    • Invalid or missing Account Id can cause the invitation to fail.
    • Incorrect or malformed email addresses may lead to errors or rejected invitations.
    • Insufficient permissions associated with the API key might prevent user invitations.
  • Error messages:
    • "Account not found" indicates the provided Account Id does not exist or is inaccessible.
    • "Invalid email format" suggests the email property was not correctly formatted.
    • "Unauthorized" or "Forbidden" errors imply issues with API authentication or permission scopes.
  • Resolutions:
    • Verify the Account Id is correct and accessible.
    • Ensure the email address is valid and properly formatted.
    • Check that the API key has sufficient privileges to invite users.

Links and References

  • Refer to the external service’s API documentation for detailed information on user invitation endpoints and role definitions.
  • Consult n8n documentation on setting up API credentials and configuring HTTP request nodes for similar integrations.

Discussion