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 createPasskeyRegistrationLink operation under the UserService resource, it creates a passkey registration link for a user.

Common scenarios where this node is beneficial include automating user management workflows, generating secure passkey registration links for users, and integrating Zitadel's identity and access management features into n8n workflows. For example, an organization could use this node to programmatically generate and send passkey registration links to new users during onboarding.

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 passkey registration link. (Required for the specified operation)
returnCode A string parameter that may specify a code or flag related to the response or processing of the passkey registration link creation. (Required for the specified operation)

Output

The node outputs a JSON object containing the response from the Zitadel API corresponding to the invoked operation. For createPasskeyRegistrationLink, the output JSON will include details about the created passkey registration link, such as the link URL and any associated metadata returned by the API.

If the node supports binary data output, it is not evident from the provided code snippet; thus, the output primarily consists of JSON data representing the API response.

Dependencies

  • Requires an API authentication token (Personal Access Token) for Zitadel, which must be configured in the node credentials.
  • Connects to the Zitadel API endpoint at https://zitadel.studentcouncil.dk.
  • Uses gRPC clients generated from Zitadel protobuf definitions to communicate with the API.
  • The node depends on the nice-grpc library for gRPC communication and interceptors for authorization.

Troubleshooting

  • Common Issues:

    • Missing or invalid API authentication token will cause authorization failures.
    • Incorrect or missing required parameters (userId, sendLink, returnCode) for the createPasskeyRegistrationLink operation can lead to errors or unexpected results.
    • JSON parsing errors if input parameters are expected to be JSON but are malformed.
  • Error Messages:

    • Authorization errors typically indicate issues with the API token; ensure the token is valid and has sufficient permissions.
    • Validation errors from the API may indicate missing or invalid fields; verify all required properties are correctly set.
    • Network or connectivity errors suggest problems reaching the Zitadel API endpoint; check network settings and endpoint availability.

Links and References

Discussion