Zitadel icon

Zitadel

Interact with the Zitadel API

Overview

This node integrates with the Zitadel API to perform various operations across multiple Zitadel services. Specifically, for the listUsers operation under the Default resource, it fetches a list of users from the selected Zitadel service (e.g., UserService or ManagementService). This is useful in scenarios where you want to retrieve user data programmatically for automation workflows, such as syncing user lists, auditing users, or managing access control.

Practical examples:

  • Retrieve a paginated list of users sorted by a specific column.
  • Query users with custom filters or conditions expressed in JSON format.
  • Integrate Zitadel user management into broader business processes within n8n.

Properties

Name Meaning
Service The Zitadel service to interact with. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. Default is UserService.
query A JSON object specifying query parameters such as pagination (limit, offset) and sorting order (order). Example: { "limit": 10, "offset": 0, "order": "ASC" }. Required for UserService and ManagementService when listing users.
sortingColumn A string indicating the column name by which to sort the user list. Required for UserService and ManagementService when listing users.
queries A JSON array representing additional query filters or conditions. Required for UserService and ManagementService when listing users.

Output

The node outputs a JSON object containing the response from the Zitadel API for the requested operation. For listUsers, this typically includes user data structured according to the Zitadel API's user list schema, such as arrays of user objects with their attributes.

If binary data were involved (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON user data.

Example output structure (simplified):

{
  "users": [
    {
      "id": "string",
      "email": "string",
      "displayName": "string",
      ...
    }
  ],
  "totalCount": 100,
  "limit": 10,
  "offset": 0
}

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 API key credential is correctly set up and has sufficient permissions.
  • Malformed JSON input: The query and queries properties expect valid JSON strings. Invalid JSON will cause parsing errors.
  • Unsupported operation or service: Selecting an operation not supported by the chosen service will result in no action or empty output.
  • Network issues: Connectivity problems to the Zitadel API endpoint can cause timeouts or failures.
  • Sorting column errors: Providing an invalid or unsupported sorting column may lead to unexpected results or errors.

To resolve these:

  • Double-check API credentials and permissions.
  • Validate JSON inputs before running the node.
  • Confirm the compatibility of service-operation combinations.
  • Verify network connectivity.
  • Use valid column names for sorting as per Zitadel API documentation.

Links and References

Discussion