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, for the addOTPSMS operation under the UserService resource, it enables sending a One-Time Password (OTP) via SMS to a specified user.

Common scenarios where this node is beneficial include:

  • Automating user verification by sending OTPs during login or registration flows.
  • Triggering OTP-based multi-factor authentication (MFA) processes.
  • Managing user-related actions programmatically within workflows that require secure user validation.

Practical example:

  • A workflow that triggers when a new user signs up, which then uses this node to send an OTP SMS to the user's phone number for verification purposes.

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 to whom the OTP SMS will be sent. Required when Service is UserService and Operation is addOTPSMS.

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 relevant metadata returned by the API.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "status": "success",
  "message": "OTP SMS sent",
  "userId": "string"
}

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 and has sufficient permissions.
  • Incorrect userId: Verify that the userId provided exists and is valid in the Zitadel system.
  • Operation not supported: If an unsupported operation or service is selected, the node returns an empty JSON object.
  • JSON parsing errors: Input parameters are parsed as JSON if possible; malformed JSON inputs may cause errors. Provide valid JSON strings or plain values accordingly.

Links and References

Discussion