Zitadel icon

Zitadel

Interact with the Zitadel API

Overview

This node integrates with the Zitadel API, allowing users to perform various operations on different Zitadel services. Specifically, for the setPhone operation under the default resource, it updates a user's phone information in the UserService. This can be useful in scenarios where you need to programmatically update or verify user contact details within an identity management system.

Practical examples include:

  • Updating a user's phone number after they provide a new one.
  • Triggering sending of verification codes to the updated phone.
  • Marking the phone as verified or not based on external validation.

Properties

Name Meaning
Service The Zitadel service to interact with. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. For this operation, use "UserService".
userId The unique identifier of the user whose phone number is being set or updated.
phone The phone number to assign to the user.
sendCode A string indicating whether to send a verification code to the phone number (e.g., "true" or "false").
returnCode A string indicating whether to return the verification code in the response.
isVerified A string indicating whether the phone number should be marked as verified ("true" or "false").

Output

The output JSON contains the response from the Zitadel UserService's setPhone method. This typically includes confirmation of the phone update and may include verification status or codes depending on the input parameters.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "userId": "string",
  "phone": "string",
  "isVerified": true,
  "verificationCode": "string" // if requested via returnCode
}

Dependencies

  • Requires an API authentication token (Personal Access Token) for Zitadel, configured in the node 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 key credential is correctly configured and has sufficient permissions.
  • Incorrect userId or phone format: Validate that the user ID exists and the phone number is in the expected format.
  • JSON parsing errors: Input properties are parsed as JSON if possible; ensure strings like sendCode, returnCode, and isVerified are valid JSON or simple strings.
  • Operation not found: Confirm that the selected operation matches the supported methods of the chosen service.
  • Network issues: Verify connectivity to the Zitadel API endpoint.

Links and References

Discussion