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 such as UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, and UserSchemaService. Specifically, the addOTPEmail operation under the "Default" resource (mapped here to the UserService) enables adding a One-Time Password (OTP) email for a user identified by their user ID.

Common scenarios where this node is beneficial include:

  • Automating user authentication workflows by adding OTP emails for multi-factor authentication.
  • Managing user contact methods programmatically within an organization's identity management system.
  • Integrating Zitadel's identity services into broader automation pipelines in n8n.

Practical example:

  • A workflow that triggers when a new user is created and automatically adds an OTP email to their account for enhanced security.

Properties

Name Meaning
Service The Zitadel service to interact with. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. Default is UserService.
userId The unique identifier of the user for whom the OTP email will be added. Required when Service is UserService and Operation is addOTPEmail.

Output

The node outputs a JSON object representing the response from the Zitadel API for the invoked operation. For the addOTPEmail operation, this typically includes confirmation details or status related to the addition of the OTP email to the specified user.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API authentication token (Personal Access Token) for Zitadel, configured in n8n 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 Zitadel API token credential is correctly set up in n8n; otherwise, authorization errors will occur.
  • Incorrect service or operation name: Selecting a service-operation combination not supported by the node will result in empty or error responses.
  • Malformed input parameters: Input fields expecting JSON strings must be valid JSON; otherwise, parsing errors may happen.
  • User ID not found: If the provided userId does not exist in Zitadel, the API will likely return an error indicating the user was not found.

Links and References

Discussion