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, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, and UserSchemaService. Specifically, for the removePhone operation under the UserService resource, it facilitates removing a phone number associated with a user by specifying the user's ID.

Common scenarios where this node is beneficial include managing user accounts in Zitadel, automating administrative tasks like updating or cleaning user contact information, and integrating Zitadel user management into broader workflows.

For example, an organization might use this node to automatically remove outdated phone numbers from user profiles when syncing data from another system or during offboarding processes.

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 whose phone number should be removed. Required when Service is UserService and Operation is removePhone.

Output

The node outputs a JSON object representing the response from the Zitadel API after performing the requested operation. For the removePhone operation, this typically includes confirmation details about the removal action or any relevant metadata returned by the API.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "json": {
    // Response fields from Zitadel API related to phone removal
  }
}

Dependencies

  • Requires an API authentication token credential for Zitadel (referred generically as an API key credential).
  • Connects to the Zitadel API endpoint at https://zitadel.studentcouncil.dk.
  • Uses gRPC client libraries internally to communicate with Zitadel services.
  • No additional external dependencies beyond the configured Zitadel credentials and network access to the API endpoint.

Troubleshooting

  • Invalid or missing API token: Ensure that the Zitadel API authentication token is correctly configured in the node credentials. Errors related to authorization will occur if the token is invalid or expired.
  • Incorrect userId: Providing an invalid or non-existent userId will cause the operation to fail. Verify the userId before running the node.
  • Unsupported operation or service: If the selected operation does not exist for the chosen service, the node returns an empty JSON object. Double-check the service-operation combination.
  • JSON parsing errors: Input parameters are parsed as JSON if applicable. Malformed JSON input in properties may cause errors; ensure correct formatting.
  • Network issues: Connectivity problems to the Zitadel API endpoint will prevent successful execution.

Links and References

Discussion