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 addOTPEmail operation under the "Default" resource, it enables adding a One-Time Password (OTP) email to a user by specifying the user ID and service.

Common scenarios include automating user management tasks like adding OTP emails for multi-factor authentication setup, managing organizational data, or performing administrative actions programmatically within Zitadel.

Practical example: Automatically add an OTP email address to a user account after registration to enable two-factor authentication without manual intervention.

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 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 produced by this node.

Example output structure (simplified):

{
  "json": {
    // Response fields from Zitadel's addOTPEmail operation, e.g.:
    "userId": "string",
    "otpEmailAdded": true,
    "message": "OTP email successfully added"
  }
}

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

  • Authentication errors: Ensure the API token credential is valid and has sufficient permissions.
  • Invalid parameters: Verify that required parameters like userId are provided and correctly formatted.
  • Operation not found: Confirm that the selected operation exists for the chosen service.
  • JSON parsing errors: Input parameters that expect JSON must be valid JSON strings; otherwise, the node falls back to treating them as plain strings.
  • Network issues: Check connectivity to the Zitadel API endpoint.

Links and References

Discussion