Zitadel icon

Zitadel

Interact with the Zitadel API

Overview

This node integrates with the Zitadel API, allowing users to perform various operations on different Zitadel services. Specifically, for the unlockUser operation under the default resource, it unlocks a user account in the Zitadel system. This is useful in scenarios where a user has been locked out due to multiple failed login attempts or administrative actions and needs to regain access.

Practical examples include:

  • Automatically unlocking a user after verifying their identity through another workflow.
  • Administrators unlocking user accounts as part of support ticket resolutions.
  • Integrating user management workflows that handle account lock/unlock states dynamically.

Properties

Name Meaning
Service The Zitadel service to use. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. For unlockUser, typically "UserService" or "ManagementService".
userId The unique identifier of the user to unlock when using the UserService for the unlockUser operation.
id The unique identifier of the user to unlock when using the ManagementService for the unlockUser operation.

Note: The property shown depends on the selected service. For example, if "UserService" is selected, userId is required; if "ManagementService" is selected, id is required.

Output

The node outputs a JSON object representing the response from the Zitadel API for the unlockUser operation. This typically includes confirmation details about the unlocked user or status information returned by the API.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "json": {
    // API response fields confirming the unlock action
  }
}

Dependencies

  • Requires an API authentication token (Personal Access Token) for Zitadel, configured in n8n credentials.
  • Connects to the Zitadel API endpoint at https://zitadel.studentcouncil.dk.
  • Uses gRPC client libraries internally to communicate with Zitadel services.

Troubleshooting

  • Common issues:

    • Missing or invalid API token: Ensure the Zitadel API key credential is correctly set up in n8n.
    • Incorrect user ID: Verify that the userId or id corresponds to an existing user in Zitadel.
    • Selecting mismatched service and properties: Make sure to select the correct service matching the input property (userId vs id).
  • Error messages:

    • Authorization errors: Check API token validity and permissions.
    • Not found errors: Confirm the user exists and the ID is correct.
    • Parsing errors: Input properties like userId must be valid strings; avoid malformed JSON inputs.

Links and References

Discussion