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 removeOTPSMS operation under the "Default" resource (mapped here as a service-operation pair), it enables removing or disabling OTP SMS settings for a user identified by their user ID.

Common scenarios where this node is beneficial include:

  • Managing user authentication methods programmatically.
  • Automating security configurations such as disabling OTP via SMS for specific users.
  • Integrating Zitadel user management into broader workflows, e.g., in identity and access management automation.

Practical example:

  • An admin workflow that disables OTP SMS for a user who lost access to their phone, ensuring they cannot authenticate via SMS OTP anymore.

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 OTP SMS removal operation will be performed. Required when Service is UserService and Operation is removeOTPSMS.

Output

The node outputs a JSON object representing the response from the Zitadel API for the invoked operation. For the removeOTPSMS operation, this typically includes confirmation of the OTP SMS removal action or relevant status information returned by the API.

No binary data output is indicated or handled by this node.

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.
  • The node expects proper configuration of the Zitadel API credentials within n8n.

Troubleshooting

  • Common issues:

    • Missing or invalid API authentication token can cause authorization failures.
    • Incorrect userId may result in errors indicating the user was not found.
    • Selecting a service-operation combination that does not support the provided parameters may lead to unexpected errors.
  • Error messages and resolutions:

    • Authorization errors: Ensure the API key credential is correctly set up and has sufficient permissions.
    • Validation errors on input parameters: Verify that userId is correctly specified and matches an existing user.
    • Network or connectivity errors: Check network access to the Zitadel API endpoint.

Links and References


Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion