ZitadelInstall

Overview

This node provides an interface to interact with the Zitadel API, a platform for identity and access management. It supports multiple services such as UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, and UserSchemaService. The node allows performing various operations defined by these services.

Specifically, the registerTOTP operation under the "Default" resource (mapped here to UserService) enables registering a Time-based One-Time Password (TOTP) for a user. This is typically used to set up two-factor authentication (2FA) for enhanced security on user accounts.

Common scenarios:

• Automating the setup of 2FA for users in an organization.
• Integrating user security workflows into custom automation pipelines.
• Managing user authentication methods programmatically.

Example:
You can use this node to register TOTP for a user by specifying the service as UserService and providing the userId. The node will call the corresponding Zitadel API method to initiate TOTP registration.

Properties

Output

The node outputs the JSON response returned by the Zitadel API for the invoked operation. For registerTOTP, this typically includes details about the TOTP registration process, such as provisioning information or status.

The output structure is:

{
  "json": {
    // Response object from Zitadel's registerTOTP API call
  }
}

No binary data output is produced by this node.

Dependencies

• Requires an API authentication token credential for Zitadel (referred generically as an API key credential).
• The node uses the Zitadel gRPC client libraries internally to communicate with the Zitadel API endpoint at https://zitadel.studentcouncil.dk.
• No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

• Invalid or missing credentials: Ensure that a valid API authentication token is configured in the node credentials.
• Incorrect service or operation selection: Verify that the selected service supports the requested operation (registerTOTP is supported only by UserService).
• Malformed input parameters: The userId must be a valid string identifying an existing user; otherwise, the API may return errors.
• API connectivity issues: Check network connectivity to the Zitadel API endpoint and ensure no firewall or proxy blocks the requests.
• JSON parsing errors: Input parameters are parsed as JSON if possible; invalid JSON strings will fallback to raw strings but may cause unexpected behavior.

Links and References

• Zitadel Official Documentation
• Zitadel API Reference
• Time-based One-Time Password (TOTP) Wikipedia