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, the registerPasskey operation under the "Default" resource (mapped to the "UserService") enables registering a passkey for a user. This is useful in scenarios where passwordless authentication or multi-factor authentication using passkeys is implemented.

Practical examples include:

  • Registering a new passkey credential for a user to enable secure login without passwords.
  • Managing user authentication methods programmatically within an organization's identity management system.

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 is being registered.
code A code required for the passkey registration process, likely a verification or challenge code.
authenticator The authenticator string representing the passkey device or method to register.
domain The domain context under which the passkey registration applies.

Note: The last four properties (userId, code, authenticator, domain) are shown only when the selected Service is UserService and the Operation is registerPasskey.

Output

The node outputs the raw JSON response from the Zitadel API corresponding to the invoked operation. For registerPasskey, this will typically include confirmation details about the passkey registration status or any relevant metadata returned by the API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for Zitadel (referred generically as an API token).
  • The node uses gRPC clients generated from Zitadel's protobuf definitions to communicate with the Zitadel backend.
  • The base URL for the Zitadel API is hardcoded as https://zitadel.studentcouncil.dk.
  • The node expects the API token to be provided via n8n credentials named generically as Zitadel credentials.

Troubleshooting

  • Common issues:

    • Invalid or expired API token leading to authorization errors.
    • Incorrect or missing parameters such as userId, code, authenticator, or domain causing request failures.
    • Network connectivity issues to the Zitadel API endpoint.
  • Error messages:

    • Authorization errors indicating invalid or missing bearer token: Ensure the API token credential is correctly configured and valid.
    • Validation errors from the API if required fields are missing or malformed: Double-check input property values.
    • JSON parsing errors if input parameters are not properly formatted JSON strings or plain strings as expected.

Links and References


If you need further details on other operations or resources, please provide their names.

Discussion