Zitadel icon

Zitadel

Interact with the Zitadel API

Overview

This node integrates with the Zitadel API, a platform for identity and access management. Specifically, the verifyEmail operation under the default resource (which corresponds to the "UserService") allows verifying a user's email address by submitting a user ID and a verification code.

Common scenarios where this node is useful include:

  • Automating user email verification workflows in applications that use Zitadel for authentication.
  • Integrating email verification steps into onboarding processes or user management pipelines.
  • Validating users' email addresses programmatically as part of security or compliance checks.

For example, after a user registers on a platform, you can use this node 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. For this operation, must be "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, used to confirm ownership. Required when Service is "UserService" and Operation is "verifyEmail".

Output

The output JSON contains the response from the Zitadel API's verifyEmail method. This typically includes confirmation details about the verification status. The exact structure depends on the Zitadel API response but generally confirms whether the email verification was successful.

No binary data output is produced by this node.

Example output JSON snippet:

{
  "result": {
    "verified": true,
    "userId": "example-user-id"
  }
}

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 credentials: Ensure the Zitadel API token is correctly set up in n8n credentials; otherwise, authorization will fail.
  • Incorrect userId or verificationCode: Double-check these inputs as invalid values will cause the verification to fail.
  • Operation not found: If the selected operation does not exist for the chosen service, the node returns empty JSON. Verify that "UserService" is selected for the verifyEmail operation.
  • JSON parsing errors: Input parameters are parsed as JSON if possible; malformed JSON strings may cause errors. Provide plain strings for simple fields like userId and verificationCode.

Links and References

Discussion