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, for the removeTOTP operation under the default resource, it removes a user's Time-based One-Time Password (TOTP) configuration, effectively disabling their two-factor authentication setup.

Common scenarios where this node is beneficial include:

  • Administrators needing to reset or disable 2FA for a user who lost access to their authenticator app.
  • Automated workflows that manage user security settings based on certain triggers.
  • Integration with identity management systems to maintain user authentication states.

Example use case: An admin wants to programmatically remove TOTP for a user identified by their user ID when they request 2FA reset via a support ticket system.

Properties

Name Meaning
Service The Zitadel service to interact with. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. For removeTOTP, must be UserService.
userId The unique identifier of the user whose TOTP configuration will be removed. Required when Service is UserService and Operation is removeTOTP.

Output

The node outputs a JSON object representing the response from the Zitadel API after attempting to remove the TOTP for the specified user. This typically includes confirmation of the action or any relevant status information returned by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API authentication token credential for Zitadel (referred generically as an API key credential).
  • Connects to the Zitadel API endpoint at https://zitadel.studentcouncil.dk.
  • Uses gRPC client libraries internally to communicate with Zitadel services.

Troubleshooting

  • Common issues:

    • Invalid or missing user ID: Ensure the userId property is correctly set and corresponds to an existing user.
    • Insufficient permissions: The API token used must have rights to modify user authentication settings.
    • Network or connectivity problems: Verify that the node can reach the Zitadel API endpoint.
  • Error messages:

    • Authorization errors likely indicate invalid or expired API credentials.
    • "Method not found" or similar errors may occur if the selected service or operation does not match the expected API method.
    • JSON parsing errors can happen if input parameters are malformed; ensure inputs are valid JSON or plain strings as required.

Resolving these usually involves verifying credentials, input correctness, and network accessibility.

Links and References

Discussion