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, OrganizationService, AdminService, ZITADELActions, and UserSchemaService. 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 by ID for identity management workflows.
  • Integrating Zitadel user data into other systems or automations.
  • Managing users programmatically within an organization using Zitadel's API.

Practical example:

  • Fetching a user's profile data by their user ID from the UserService to display in a CRM system.
  • Querying the ManagementService for user details during an administrative audit.

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

Output

The node outputs a JSON object containing the response from the Zitadel API corresponding to the requested user data. The structure of the 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 (conceptual):

{
  "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.
  • Connects to the Zitadel API endpoint at https://zitadel.studentcouncil.dk.
  • Uses gRPC client libraries internally to communicate with Zitadel services.

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 user ID (userId or id) exists in the selected service.
  • Operation not supported: Confirm that the chosen operation matches the selected service; otherwise, the node returns empty JSON.
  • JSON parsing errors: Input parameters are parsed as JSON if possible; ensure string inputs are valid JSON or plain strings as expected.
  • Network issues: Check connectivity to the Zitadel API endpoint.

Links and References

Discussion