Zitadel icon

Zitadel

Interact with the Zitadel API

Overview

This node integrates with the Zitadel API, allowing users to perform various operations on different Zitadel services. Specifically, for the setEmail operation under the default resource, it enables updating or setting a user's email address within the UserService. This can be useful in scenarios such as user account management, where an administrator or system needs to update a user's contact information programmatically.

Practical examples include:

  • Updating a user's email after they request a change.
  • Verifying a user's email by setting verification status.
  • Sending verification codes or handling email confirmation workflows.

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 email is being set or updated.
email The new email address to assign to the user.
sendCode A string indicating whether to send a verification code to the new email (likely a boolean as string).
returnCode A string indicating whether to return the verification code in the response (likely a boolean as string).
isVerified A string indicating whether the email should be marked as verified (likely a boolean as string).

Output

The output JSON contains the full response from the Zitadel UserService's setEmail method. This typically includes details about the email update operation, such as success status, any returned verification codes (if requested), and possibly updated user metadata.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "emailUpdateResponse": {
    "userId": "string",
    "email": "string",
    "isVerified": true,
    "verificationCode": "string"
  }
}

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 Credentials: If the API token is missing or invalid, the node will fail to authenticate. Ensure the correct API key credential is configured.
  • Invalid Parameters: Passing malformed JSON or incorrect parameter types (e.g., non-string where string expected) may cause errors. Verify input property values are correctly formatted.
  • Operation Not Found: Selecting an unsupported operation for the chosen service will result in no action. Confirm that setEmail is selected under UserService.
  • Network Issues: Connectivity problems to the Zitadel API endpoint will cause failures. Check network access and endpoint availability.

Links and References

Discussion