Zitadel icon

Zitadel

Interact with the Zitadel API

Actions42

setEmail

AI-generated

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 a user's email address and related verification settings within the UserService. This is useful in scenarios where user contact information needs to be programmatically updated or verified, such as during user onboarding, profile updates, or email verification workflows.

Practical examples include:

  • Automatically updating a user's email after they submit a change request.
  • Triggering an email verification process by setting flags and codes.
  • Managing user identity data in bulk from external systems.

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 being set or updated.
email The new email address to assign to the user.
sendCode A code indicating whether to send a verification code to the new email (likely a boolean or string flag).
returnCode A code expected to be returned or used in the verification process (purpose depends on API specifics).
isVerified A flag indicating whether the email should be marked as verified (likely a boolean or string flag).

Output

The node outputs a JSON object representing the response from the Zitadel API after performing the setEmail operation. This typically includes confirmation of the update, status of the email verification, and any relevant metadata returned by the API.

No binary data output is involved.

Example output structure (simplified):

{
  "userId": "string",
  "email": "string",
  "isVerified": true,
  "sendCode": "string",
  "returnCode": "string",
  "status": "success"
}

Dependencies

  • Requires an API authentication token credential for Zitadel (referred generically as an API key or token).
  • Uses the Zitadel gRPC client libraries bundled with the node.
  • Needs network access to the Zitadel API endpoint at https://zitadel.studentcouncil.dk.

Troubleshooting

  • Invalid Credentials: If the API token is missing or invalid, the node will fail to authenticate. Ensure the correct API key/token is configured in n8n credentials.
  • Incorrect Property Values: Passing malformed JSON or incorrect types for properties like sendCode, returnCode, or isVerified may cause errors. Make sure these are correctly formatted strings or booleans as expected by the API.
  • Operation Not Found: Selecting an unsupported operation or service combination will result in no action. Verify that the service is set to UserService and operation to setEmail.
  • Network Issues: Connectivity problems to the Zitadel API endpoint will cause timeouts or connection errors. Check network/firewall settings.

Links and References

Discussion