ZitadelInstall

Overview

This node integrates with the Zitadel API, allowing users to perform various operations across multiple Zitadel services. Specifically, for the addOTPSMS operation under the "Default" resource (mapped here as part of the UserService), it enables sending or adding an OTP (One-Time Password) via SMS to a user identified by their user ID.

Common scenarios where this node is beneficial include:

• Automating user verification flows by sending OTPs via SMS.
• Integrating multi-factor authentication (MFA) steps into workflows.
• Managing user authentication and security processes programmatically.

For example, you could use this node in a workflow that triggers when a new user registers, automatically sending them an OTP SMS for verification.

Properties

Output

The node outputs a JSON object representing the response from the Zitadel API for the invoked operation. For the addOTPSMS operation, this typically includes confirmation details about the OTP SMS request, such as status or any metadata returned by the API.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "json": {
    // Response fields from Zitadel's addOTPSMS API call
  }
}

Dependencies

• Requires an API authentication token credential for Zitadel (referred generically as an API key credential).
• 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 credentials: Ensure the Zitadel API token is correctly configured in n8n credentials.
• Incorrect userId: The userId must be valid and correspond to an existing user in Zitadel; otherwise, the API call may fail.
• Operation not found: Selecting an unsupported operation or service combination will result in no action; verify the selected service and operation are compatible.
• JSON parsing errors: Input parameters that expect JSON strings must be properly formatted; otherwise, the node falls back to treating them as plain strings, which might cause API errors.

Links and References

• Zitadel Official Documentation
• Zitadel API Reference
• n8n Documentation on Creating Custom Nodes