Zitadel Preview Docs
SDKs

SDKs

Framework packages and shared client surfaces for the Zitadel preview.

The preview publishes framework SDKs, shared UI components, and the generated API client in one alpha package train. Pick an SDK by how your app renders: server frameworks proxy and verify sessions in middleware, SPA frameworks render the same auth widgets behind a same-origin proxy.

Start with the CLI

Prefer npx @zitadel/cli@alpha setup for app setup — it scaffolds the right package and proxy for your framework. Use these SDK pages when reviewing generated files, customizing routes, or integrating manually.

Server frameworks

Auth runs in framework middleware: it proxies /__nextgen/*, verifies the session, and guards protected routes server-side.

SPA frameworks

The same shared auth widgets, rendered client-side. They need a same-origin proxy for /__nextgen/* — the CLI wires one for local dev; production deployments supply their own.

Building blocks

Lower-level packages the framework SDKs are built on. Reach for these to embed the widgets directly or call the API with a typed client.

Choosing an SDK

All packages ship on the @alpha dist-tag and move together as one train.

FrameworkPackageRenderingSame-origin /__nextgen/* proxyCLI scaffolds
Next.js@zitadel/sdk-nextServer (App Router)Built into the SDK middlewareroutes + middleware.ts
Nuxt@zitadel/sdk-nuxtServer (Nitro)Nitro server middlewarepages + server middleware
React@zitadel/sdk-reactSPAVite dev proxy / your deploy proxyVite proxy + auth UI
Vue@zitadel/sdk-vueSPAVite dev proxy / your deploy proxyVite proxy + auth UI
Angular@zitadel/sdk-angularSPAdev-server proxy / your deploy proxyproxy config + components
Components@zitadel/componentsWeb componentsn/a (wrapped by an SDK)
API client@zitadel/apin/an/atyped client

The same-origin proxy is the one concept shared by every SDK. See SDK proxy for why /__nextgen/* must be same-origin and how the project service key is attached.

On this page