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 setPhone operation under the UserService resource, it allows updating a user's phone number along with related verification settings.

Common scenarios where this node is beneficial include:

  • Updating user contact information programmatically.
  • Managing user phone verification status within an automated workflow.
  • Triggering phone-related actions such as sending verification codes or handling return codes.

For example, you could use this node to update a user's phone number in Zitadel when they submit a form on your website, optionally sending a verification code and marking the phone as verified or not.

Properties

Name Meaning
Service The Zitadel service to interact with. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. For this operation, select "UserService".
userId The unique identifier of the user whose phone number you want to set.
phone The new phone number to assign to the user.
sendCode A string indicating whether to send a verification code to the new phone number.
returnCode A string representing a code that might be returned or used during the phone setting process.
isVerified A string indicating whether the phone number should be marked as verified ("true" or "false").

Output

The node outputs a JSON object containing the response from the Zitadel API corresponding to the setPhone operation. This typically includes details about the updated user phone information and any relevant status or confirmation data returned by the API.

No binary data output is produced by this node.

Dependencies

  • Requires an API authentication token (Personal Access Token) for Zitadel, which must be 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 API token: Ensure the Zitadel API token is correctly configured in the node credentials; otherwise, authorization errors will occur.
  • Incorrect userId or phone format: Verify that the userId exists and the phone number is in a valid format accepted by Zitadel.
  • JSON parsing errors: Input properties are parsed as JSON if possible; ensure strings like sendCode, returnCode, and isVerified are properly formatted or simple strings to avoid parsing failures.
  • Operation not found: If the selected operation does not exist in the chosen service, the node returns an empty JSON object. Double-check the service and operation names.

Links and References

Discussion