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 user identified by their user ID.

Common scenarios where this node is beneficial include:

  • Automating user verification processes by sending OTPs for two-factor authentication.
  • Triggering OTP delivery during password resets or sensitive account changes.
  • Integrating Zitadel's identity management features into custom workflows without manual intervention.

Example: A workflow that triggers when a user requests an OTP, uses this node to send the OTP SMS through Zitadel’s UserService, and then proceeds based on the success of the message delivery.

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 containing the response from the Zitadel API corresponding to the invoked operation. For the addOTPSMS operation, the output JSON typically includes details about the OTP SMS request status, such as confirmation of message dispatch or any error information returned by the API.

No binary data output is produced by this node.

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 userId: If the userId does not exist or is malformed, the API may return an error indicating the user was not found.
  • Operation not supported: Selecting an operation not available in the chosen service will result in no action or empty output.
  • JSON parsing errors: Input parameters are parsed as JSON if possible; invalid JSON strings will cause failures. Make sure inputs like queries or complex parameters are valid JSON.

Links and References

Discussion