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 such as UserService, ManagementService, AuthService, and others. Specifically, for the getUserByID operation under the "Default" resource, it fetches user details by their unique identifier from the selected service.

Common scenarios where this node is beneficial include:

  • Retrieving detailed user information for identity management workflows.
  • Integrating Zitadel user data into other systems or automations.
  • Managing user accounts programmatically within an organization's infrastructure.

For example, you might use this node to get a user's profile data by their ID to verify access rights before proceeding with further automation steps.

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 to retrieve when using the UserService with the getUserByID operation. Required if Service is UserService.
id The unique identifier of the user to retrieve when using the ManagementService with the getUserByID operation. Required if Service is ManagementService.

Output

The node outputs a JSON object containing the response from the Zitadel API corresponding to the requested user data. The structure of this JSON depends on the specific service and operation but generally includes user attributes such as identifiers, metadata, and related user information.

No binary data output is produced by this node.

Example output snippet (simplified):

{
  "id": "user-id-string",
  "email": "user@example.com",
  "displayName": "John Doe",
  "metadata": { ... }
}

Dependencies

  • Requires an API authentication token (Personal Access Token) for Zitadel, configured in n8n credentials.
  • Uses gRPC clients generated from Zitadel's protobuf definitions.
  • Connects to the Zitadel API endpoint at https://zitadel.studentcouncil.dk.

Troubleshooting

  • Invalid or missing API token: Ensure that the Zitadel API token credential is correctly set up and has sufficient permissions.
  • Incorrect user ID: Verify that the provided userId or id matches an existing user in the selected service.
  • Operation not supported: If the chosen operation does not exist for the selected service, the node returns empty JSON. Double-check the service-operation combination.
  • JSON parsing errors: Input parameters that expect JSON strings must be valid JSON; otherwise, the node falls back to treating them as plain strings.

Links and References

Discussion