Zitadel icon

Zitadel

Interact with the Zitadel API

Actions42

createInviteCode

AI-generated

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 createInviteCode operation under the UserService resource, it enables creating an invite code associated with a user.

Common scenarios where this node is beneficial include automating user management workflows, generating invite codes for onboarding new users, or integrating Zitadel's identity and access management features into broader automation pipelines.

For example, you could use this node to generate an invite code for a new user in your system, optionally send the code via email or another channel, and then return the generated code for further processing or logging.

Properties

Name Meaning
Service The Zitadel service to interact with. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. Default is UserService.
userId (Required for UserService + createInviteCode) The identifier of the user for whom the invite code will be created.
sendCode (Required for UserService + createInviteCode) A string parameter likely indicating whether or how to send the invite code (e.g., "true" or "false", or a method). Exact usage depends on API.
returnCode (Required for UserService + createInviteCode) A string parameter that probably controls if the invite code should be returned in the response or some related behavior.

Output

The node outputs JSON data representing the response from the Zitadel API for the invoked operation. For the createInviteCode operation, the output JSON contains the details of the created invite code or related metadata returned by the API.

No binary data output is indicated by the source code.

Example output structure (simplified):

{
  "inviteCode": "string",
  "expiration": "timestamp",
  "userId": "string",
  ...
}

The exact fields depend on the Zitadel API response for the createInviteCode method.

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 (nice-grpc) to communicate with Zitadel services.
  • No additional external dependencies are required beyond the configured Zitadel API credentials.

Troubleshooting

  • Authentication errors: If the node fails due to authorization issues, ensure the API token credential is valid and has sufficient permissions.
  • Invalid parameters: Passing malformed JSON or incorrect parameter types may cause errors. The node attempts to parse JSON input but falls back to strings if parsing fails.
  • Operation not found: Selecting an unsupported operation for a given service will result in no action; verify the selected service-operation combination is valid.
  • Network issues: Connectivity problems to the Zitadel API endpoint can cause timeouts or failures; check network access and endpoint availability.

Links and References

Discussion