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 addHumanUser operation under the "Default" resource, it allows creating a new human user in the Zitadel system by calling the appropriate service method.

Common scenarios where this node is beneficial include:

  • Automating user onboarding workflows by programmatically adding users.
  • Integrating Zitadel user management into broader automation pipelines.
  • Managing users across different Zitadel services such as UserService or ManagementService.

For example, you can use this node to add a new user with detailed profile information, email, phone, and authentication credentials, directly from an n8n workflow without manual intervention.

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 (required for UserService when adding a human user).
username The username of the new human user (required for UserService).
organization The organization to which the user belongs (required for UserService).
profile Profile information of the user (required for UserService and ManagementService).
email Email address of the user (required for UserService and ManagementService).
phone Phone number of the user (required for UserService and ManagementService).
metadata Additional metadata associated with the user (required for UserService).
password Password for the user account (required for UserService).
hashedPassword Hashed version of the user's password (required for UserService).
idpLinks Identity provider links related to the user (required for UserService).
totpSecret Secret key for TOTP (Time-based One-Time Password) two-factor authentication (required for UserService).
userName Username for the user (required for ManagementService).
initialPassword Initial password for the user (required for ManagementService).

Note: Some properties are specific to certain services; for example, userId, username, organization, etc., are required when using the UserService, while userName, initialPassword are used with ManagementService.

Output

The node outputs the JSON response returned by the Zitadel API after performing the addHumanUser operation. This typically includes details about the newly created user, such as their ID, profile data, and any other relevant metadata returned by the API.

If the operation fails or no data is returned, the output will contain an empty JSON object.

The node does not output binary data.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure that the API token credential is correctly configured and has sufficient permissions to create users.
  • Invalid input data: The node expects JSON strings for some parameters; malformed JSON will cause parsing errors. Verify that all JSON inputs are well-formed.
  • Missing required fields: All required properties for the selected service and operation must be provided; otherwise, the API call may fail.
  • Network issues: Connectivity problems to the Zitadel API endpoint will prevent successful execution.
  • Unsupported operation: If an operation name is incorrect or not supported by the selected service, the node returns an empty JSON object.

Links and References

Discussion