Zitadel icon

Zitadel

Interact with the Zitadel API

removeTOTP

AI-generated

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 UserService 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 or compliance requirements.

Practical example:

  • An admin workflow that, upon receiving a support ticket about 2FA issues, automatically calls this node to remove the TOTP for the specified user, allowing them to reconfigure 2FA.

Properties

Name Meaning
Service The Zitadel service to interact with. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. For this operation, select "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. The exact structure depends on the Zitadel API's response schema for this operation but generally includes confirmation of success or details of any errors.

No binary data output is produced by this node.

Example output JSON structure (simplified):

{
  "result": "success",
  "userId": "string",
  "message": "TOTP removed successfully"
}

Dependencies

  • Requires an API key credential for authenticating with the Zitadel API.
  • The node uses the Zitadel gRPC client libraries bundled within its dependencies.
  • The Zitadel API base URL is set to https://zitadel.studentcouncil.dk.
  • Proper permissions are needed in the API key to perform user management operations such as removing TOTP.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect or non-existent userId will result in errors indicating the user was not found.
    • Insufficient permissions on the API key may lead to authorization errors.
  • Error Messages:

    • "authorization failed": Check that the API key is valid and has required scopes.
    • "user not found": Verify the userId parameter is correct.
    • "operation not supported": Ensure the selected Service and Operation combination is valid.
  • Resolution Tips:

    • Double-check API credentials and their permissions.
    • Confirm the userId exists in the Zitadel system.
    • Use the node's logging to inspect request payloads and responses for debugging.

Links and References

Discussion