Files
zitadel/docs
791d0587aa feat(action v2): add JWT and JWE payload type options (#11196)
# Which Problems Are Solved

The payload in actions V2 is currently sent as JSON to the target
endpoint. It might get exposed to intermediary infrastructure or logging
systems.
For these scenarios there needs to be an application-layer encryption,
where the provider of the endpoint can define an key to be used for the
encryption.

# How the Problems Are Solved

- Added an additional option to the target to specify the payload type:
`JSON` (current and default), `JWT`, `JWE` (api and console)
- added endpoints to upload and manage public keys (to be used for
encryption) for a target
- updated all action v2 executions (interceptors, oidc, saml, ...) to
provide the `GetActiveSigningWebKey` from queries
- implemented jwt and jwe in the exections incl. refactoring of code and
tests
- changes to the authn_keys table:
  - added a `fingerprint` column
  - dropped not null constraint on expiration
- moved the `GetSignerOnce` into its own package to prevent circular
dependencies

# Additional Changes

None

# Additional Context

closes #11061

---------

Co-authored-by: Marco A. <[email protected]>
Co-authored-by: conblem <[email protected]>
Co-authored-by: Silvan <[email protected]>
2025-12-29 13:35:53 +00:00
..
2025-10-08 10:27:02 +02:00

ZITADEL-Docs

This website is built using Docusaurus 2, a modern static website generator.

The documentation is part of the ZITADEL monorepo and uses pnpm and Nx for development and build processes.

Quick Start

Run the following commands from the repositorys root directory to install all dependencies needed. Using Corepack makes sure you have the pnpm version intalled that is declared in .

corepack enable
pnpm install

Start a docs server

# Start development server with live-reloading
pnpm nx run @zitadel/docs:dev

# Or serve a production build
pnpm nx run @zitadel/docs:prod

The site will be available at http://localhost:3100

Add new Sites to existing Topics

To add a new site to the already existing structure simply save the md file into the corresponding folder and append the sites id int the file sidebars.js.

If you are introducing new APIs (gRPC), you need to add a new entry to docusaurus.config.js under the plugins section.

Build Process

The documentation build process automatically:

  1. Downloads required protoc plugins - Ensures protoc-gen-connect-openapi is available
  2. Generates gRPC documentation - Creates API docs from proto files
  3. Generates API documentation - Creates OpenAPI specification docs
  4. Copies configuration files - Includes configuration examples
  5. Builds the Docusaurus site - Generates the final static site