Zitadel icon

Zitadel

Interact with the Zitadel API

Overview

This node provides an interface to interact with the Zitadel API, a platform for identity and access management. It allows users to call various services and operations exposed by Zitadel, such as user management, organization management, authentication, administration, and custom actions.

The specific operation startIdentityProviderIntent under the UserService resource initiates an identity provider intent, which is typically used in scenarios where you want to start an authentication or identity linking process with an external identity provider (IdP). This can be useful for integrating single sign-on (SSO) or federated login flows into your workflows.

Practical examples:

  • Starting an SSO login flow for a user via an external IdP.
  • Initiating identity linking between Zitadel and an LDAP provider.
  • Automating identity provider intents as part of onboarding or authentication workflows.

Properties

Name Meaning
Service The Zitadel service to use. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. Default is UserService.
idpId The identifier of the identity provider to start the intent with. Required for UserService's startIdentityProviderIntent operation.
urls URLs related to the identity provider intent, likely callback or redirect URLs. Required for UserService's startIdentityProviderIntent.
ldap LDAP configuration or identifier string related to the identity provider intent. Required for UserService's startIdentityProviderIntent.

Output

The node outputs the raw JSON response from the Zitadel API corresponding to the invoked operation. For startIdentityProviderIntent, this will include data returned by the Zitadel UserService about the started identity provider intent, such as tokens, URLs, or status information needed to continue the authentication flow.

No binary data output is indicated by the code.

Dependencies

  • Requires an API authentication token credential for Zitadel (referred generically as "an API key credential").
  • Uses the Zitadel gRPC client libraries generated for various Zitadel services.
  • Connects to the Zitadel API endpoint at https://zitadel.studentcouncil.dk.
  • Uses the nice-grpc library for gRPC communication and interceptors for authorization.

Troubleshooting

  • Common issues:
    • Invalid or missing API authentication token will cause authorization failures.
    • Incorrect or malformed JSON input for properties like urls or ldap may cause parsing errors.
    • Using unsupported combinations of service and operation parameters will result in no action or empty output.
  • Error messages:
    • Authorization errors: Ensure the API token credential is correctly configured and valid.
    • JSON parse errors: Verify that inputs expected as JSON strings are properly formatted.
    • Operation not found: Confirm that the selected service supports the chosen operation.

Links and References

Discussion