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. Specifically, for the setPhone operation under the default resource, it updates a user's phone number and related verification settings within the UserService. This is useful in scenarios where you need to programmatically manage user contact information, such as updating phone numbers during user profile management or triggering phone verification workflows.

Practical examples include:

  • Updating a user's phone number after they submit a new contact detail form.
  • Setting whether the phone number is verified or not.
  • Controlling whether a verification code should be sent or returned as part of the update process.

Properties

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

Output

The node outputs a JSON object representing the response from the Zitadel UserService's setPhone method. This typically includes confirmation of the phone number update and any relevant metadata such as verification status or codes if requested.

No binary data output is involved.

Example output structure (simplified):

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

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 to communicate with Zitadel services.

Troubleshooting

  • Invalid or missing API token: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Incorrect service or operation selection: The setPhone operation only works with the UserService. Selecting other services will result in no action or errors.
  • Malformed input parameters: The node attempts to parse inputs as JSON; invalid JSON strings will cause errors. Provide plain strings for simple fields.
  • Network issues: Connectivity problems to the Zitadel API endpoint will cause request failures.
  • Permission errors: The authenticated user must have rights to modify user phone details.

Common error messages might include authorization failures, validation errors on phone format, or missing required fields. Verify all required properties are provided and valid.

Links and References

Discussion