Zitadel icon

Zitadel

Interact with the Zitadel API

Overview

This node interacts with the Zitadel API to perform various operations across multiple services such as UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, and UserSchemaService. Specifically, for the resendPhoneCode operation under the UserService resource, it resends a phone verification code to a user.

Common scenarios where this node is beneficial include:

  • Resending a phone verification code when a user did not receive or lost the original code.
  • Automating user verification workflows in identity management systems.
  • Integrating phone-based authentication flows within custom automation pipelines.

Example: If a user requests a new phone verification code during signup or login, this node can be triggered to resend the code automatically.

Properties

Name Meaning
Service The Zitadel service to interact with. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. Default is UserService.
userId The unique identifier of the user to whom the phone code should be resent. (Required for resendPhoneCode operation in UserService)
sendCode The code or token that triggers sending the phone code. (Required for resendPhoneCode operation in UserService)
returnCode A string parameter likely used to specify if the code should be returned or how it should be handled. (Required for resendPhoneCode operation in UserService)

Output

The output is a JSON object containing the response from the Zitadel API corresponding to the invoked operation. For the resendPhoneCode operation, the JSON will typically include confirmation details about the resend action, such as success status or any relevant metadata returned by the API.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for Zitadel (referred generically as "an API key credential").
  • The node uses gRPC clients generated from Zitadel's protobuf definitions.
  • The base URL for the Zitadel API is set to https://zitadel.studentcouncil.dk.
  • The node internally creates an access token interceptor using the provided API key to authenticate requests.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential will cause authentication failures.
    • Incorrect or missing required parameters (userId, sendCode, returnCode) will result in errors or no action.
    • Network connectivity issues to the Zitadel API endpoint may cause request failures.
  • Error messages:

    • Authentication errors typically indicate invalid or expired API tokens; ensure the API key is valid and has necessary permissions.
    • Parameter validation errors suggest missing or malformed input properties; verify all required fields are correctly filled.
    • Unexpected API responses might require checking Zitadel service status or reviewing API usage limits.

Links and References

Discussion