Zitadel icon

Zitadel

Interact with the Zitadel API

addIDPLink

AI-generated

Overview

This node integrates with the Zitadel API, allowing users to perform various operations on different Zitadel services. Specifically, for the addIDPLink operation under the UserService resource, it adds an Identity Provider (IDP) link to a user account. This is useful in scenarios where you want to link external identity providers (like Google, Microsoft, or other OAuth/OpenID Connect providers) to a user's Zitadel profile, enabling single sign-on or federated authentication.

Practical examples:

  • Linking a corporate Google Workspace account as an IDP for a user.
  • Adding a social login provider to an existing user account.
  • Managing multiple authentication sources for a user within Zitadel.

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 to whom the IDP link will be added. Required when Service is UserService and Operation is addIDPLink.
idpLink The IDP link string that represents the external identity provider connection to add. Required when Service is UserService and Operation is addIDPLink.

Output

The node outputs a JSON object representing the response from the Zitadel API after performing the requested operation. For the addIDPLink operation, this typically includes confirmation details about the newly linked IDP or the updated user information.

No binary data output is indicated by the source code.

Example output structure (simplified):

{
  "idpLink": "string",
  "userId": "string",
  "status": "linked"
}

Dependencies

  • Requires an API authentication token (Personal Access Token) for Zitadel, provided via node credentials.
  • Uses the nice-grpc library to communicate with Zitadel's gRPC services.
  • The node expects the Zitadel API endpoint URL configured internally (https://zitadel.studentcouncil.dk).
  • No additional environment variables are explicitly required beyond the API token credential.

Troubleshooting

  • Invalid or missing API token: The node requires a valid Personal Access Token for authorization. Ensure the token is correctly set in the node credentials.
  • Incorrect userId or idpLink format: The operation expects valid strings for these parameters. Invalid values may cause API errors.
  • Operation not found: If the selected operation does not exist in the chosen service, the node returns an empty JSON object.
  • JSON parsing errors: Input properties are parsed as JSON if possible; malformed JSON input will fallback to string usage but may cause unexpected behavior.
  • Network or connectivity issues: Since the node communicates over gRPC to Zitadel's API endpoint, network problems can cause failures.

Links and References

Discussion