Feature flags of ZITADEL crate // Lib.rs

Cargo Features

[dependencies]
zitadel = { version = "5.3.2", default-features = false, features = ["actix", "api", "api-admin-v1", "api-auth-v1", "api-management-v1", "api-system-v1", "api-oidc-v2", "api-org-v2", "api-session-v2", "api-settings-v2", "api-user-v2", "api-common", "tls-roots", "tls-webpki-roots", "axum", "credentials", "interceptors", "introspection_cache", "oidc", "rocket", "rocket_okapi", "proto_full", "zitadel-action-v1", "zitadel-admin-v1", "zitadel-app-v1", "zitadel-auth-v1", "zitadel-authn-v1", "zitadel-change-v1", "zitadel-event-v1", "zitadel-feature-v1", "zitadel-feature-v2", "zitadel-feature-v2beta", "zitadel-idp-v1", "zitadel-idp-v2", "zitadel-instance-v1", "zitadel-management-v1", "zitadel-member-v1", "zitadel-metadata-v1", "zitadel-milestone-v1", "zitadel-object-v2", "zitadel-object-v2beta", "zitadel-object-v3alpha", "zitadel-oidc-v2", "zitadel-oidc-v2beta", "zitadel-org-v1", "zitadel-org-v2", "zitadel-org-v2beta", "zitadel-policy-v1", "zitadel-project-v1", "zitadel-protoc_gen_zitadel-v2", "zitadel-quota-v1", "zitadel-resources-action-v3alpha", "zitadel-resources-debug_events-v3alpha", "zitadel-resources-object-v3alpha", "zitadel-resources-user-v3alpha", "zitadel-resources-userschema-v3alpha", "zitadel-resources-webkey-v3alpha", "zitadel-session-v2", "zitadel-session-v2beta", "zitadel-settings-object-v3alpha", "zitadel-settings-v1", "zitadel-settings-v2", "zitadel-settings-v2beta", "zitadel-system-v1", "zitadel-text-v1", "zitadel-user-v1", "zitadel-user-v2", "zitadel-user-v2beta", "zitadel-v1", "zitadel-v1-v1", "document-features"] }

default = tls-roots

The tls-roots feature is set by default whenever zitadel is added without default-features = false somewhere in the dependency tree.

actix = credentials, oidc

Feature that enables support for the actix framework.

Enables actix-web

Affects zitadel::actix…

api = api-admin-v1, api-auth-v1, api-management-v1, api-oidc-v2, api-org-v2, api-session-v2, api-settings-v2, api-system-v1, api-user-v2

The API feature enables all gRPC service clients to access the ZITADEL API.

api-admin-v1 api? = api-common, zitadel-admin-v1

The API feature enables all gRPC service clients to access the respective ZITADEL API.

api-auth-v1 api? = api-common, zitadel-auth-v1

The API feature enables all gRPC service clients to access the respective ZITADEL API.

api-management-v1 api? = api-common, zitadel-v1-v1

The API feature enables all gRPC service clients to access the respective ZITADEL API.

api-system-v1 api? = api-common, zitadel-authn-v1, zitadel-system-v1

The API feature enables all gRPC service clients to access the respective ZITADEL API.

api-oidc-v2 api? = api-common, zitadel-oidc-v2

The API feature enables all gRPC service clients to access the respective ZITADEL API.

api-org-v2 api? = api-common, zitadel-org-v2, zitadel-user-v2

The API feature enables all gRPC service clients to access the respective ZITADEL API.

api-session-v2 api? = api-common, zitadel-session-v2

The API feature enables all gRPC service clients to access the respective ZITADEL API.

api-settings-v2 api? = api-common, zitadel-settings-v2

The API feature enables all gRPC service clients to access the respective ZITADEL API.

api-user-v2 api? = api-common, zitadel-user-v2

The API feature enables all gRPC service clients to access the respective ZITADEL API.

api-common api-admin-v1? api-auth-v1? api-management-v1? api-oidc-v2? api-org-v2? api-session-v2? api-settings-v2? api-system-v1? api-user-v2?

Enables pbjson-types, prost, prost-types, tonic, and tonic-types

Affects zitadel::api…

tls-roots default

Enables tls-roots of tonic

tonic:
Deprecated. Please use tls-native-roots instead.

tls-webpki-roots

Enables tls-webpki-roots of tonic

axum = credentials, oidc

Feature that enables support for the axum framework.

Enables axum and axum-extra

Affects zitadel::axum…

credentials actix? axum? interceptors? oidc? rocket?

The credentials feature enables special credentials helpers for ZITADEL.
For example, it allows the user to create a ZITADEL service account and authenticate against ZITADEL.

Enables jsonwebtoken, openidconnect, reqwest ^0.11.27, serde, serde_json, serde_urlencoded, and time

Affects zitadel::credentials…

interceptors = credentials

The interceptors feature enables specific gRPC interceptors and new convenience functions to create a gRPC client with interceptors.
The interceptors provide easy access to an authenticated ZITADEL API client.
The interceptors work with the credentials from this crate.

Enables time and tokio

Affects api::interceptors…

introspection_cache

This feature enables caching of the OIDC discovery and introspection results.
By default, only the in-memory cache is available. To use a different cache,
enable specific features of this crate, or implement your own cache with the trait.

Enables async-trait, moka, and time

Affects introspection::cache…

oidc actix? axum? rocket? = credentials

The OIDC module enables basic OIDC (OpenID Connect) features to communicate with ZITADEL. Two examples are the discover and introspect functions. The OIDC features are required for some of the web framework features.

Enables base64-compat

Affects zitadel::oidc…

rocket rocket_okapi? = credentials, oidc

Feature that enables support for the rocket framework. It enables authentication features for rocket in the form of route guards. Refer to the rocket module for more information.

Enables rocket

Affects zitadel::rocket…

rocket_okapi = rocket

Feature that enables support for the rocket okapi.

Enables rocket_okapi and schemars

Affects config::IntrospectionRocketConfig…

proto_full = zitadel-action-v1, zitadel-admin-v1, zitadel-app-v1, zitadel-auth-v1, zitadel-authn-v1, zitadel-change-v1, zitadel-event-v1, zitadel-feature-v1, zitadel-feature-v2, zitadel-feature-v2beta, zitadel-idp-v1, zitadel-idp-v2, zitadel-instance-v1, zitadel-management-v1, zitadel-member-v1, zitadel-metadata-v1, zitadel-milestone-v1, zitadel-object-v2, zitadel-object-v2beta, zitadel-object-v3alpha, zitadel-oidc-v2, zitadel-oidc-v2beta, zitadel-org-v1, zitadel-org-v2, zitadel-org-v2beta, zitadel-policy-v1, zitadel-project-v1, zitadel-protoc_gen_zitadel-v2, zitadel-quota-v1, zitadel-resources-action-v3alpha, zitadel-resources…events-v3alpha, zitadel-resources-object-v3alpha, zitadel-resources-user-v3alpha, zitadel…userschema-v3alpha, zitadel-resources-webkey-v3alpha, zitadel-session-v2, zitadel-session-v2beta, zitadel-settings-object-v3alpha, zitadel-settings-v1, zitadel-settings-v2, zitadel-settings-v2beta, zitadel-system-v1, zitadel-text-v1, zitadel-user-v1, zitadel-user-v2, zitadel-user-v2beta, zitadel-v1, zitadel-v1-v1

@@protoc_deletion_point(features)
This section is automatically generated by protoc-gen-prost-crate.
Changes in this area may be lost on regeneration.

zitadel-action-v1 proto_full? zitadel-management-v1? = zitadel-v1