Zitadel icon

Zitadel

Interact with the Zitadel API

Overview

This node integrates with the Zitadel API, allowing users to perform various operations across multiple Zitadel services. Specifically, for the createInviteCode operation under the default resource, it enables creating an invite code related to user management. This can be useful in scenarios where you want to programmatically generate invitation codes for users within an organization or system managed by Zitadel.

Practical examples include:

  • Automatically generating invite codes for new users during onboarding.
  • Sending invite codes via email or other communication channels.
  • Managing user access and invitations in automated workflows.

Properties

Name Meaning
Service The Zitadel service to interact with. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. Default is UserService.
userId The identifier of the user for whom the invite code will be created. Required when Service is UserService and Operation is createInviteCode.
sendCode A string parameter likely indicating whether or how to send the generated invite code. Required for createInviteCode operation under UserService.
returnCode A string parameter that probably controls if the invite code should be returned in the response. Required for createInviteCode operation under UserService.

Output

The node outputs a JSON object containing the response from the Zitadel API corresponding to the invoked operation. For createInviteCode, this JSON will include details about the newly created invite code, such as the code itself and any associated metadata.

If the operation involves binary data (not indicated here), the node would output it accordingly, but for this operation, only JSON output is expected.

Dependencies

  • Requires an API authentication token (Personal Access Token) for Zitadel, provided via node credentials.
  • Connects to the Zitadel API endpoint at https://zitadel.studentcouncil.dk.
  • Uses gRPC client libraries internally to communicate with Zitadel services.

Troubleshooting

  • Invalid or missing API token: Ensure the API key credential is correctly configured in n8n; otherwise, authorization errors will occur.
  • Incorrect property values: Passing malformed JSON strings or incorrect parameters may cause request failures. Verify input formats, especially for properties parsed as JSON.
  • Operation not found: Selecting an unsupported operation for the chosen service will result in no action. Confirm the operation name matches those supported by the selected service.
  • Network issues: Connectivity problems to the Zitadel API endpoint will prevent successful execution.

Links and References

Discussion