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. Specifically, for the removeOTPEmail operation under the "Default" resource, it interacts with the UserService to remove a user's OTP (One-Time Password) email configuration. This is useful in scenarios where an administrator or system needs to revoke or reset a user's multi-factor authentication email setup.

Practical examples include:

  • Removing OTP email settings when a user leaves an organization.
  • Resetting a user's two-factor authentication method as part of a security policy update.
  • Automating user management workflows that require disabling OTP email-based authentication.

Properties

Name Meaning
Service The Zitadel service to interact with. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. For this operation, use UserService.
userId The unique identifier of the user whose OTP email should be removed. Required for the removeOTPEmail operation under UserService.

Output

The node outputs a JSON object representing the response from the Zitadel API after attempting to remove the OTP email for the specified user. The exact structure depends on the Zitadel API's response schema for this operation but generally includes confirmation of success or details about the updated user state.

No binary data output is produced by this operation.

Example output JSON structure (simplified):

{
  "result": {
    "userId": "string",
    "otpEmailRemoved": true,
    "message": "OTP email successfully removed"
  }
}

Dependencies

  • Requires an API authentication token credential for Zitadel (referred generically as an API key or personal access token).
  • The node uses gRPC clients generated from Zitadel's protobuf definitions to communicate with the Zitadel API endpoint at https://zitadel.studentcouncil.dk.
  • No additional external dependencies beyond the Zitadel API and its authentication are required.

Troubleshooting

  • Common issues:

    • Invalid or missing API authentication token will cause authorization failures.
    • Providing an incorrect or non-existent userId may result in errors indicating the user was not found.
    • Network connectivity issues to the Zitadel API endpoint can cause request timeouts or failures.
  • Error messages and resolutions:

    • "Unauthorized" or "Invalid token": Verify that the API token credential is correctly configured and has sufficient permissions.
    • "User not found": Confirm that the userId parameter is correct and corresponds to an existing user.
    • "Operation not supported": Ensure the selected service is UserService and the operation is removeOTPEmail.
    • JSON parsing errors for input parameters: Make sure all inputs are provided in the expected format; the node attempts to parse JSON strings but falls back to raw strings if parsing fails.

Links and References

Discussion