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 createPasskeyRegistrationLink operation under the UserService resource, it creates a registration link for passkey authentication associated with a user. This is useful in scenarios where you want to enable passwordless login or multi-factor authentication by generating a secure link that users can use to register their passkeys.

Practical examples include:

  • Automating the creation of passkey registration links for new users during onboarding.
  • Sending registration links via email or other communication channels to existing users to enhance security.
  • Integrating passkey registration into custom workflows or identity management systems.

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 for whom the passkey registration link will be created. Required when Service is UserService and Operation is createPasskeyRegistrationLink.
sendLink A string parameter likely indicating whether or how to send the generated registration link (e.g., via email). Required for the specified operation.
returnCode A string parameter possibly used to specify or receive a status or code related to the registration link creation process. Required for the specified operation.

Output

The node outputs a JSON object containing the response from the Zitadel API for the requested operation. For createPasskeyRegistrationLink, this typically includes details about the generated registration link, status codes, or any relevant metadata returned by the API.

If the operation succeeds, the output JSON will contain the data structure returned by the Zitadel service method invoked. If the operation is not recognized or fails, an empty JSON object is returned.

The node does not explicitly handle binary data output.

Dependencies

  • Requires an API key credential for authenticating with the Zitadel API (referred generically as "an API key credential").
  • Uses the nice-grpc library internally to communicate with Zitadel's gRPC services.
  • The base URL for the Zitadel API is set to https://zitadel.studentcouncil.dk.
  • The node expects the Zitadel API credentials to be configured within n8n.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Incorrect or missing required parameters (userId, sendLink, returnCode) for the createPasskeyRegistrationLink operation may result in errors or unexpected behavior.
    • JSON parsing errors if input parameters are expected to be JSON but are provided as malformed strings.
  • Error messages:

    • Authorization errors typically indicate problems with the API key or token.
    • Validation errors from the Zitadel API may occur if required fields are missing or incorrectly formatted.
  • Resolutions:

    • Ensure the API key credential is correctly set up and has sufficient permissions.
    • Verify all required parameters are provided and correctly formatted.
    • Use valid JSON strings for parameters expected to be JSON; otherwise, provide plain strings as appropriate.

Links and References

Discussion