Zitadel icon

Zitadel

Interact with the Zitadel API

Overview

This node integrates with the Zitadel API to perform various operations across multiple services such as UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, and UserSchemaService. Specifically, for the verifyEmail operation under the UserService resource, it verifies a user's email address using a user ID and a verification code.

Common scenarios where this node is beneficial include:

  • Automating user email verification workflows in identity management systems.
  • Integrating Zitadel's user verification into custom automation pipelines.
  • Validating user emails during onboarding or registration processes.

Practical example:

  • After a user registers on a platform, this node can be used to verify their email by providing the user ID and the verification code they received via email.

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 whose email is to be verified. Required when Service is UserService and Operation is verifyEmail.
verificationCode The verification code sent to the user's email that needs to be validated. Required when Service is UserService and Operation is verifyEmail.

Output

The node outputs the response from the Zitadel API call as JSON data. This output contains the result of the verifyEmail operation, which typically includes confirmation of whether the email verification was successful or any related status information.

No binary data output is produced by this node.

Example output structure (simplified):

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

Dependencies

  • Requires an API authentication token (Personal Access Token) for Zitadel, provided via node 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 credentials: Ensure that a valid API authentication token is configured in the node credentials; otherwise, authorization errors will occur.
  • Incorrect userId or verificationCode: Providing wrong values may cause the verification to fail or return errors. Double-check these inputs.
  • Operation not supported: If an unsupported operation is selected for a given service, the node returns empty JSON without error. Verify that the operation exists for the chosen service.
  • JSON parsing errors: Input parameters are parsed as JSON if possible. Malformed JSON strings in inputs may cause failures. Provide plain strings for simple values like userId and verificationCode.

Links and References

Discussion