Zitadel icon

Zitadel

Interact with the Zitadel API

Overview

This node integrates with the Zitadel API, allowing users to perform various operations across multiple Zitadel services. Specifically, for the verifyPhone operation under the default resource, it verifies a user's phone number by submitting a verification code associated with that user.

Common scenarios where this node is beneficial include:

  • Automating user phone verification workflows in identity management systems.
  • Integrating phone verification as part of user onboarding or authentication processes.
  • Validating user contact information programmatically within larger automation pipelines.

For example, you might use this node to verify a phone number after a user receives a verification code via SMS, ensuring the phone number is confirmed before granting access or completing registration.

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 is being verified.
verificationCode The verification code sent to the user's phone that must be provided to confirm the phone number.

Output

The node outputs a JSON object containing the response from the Zitadel API's verifyPhone method. This typically includes confirmation details about the verification status of the user's phone number.

The output structure is:

{
  // Response fields depend on Zitadel's verifyPhone API response schema
}

No binary data output is involved in this operation.

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 verification code: If the verification code is incorrect or expired, the API will reject the request. Ensure the code is accurate and has not timed out.
  • Incorrect userId: Providing an invalid or non-existent user ID will cause the operation to fail. Verify the user ID is correct.
  • Authentication errors: Missing or invalid API tokens will prevent successful calls. Confirm that the API key credential is properly set up in n8n.
  • Network issues: Connectivity problems to the Zitadel endpoint can cause timeouts or failures. Check network access and endpoint availability.

Error messages returned by the Zitadel API should be reviewed to identify specific causes, such as permission issues or malformed requests.

Links and References

Discussion