From 2c260a1f104eeff434781e9e1c0856cffc1efbcc Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Sat, 21 Feb 2026 07:44:42 -0800 Subject: [PATCH] docs: add description frontmatter to content pages for SEO (#11654) --- apps/docs/app/[[...slug]]/page.tsx | 9 +- apps/docs/app/layout.tsx | 4 + .../content/apis/actions/code-examples.mdx | 1 + .../content/apis/actions/complement-token.mdx | 1 + .../apis/actions/customize-samlresponse.mdx | 1 + .../apis/actions/external-authentication.mdx | 1 + .../apis/actions/internal-authentication.mdx | 1 + apps/docs/content/apis/actions/modules.mdx | 1 + apps/docs/content/apis/actions/objects.mdx | 1 + apps/docs/content/apis/apis/index.mdx | 1 + apps/docs/content/apis/assets/assets.mdx | 1 + apps/docs/content/apis/benchmarks/index.mdx | 1 + apps/docs/content/apis/introduction.mdx | 1 + apps/docs/content/apis/migration_v1_to_v2.mdx | 1 + .../content/apis/observability/health.mdx | 1 + .../content/apis/observability/metrics.mdx | 1 + .../apis/openidoauth/authn-methods.mdx | 1 + .../content/apis/openidoauth/authrequest.mdx | 1 + apps/docs/content/apis/openidoauth/claims.mdx | 1 + .../content/apis/openidoauth/endpoints.mdx | 1 + .../content/apis/openidoauth/grant-types.mdx | 1 + apps/docs/content/apis/openidoauth/scopes.mdx | 1 + apps/docs/content/apis/saml/endpoints.mdx | 1 + apps/docs/content/apis/scim2.mdx | 3 +- apps/docs/content/apis/statuscodes.mdx | 1 + apps/docs/content/apis/v2.mdx | 1 + .../content/concepts/architecture/secrets.mdx | 1 + .../concepts/architecture/software.mdx | 1 + .../concepts/architecture/solution.mdx | 1 + .../concepts/eventstore/implementation.mdx | 1 + .../content/concepts/eventstore/overview.mdx | 1 + .../concepts/features/account-linking.mdx | 1 + .../content/concepts/features/actions.mdx | 1 + .../content/concepts/features/actions_v2.mdx | 1 + .../content/concepts/features/audit-trail.mdx | 1 + .../concepts/features/custom-domain.mdx | 1 + .../concepts/features/external-user-grant.mdx | 1 + .../concepts/features/identity-brokering.mdx | 1 + apps/docs/content/concepts/features/index.mdx | 1 + .../content/concepts/features/passkeys.mdx | 1 + .../content/concepts/features/selfservice.mdx | 1 + apps/docs/content/concepts/index.mdx | 2 +- .../docs/content/concepts/knowledge/index.mdx | 1 + .../concepts/knowledge/opaque-tokens.mdx | 3 +- apps/docs/content/concepts/principles.mdx | 1 + .../concepts/structure/administrators.mdx | 1 + .../concepts/structure/granted_projects.mdx | 3 +- .../docs/content/concepts/structure/index.mdx | 1 + .../content/concepts/structure/instance.mdx | 1 + .../content/concepts/structure/policies.mdx | 1 + .../examples/identity-proxy/oauth2-proxy.mdx | 1 + .../examples/introduction/backend/index.mdx | 2 +- .../examples/introduction/frontend/index.mdx | 2 +- .../examples/introduction/fullstack/index.mdx | 2 +- .../content/examples/introduction/index.mdx | 2 +- .../examples/introduction/mobile/index.mdx | 2 +- .../examples/introduction/webapp/index.mdx | 2 +- apps/docs/content/examples/login/angular.mdx | 1 + apps/docs/content/examples/login/flutter.mdx | 1 + apps/docs/content/examples/login/go.mdx | 1 + .../content/examples/login/java-spring.mdx | 1 + .../content/examples/login/nextjs-b2b.mdx | 1 + apps/docs/content/examples/login/nextjs.mdx | 1 + .../content/examples/login/python-django.mdx | 1 + apps/docs/content/examples/login/react.mdx | 1 + apps/docs/content/examples/login/symfony.mdx | 1 + apps/docs/content/examples/login/vue.mdx | 1 + apps/docs/content/examples/secure-api/go.mdx | 1 + .../examples/secure-api/java-spring.mdx | 1 + .../examples/secure-api/nodejs-nestjs.mdx | 3 +- .../content/examples/secure-api/pylon.mdx | 1 + .../examples/secure-api/python-django.mdx | 1 + .../examples/secure-api/python-flask.mdx | 1 + .../integrate/actions/migrate-from-v1.mdx | 1 + .../integrate/actions/testing-event.mdx | 1 + .../actions/testing-function-manipulation.mdx | 1 + .../integrate/actions/testing-function.mdx | 1 + .../actions/testing-request-manipulation.mdx | 1 + .../actions/testing-request-signature.mdx | 1 + .../integrate/actions/testing-request.mdx | 1 + .../actions/testing-response-manipulation.mdx | 1 + .../integrate/actions/testing-response.mdx | 1 + .../guides/integrate/actions/usage.mdx | 1 + .../integrate/actions/webhook-site-setup.mdx | 1 + .../authenticated-mongodb-charts.mdx | 1 + .../guides/integrate/back-channel-logout.mdx | 1 + .../guides/integrate/external-audit-log.mdx | 1 + .../additional-information.mdx | 1 + .../integrate/identity-providers/apple.mdx | 1 + .../identity-providers/azure-ad-oidc.mdx | 1 + .../identity-providers/azure-ad-saml.mdx | 1 + .../identity-providers/generic-oidc.mdx | 1 + .../integrate/identity-providers/github.mdx | 1 + .../integrate/identity-providers/gitlab.mdx | 1 + .../integrate/identity-providers/google.mdx | 1 + .../identity-providers/introduction.mdx | 1 + .../integrate/identity-providers/jwt_idp.mdx | 1 + .../integrate/identity-providers/keycloak.mdx | 1 + .../integrate/identity-providers/ldap.mdx | 1 + .../identity-providers/linkedin_oauth.mdx | 1 + .../integrate/identity-providers/migrate.mdx | 1 + .../integrate/identity-providers/mocksaml.mdx | 1 + .../identity-providers/okta-oidc.mdx | 1 + .../identity-providers/okta_saml.mdx | 1 + .../identity-providers/onelogin-saml.mdx | 1 + .../integrate/identity-providers/openldap.mdx | 1 + .../identity-providers/pingfederate-saml.mdx | 1 + .../guides/integrate/login-ui/device-auth.mdx | 1 + .../integrate/login-ui/external-login.mdx | 1 + .../guides/integrate/login-ui/index.mdx | 2 +- .../guides/integrate/login-ui/login-app.mdx | 1 + .../guides/integrate/login-ui/logout.mdx | 1 + .../content/guides/integrate/login-ui/mfa.mdx | 1 + .../integrate/login-ui/oidc-standard.mdx | 1 + .../guides/integrate/login-ui/passkey.mdx | 1 + .../integrate/login-ui/password-reset.mdx | 1 + .../integrate/login-ui/saml-standard.mdx | 1 + .../integrate/login-ui/select-account.mdx | 1 + .../integrate/login-ui/session-validation.mdx | 1 + .../integrate/login-ui/username-password.mdx | 1 + .../guides/integrate/login/hosted-login.mdx | 1 + .../guides/integrate/login/login-users.mdx | 1 + .../integrate/login/oidc/authmethods.mdx | 1 + .../login/oidc/device-authorization.mdx | 1 + .../guides/integrate/login/oidc/index.mdx | 2 +- .../integrate/login/oidc/login-users.mdx | 1 + .../guides/integrate/login/oidc/logout.mdx | 1 + .../login/oidc/oauth-recommended-flows.mdx | 1 + .../guides/integrate/login/oidc/webkeys.mdx | 1 + .../content/guides/integrate/login/saml.mdx | 1 + .../guides/integrate/onboarding/b2b.mdx | 1 + .../guides/integrate/onboarding/end-users.mdx | 1 + .../guides/integrate/retrieve-user-roles.mdx | 1 + .../guides/integrate/scim-okta-guide.mdx | 1 + .../authenticate-service-accounts.mdx | 1 + .../service-accounts/client-credentials.mdx | 1 + .../personal-access-token.mdx | 1 + .../service-accounts/private-key-jwt.mdx | 1 + .../integrate/services/atlassian-saml.mdx | 1 + .../guides/integrate/services/auth0-oidc.mdx | 1 + .../guides/integrate/services/auth0-saml.mdx | 1 + .../guides/integrate/services/aws-saml.mdx | 1 + .../integrate/services/cloudflare-oidc.mdx | 1 + .../guides/integrate/services/gitlab-saml.mdx | 1 + .../integrate/services/gitlab-self-hosted.mdx | 1 + .../integrate/services/google-cloud.mdx | 1 + .../integrate/services/google-workspace.mdx | 1 + .../guides/integrate/services/index.mdx | 2 +- .../integrate/services/pingidentity-saml.mdx | 1 + .../guides/integrate/token-exchange.mdx | 1 + .../token-introspection/basic-auth.mdx | 1 + .../integrate/token-introspection/index.mdx | 1 + .../token-introspection/private-key-jwt.mdx | 1 + .../guides/integrate/tools/apache2.mdx | 1 + .../zitadel-apis/access-zitadel-apis.mdx | 1 + .../access-zitadel-system-api.mdx | 1 + .../integrate/zitadel-apis/event-api.mdx | 1 + .../example-zitadel-api-with-dot-net.mdx | 1 + .../example-zitadel-api-with-go.mdx | 1 + .../content/guides/manage/cloud/billing.mdx | 1 + .../content/guides/manage/cloud/egress.mdx | 2 +- .../content/guides/manage/cloud/instances.mdx | 1 + .../content/guides/manage/cloud/settings.mdx | 1 + .../content/guides/manage/cloud/start.mdx | 1 + .../content/guides/manage/cloud/support.mdx | 1 + .../content/guides/manage/cloud/users.mdx | 1 + .../manage/console/actions-overview.mdx | 1 + .../guides/manage/console/administrators.mdx | 3 +- .../manage/console/applications-overview.mdx | 1 + .../manage/console/console-overview.mdx | 1 + .../manage/console/default-settings.mdx | 1 + .../manage/console/organizations-overview.mdx | 1 + .../manage/console/projects-overview.mdx | 1 + .../content/guides/manage/console/roles.mdx | 1 + .../guides/manage/console/users-overview.mdx | 1 + .../guides/manage/customize/behavior.mdx | 1 + .../guides/manage/customize/branding.mdx | 1 + .../customize/notification-providers.mdx | 1 + .../guides/manage/customize/restrictions.mdx | 1 + .../content/guides/manage/customize/texts.mdx | 1 + .../guides/manage/customize/user-metadata.mdx | 1 + .../guides/manage/terraform-provider.mdx | 1 + .../guides/manage/user/reg-create-user.mdx | 1 + .../docs/content/guides/manage/user/scim2.mdx | 1 + .../content/guides/migrate/introduction.mdx | 1 + .../content/guides/migrate/sources/auth0.mdx | 1 + .../guides/migrate/sources/keycloak.mdx | 1 + .../guides/migrate/sources/zitadel.mdx | 1 + apps/docs/content/guides/migrate/users.mdx | 1 + .../content/guides/solution-scenarios/b2b.mdx | 1 + .../content/guides/solution-scenarios/b2c.mdx | 1 + .../solution-scenarios/configurations.mdx | 1 + .../solution-scenarios/domain-discovery.mdx | 1 + .../frontend-calling-backend-API.mdx | 1 + .../guides/solution-scenarios/index.mdx | 1 + .../solution-scenarios/restrict-console.mdx | 1 + .../guides/solution-scenarios/saas.mdx | 1 + apps/docs/content/guides/start/quickstart.mdx | 2 +- .../content/legal/annex-support-services.mdx | 1 + .../legal/data-processing-agreement.mdx | 1 + .../legal/policies/acceptable-use-policy.mdx | 1 + .../legal/policies/account-lockout-policy.mdx | 1 + .../legal/policies/brand-trademark-policy.mdx | 1 + .../policies/feature-development-policy.mdx | 1 + apps/docs/content/legal/policies/index.mdx | 2 +- .../content/legal/policies/privacy-policy.mdx | 1 + .../legal/policies/rate-limit-policy.mdx | 1 + .../vulnerability-disclosure-policy.mdx | 1 + .../cloud-service-description.mdx | 1 + .../legal/service-description/index.mdx | 2 +- .../service-level-description.mdx | 1 + .../service-description/support-services.mdx | 1 + apps/docs/content/legal/subprocessors.mdx | 1 + apps/docs/content/legal/terms-of-service.mdx | 1 + apps/docs/content/product/release-cycle.mdx | 1 + apps/docs/content/product/roadmap.mdx | 1 + apps/docs/content/sdk-examples/angular.mdx | 1 + apps/docs/content/sdk-examples/astro.mdx | 1 + .../sdk-examples/client-libraries/java.mdx | 1 + .../sdk-examples/client-libraries/node.mdx | 1 + .../sdk-examples/client-libraries/php.mdx | 1 + .../sdk-examples/client-libraries/python.mdx | 1 + .../sdk-examples/client-libraries/ruby.mdx | 1 + apps/docs/content/sdk-examples/django.mdx | 1 + apps/docs/content/sdk-examples/expressjs.mdx | 1 + apps/docs/content/sdk-examples/fastapi.mdx | 1 + apps/docs/content/sdk-examples/fastify.mdx | 1 + apps/docs/content/sdk-examples/flask.mdx | 1 + apps/docs/content/sdk-examples/flutter.mdx | 1 + apps/docs/content/sdk-examples/go.mdx | 1 + apps/docs/content/sdk-examples/hono.mdx | 1 + .../content/sdk-examples/introduction.mdx | 3 +- apps/docs/content/sdk-examples/java.mdx | 1 + apps/docs/content/sdk-examples/laravel.mdx | 1 + apps/docs/content/sdk-examples/nestjs.mdx | 1 + apps/docs/content/sdk-examples/nextjs.mdx | 1 + apps/docs/content/sdk-examples/nuxtjs.mdx | 1 + apps/docs/content/sdk-examples/qwik.mdx | 1 + apps/docs/content/sdk-examples/react.mdx | 1 + apps/docs/content/sdk-examples/solidstart.mdx | 1 + apps/docs/content/sdk-examples/spring.mdx | 1 + apps/docs/content/sdk-examples/sveltekit.mdx | 1 + apps/docs/content/sdk-examples/symfony.mdx | 1 + apps/docs/content/sdk-examples/vue.mdx | 1 + .../content/self-hosting/deploy/compose.mdx | 1 + .../self-hosting/deploy/devcontainer.mdx | 1 + .../deploy/kubernetes/caching.mdx | 1 + .../deploy/kubernetes/configuration.mdx | 1 + .../deploy/kubernetes/database.mdx | 1 + .../self-hosting/deploy/kubernetes/index.mdx | 1 + .../deploy/kubernetes/ingress.mdx | 1 + .../deploy/kubernetes/installation.mdx | 1 + .../deploy/kubernetes/observability.mdx | 1 + .../deploy/kubernetes/operations.mdx | 1 + .../deploy/kubernetes/uninstalling.mdx | 1 + .../content/self-hosting/deploy/linux.mdx | 1 + .../content/self-hosting/deploy/macos.mdx | 1 + .../content/self-hosting/deploy/overview.mdx | 3 +- .../troubleshooting/troubleshooting.mdx | 1 + .../content/self-hosting/manage/cache.mdx | 1 + .../self-hosting/manage/cli/mirror.mdx | 1 + .../self-hosting/manage/cli/overview.mdx | 1 + .../manage/configure/configure.mdx | 1 + .../self-hosting/manage/configure/index.mdx | 1 + .../self-hosting/manage/custom-domain.mdx | 3 +- .../self-hosting/manage/database/index.mdx | 3 +- .../content/self-hosting/manage/http2.mdx | 1 + .../self-hosting/manage/login-client.mdx | 7 +- .../self-hosting/manage/metrics/overview.mdx | 4 +- .../manage/metrics/prometheus.mdx | 4 +- .../self-hosting/manage/production.mdx | 3 +- .../manage/productionchecklist.mdx | 1 + .../manage/reverseproxy/caddy/index.mdx | 1 + .../reverseproxy/cloudflare_tunnel/index.mdx | 1 + .../manage/reverseproxy/httpd/index.mdx | 1 + .../manage/reverseproxy/nginx/index.mdx | 1 + .../manage/reverseproxy/reverse_proxy.mdx | 1 + .../manage/reverseproxy/traefik/index.mdx | 1 + .../self-hosting/manage/service_ping.mdx | 1 + .../content/self-hosting/manage/tls_modes.mdx | 1 + .../self-hosting/manage/updating_scaling.mdx | 1 + .../self-hosting/manage/usage_control.mdx | 1 + apps/docs/content/support/advisory/a10000.mdx | 1 + apps/docs/content/support/advisory/a10001.mdx | 1 + apps/docs/content/support/advisory/a10002.mdx | 1 + apps/docs/content/support/advisory/a10003.mdx | 1 + apps/docs/content/support/advisory/a10004.mdx | 1 + apps/docs/content/support/advisory/a10005.mdx | 1 + apps/docs/content/support/advisory/a10006.mdx | 1 + apps/docs/content/support/advisory/a10007.mdx | 1 + apps/docs/content/support/advisory/a10008.mdx | 1 + apps/docs/content/support/advisory/a10009.mdx | 1 + apps/docs/content/support/advisory/a10010.mdx | 1 + apps/docs/content/support/advisory/a10011.mdx | 1 + apps/docs/content/support/advisory/a10012.mdx | 1 + apps/docs/content/support/advisory/a10013.mdx | 1 + apps/docs/content/support/advisory/a10014.mdx | 1 + apps/docs/content/support/advisory/a10015.mdx | 1 + apps/docs/content/support/advisory/a10016.mdx | 1 + .../content/support/technical_advisory.mdx | 1 + apps/docs/content/support/troubleshooting.mdx | 1 + apps/docs/lib/sidebar-data.ts | 24 +++--- apps/docs/scripts/generate-api-reference.mts | 84 +++++++++++++++++++ .../api/assets/generator/asset_generator.go | 1 + 304 files changed, 421 insertions(+), 46 deletions(-) diff --git a/apps/docs/app/[[...slug]]/page.tsx b/apps/docs/app/[[...slug]]/page.tsx index bd00570d7..a4bdf1592 100644 --- a/apps/docs/app/[[...slug]]/page.tsx +++ b/apps/docs/app/[[...slug]]/page.tsx @@ -1,7 +1,6 @@ import { getPageImage, getPage, source } from '@/lib/source'; import { DocsBody, - DocsDescription, DocsPage, DocsTitle, } from 'fumadocs-ui/layouts/docs/page'; @@ -23,7 +22,6 @@ export default async function Page(props: any) { return ( {page.data.title} - {page.data.description} 200 ? description.substring(0, 197) + '...' : description, alternates: { canonical: canonicalUrl, }, diff --git a/apps/docs/app/layout.tsx b/apps/docs/app/layout.tsx index f894bd4cc..22ce19580 100644 --- a/apps/docs/app/layout.tsx +++ b/apps/docs/app/layout.tsx @@ -4,6 +4,10 @@ import { Providers } from './providers'; export const metadata: Metadata = { metadataBase: new URL(process.env.NEXT_PUBLIC_SITE_URL || 'http://localhost:3000'), + title: { + template: '%s | ZITADEL Docs', + default: 'ZITADEL Documentation', + }, icons: { other: [ { diff --git a/apps/docs/content/apis/actions/code-examples.mdx b/apps/docs/content/apis/actions/code-examples.mdx index c70782369..e82ff37a2 100644 --- a/apps/docs/content/apis/actions/code-examples.mdx +++ b/apps/docs/content/apis/actions/code-examples.mdx @@ -1,5 +1,6 @@ --- title: Code examples +description: "Practical code examples for ZITADEL Actions, from custom claims to external API integration." --- Actions are a powerful tool to extend ZITADEL, and you might wonder what use cases actions can be used for. diff --git a/apps/docs/content/apis/actions/complement-token.mdx b/apps/docs/content/apis/actions/complement-token.mdx index 1e8f09104..b01c803bc 100644 --- a/apps/docs/content/apis/actions/complement-token.mdx +++ b/apps/docs/content/apis/actions/complement-token.mdx @@ -1,5 +1,6 @@ --- title: Complement Token Flow +description: "Complement Token Flow in ZITADEL Actions to add custom claims to your ID and access tokens." --- This flow is executed during the creation of tokens and token introspection. diff --git a/apps/docs/content/apis/actions/customize-samlresponse.mdx b/apps/docs/content/apis/actions/customize-samlresponse.mdx index 381319d02..79ee46f43 100644 --- a/apps/docs/content/apis/actions/customize-samlresponse.mdx +++ b/apps/docs/content/apis/actions/customize-samlresponse.mdx @@ -1,5 +1,6 @@ --- title: Complement SAMLResponse +description: "Customize and enrich SAML responses via ZITADEL Actions before they are returned to the service provider." --- This flow is executed before the return of the SAML Response. diff --git a/apps/docs/content/apis/actions/external-authentication.mdx b/apps/docs/content/apis/actions/external-authentication.mdx index 3eb5e51f6..39aa4a832 100644 --- a/apps/docs/content/apis/actions/external-authentication.mdx +++ b/apps/docs/content/apis/actions/external-authentication.mdx @@ -1,5 +1,6 @@ --- title: External Authentication Flow +description: "Trigger custom JavaScript logic in ZITADEL Actions during the authentication flow for external identity providers." --- This flow is executed if the user logs in using an [identity provider](/guides/integrate/identity-providers/introduction). diff --git a/apps/docs/content/apis/actions/internal-authentication.mdx b/apps/docs/content/apis/actions/internal-authentication.mdx index c6cab5eba..51a2f6366 100644 --- a/apps/docs/content/apis/actions/internal-authentication.mdx +++ b/apps/docs/content/apis/actions/internal-authentication.mdx @@ -1,5 +1,6 @@ --- title: Internal Authentication Flow +description: "Add custom business logic to the internal ZITADEL authentication flow after a successful login." --- This flow is executed if the user logs in using the login UI hosted by ZITADEL. diff --git a/apps/docs/content/apis/actions/modules.mdx b/apps/docs/content/apis/actions/modules.mdx index 71b42097a..c070277fb 100644 --- a/apps/docs/content/apis/actions/modules.mdx +++ b/apps/docs/content/apis/actions/modules.mdx @@ -1,5 +1,6 @@ --- title: Modules +description: "The reference of built-in modules available in ZITADEL Actions, including the fetch API for HTTP requests." --- ZITADEL provides the following modules. diff --git a/apps/docs/content/apis/actions/objects.mdx b/apps/docs/content/apis/actions/objects.mdx index ab712ffb0..834b46b9a 100644 --- a/apps/docs/content/apis/actions/objects.mdx +++ b/apps/docs/content/apis/actions/objects.mdx @@ -1,5 +1,6 @@ --- title: Objects +description: "Documentation for the objects and data structures available within the ZITADEL Actions JavaScript environment." --- ## External User diff --git a/apps/docs/content/apis/apis/index.mdx b/apps/docs/content/apis/apis/index.mdx index 831fb3226..72b2e43e3 100644 --- a/apps/docs/content/apis/apis/index.mdx +++ b/apps/docs/content/apis/apis/index.mdx @@ -1,6 +1,7 @@ --- title: Core Resources sidebar_label: Core Resources +description: Reference ZITADEL core APIs for managing systems, instances, users, and projects across multiple versions --- import DocCardList from '@/components/docusaurus/doc-card-list'; diff --git a/apps/docs/content/apis/assets/assets.mdx b/apps/docs/content/apis/assets/assets.mdx index e54e71d6b..b462bdceb 100755 --- a/apps/docs/content/apis/assets/assets.mdx +++ b/apps/docs/content/apis/assets/assets.mdx @@ -1,5 +1,6 @@ --- title: zitadel/assets +description: "Learn how to upload and manage instance, organization, or user assets such as logos and avatars using ZITADEL's AssetsService API endpoints. Full reference and examples included." --- {/* diff --git a/apps/docs/content/apis/benchmarks/index.mdx b/apps/docs/content/apis/benchmarks/index.mdx index 94dc94a2b..7b693f033 100644 --- a/apps/docs/content/apis/benchmarks/index.mdx +++ b/apps/docs/content/apis/benchmarks/index.mdx @@ -1,6 +1,7 @@ --- title: Benchmarks sidebar_label: Benchmarks +description: Analyze ZITADEL performance benchmarks to understand resource requirements for specific workloads --- diff --git a/apps/docs/content/apis/introduction.mdx b/apps/docs/content/apis/introduction.mdx index b9726d42f..e8a726b1d 100644 --- a/apps/docs/content/apis/introduction.mdx +++ b/apps/docs/content/apis/introduction.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL API Reference Overview +description: "Explore ZITADEL's APIs for authentication and authorization. Integrate identity management using OpenID Connect, OAuth 2.0, and SAML standards." sidebar_label: Overview --- diff --git a/apps/docs/content/apis/migration_v1_to_v2.mdx b/apps/docs/content/apis/migration_v1_to_v2.mdx index c6f49231b..9e15ab6fb 100644 --- a/apps/docs/content/apis/migration_v1_to_v2.mdx +++ b/apps/docs/content/apis/migration_v1_to_v2.mdx @@ -1,5 +1,6 @@ --- title: Migrate from v1 APIs to v2 APIs +description: "Migrate from ZITADEL's v1 APIs to v2 APIs and adopt a resource-based architecture for improved intuitiveness and efficiency" --- This guide gives you an overview for migrating from our v1 API to the new and improved v2 API. diff --git a/apps/docs/content/apis/observability/health.mdx b/apps/docs/content/apis/observability/health.mdx index 4e8234868..9f4fae3f3 100644 --- a/apps/docs/content/apis/observability/health.mdx +++ b/apps/docs/content/apis/observability/health.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Ready and Health Endpoints +description: "Check ZITADEL's readiness and health status using /debug/ready and /debug/healthz endpoints for system monitoring and maintenance" sidebar_label: Ready and Health Endpoints --- diff --git a/apps/docs/content/apis/observability/metrics.mdx b/apps/docs/content/apis/observability/metrics.mdx index 9588c139f..d64b38405 100644 --- a/apps/docs/content/apis/observability/metrics.mdx +++ b/apps/docs/content/apis/observability/metrics.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Metrics +description: "Expose ZITADEL Metrics via the /debug/metrics endpoint to monitor and analyze performance with tools like Prometheus" sidebar_label: Metrics --- diff --git a/apps/docs/content/apis/openidoauth/authn-methods.mdx b/apps/docs/content/apis/openidoauth/authn-methods.mdx index 3f175dc7f..b0c7f8eaf 100644 --- a/apps/docs/content/apis/openidoauth/authn-methods.mdx +++ b/apps/docs/content/apis/openidoauth/authn-methods.mdx @@ -1,5 +1,6 @@ --- title: Authentication Methods in ZITADEL +description: "The supported client authentication methods in ZITADEL, including Client Secret and JWT." sidebar_label: Authentication Methods --- diff --git a/apps/docs/content/apis/openidoauth/authrequest.mdx b/apps/docs/content/apis/openidoauth/authrequest.mdx index ace3fadbb..714b3bc9f 100644 --- a/apps/docs/content/apis/openidoauth/authrequest.mdx +++ b/apps/docs/content/apis/openidoauth/authrequest.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL OIDC Authentication Request Playground +description: "The OIDC playground for testing and constructing authentication requests." sidebar_label: OIDC Playground --- diff --git a/apps/docs/content/apis/openidoauth/claims.mdx b/apps/docs/content/apis/openidoauth/claims.mdx index b437f6bf6..b1dcec380 100644 --- a/apps/docs/content/apis/openidoauth/claims.mdx +++ b/apps/docs/content/apis/openidoauth/claims.mdx @@ -1,5 +1,6 @@ --- title: Claims in ZITADEL +description: "Standard OIDC and custom claims issued by ZITADEL in ID tokens, access tokens, and via the Userinfo endpoint." sidebar_label: Claims --- diff --git a/apps/docs/content/apis/openidoauth/endpoints.mdx b/apps/docs/content/apis/openidoauth/endpoints.mdx index 35d0864d5..31f46e1b2 100644 --- a/apps/docs/content/apis/openidoauth/endpoints.mdx +++ b/apps/docs/content/apis/openidoauth/endpoints.mdx @@ -1,5 +1,6 @@ --- title: OpenID Connect Endpoints in ZITADEL +description: "The standard OIDC and OAuth 2.0 endpoints for ZITADEL, adhering to the OpenID Connect 1.0 standard." sidebar_label: OpenID Connect Endpoints --- diff --git a/apps/docs/content/apis/openidoauth/grant-types.mdx b/apps/docs/content/apis/openidoauth/grant-types.mdx index a354167da..bd3031730 100644 --- a/apps/docs/content/apis/openidoauth/grant-types.mdx +++ b/apps/docs/content/apis/openidoauth/grant-types.mdx @@ -1,5 +1,6 @@ --- title: Grant Types in ZITADEL +description: "The OAuth 2.0 grant types supported by ZITADEL, such as Authorization Code and Client Credentials." sidebar_label: Grant Types --- diff --git a/apps/docs/content/apis/openidoauth/scopes.mdx b/apps/docs/content/apis/openidoauth/scopes.mdx index 66be8868a..692d832a9 100644 --- a/apps/docs/content/apis/openidoauth/scopes.mdx +++ b/apps/docs/content/apis/openidoauth/scopes.mdx @@ -1,5 +1,6 @@ --- title: Scopes in ZITADEL +description: "The standard and ZITADEL-specific OIDC scopes available for identity and authentication requests." sidebar_label: Scopes --- diff --git a/apps/docs/content/apis/saml/endpoints.mdx b/apps/docs/content/apis/saml/endpoints.mdx index 7d1d6f08f..9c704ac57 100644 --- a/apps/docs/content/apis/saml/endpoints.mdx +++ b/apps/docs/content/apis/saml/endpoints.mdx @@ -1,5 +1,6 @@ --- title: SAML Endpoints in ZITADEL +description: "SAML 2.0 endpoints and metadata available in ZITADEL for service provider configuration." --- ## SAML 2.0 metadata diff --git a/apps/docs/content/apis/scim2.mdx b/apps/docs/content/apis/scim2.mdx index c2cd7b451..e27932687 100644 --- a/apps/docs/content/apis/scim2.mdx +++ b/apps/docs/content/apis/scim2.mdx @@ -1,8 +1,9 @@ --- title: SCIM v2.0 (Preview) +description: "Manage instance resources using the SCIM v2.0 API for identity and access integration with ZITADEL" --- -The Zitadel [SCIM v2](https://scim.cloud/) service provider interface enables seamless integration of identity and +The Zitadel [SCIM v2](https://scim.cloud/) service provider interface enables integration of identity and access management (instance) systems with Zitadel, following the System for Cross-domain Identity Management (SCIM) v2.0 specification. This interface allows standardized management of instance resources, making it easier to automate user provisioning and diff --git a/apps/docs/content/apis/statuscodes.mdx b/apps/docs/content/apis/statuscodes.mdx index 7760b2865..a5b800d37 100644 --- a/apps/docs/content/apis/statuscodes.mdx +++ b/apps/docs/content/apis/statuscodes.mdx @@ -1,5 +1,6 @@ --- title: GRPC Status Codes in ZITADEL +description: "Mapping of gRPC status codes to their corresponding HTTP status codes in ZITADEL API responses." sidebar_label: GRPC Status Codes --- diff --git a/apps/docs/content/apis/v2.mdx b/apps/docs/content/apis/v2.mdx index c050edaaa..fed422b13 100644 --- a/apps/docs/content/apis/v2.mdx +++ b/apps/docs/content/apis/v2.mdx @@ -1,5 +1,6 @@ --- title: APIs V2 (Generally Available) +description: "Explore ZITADEL APIs V2. Organize access by resource and simplify API integration for multi-organization use cases." --- import DocCardList from '@/components/docusaurus/doc-card-list'; diff --git a/apps/docs/content/concepts/architecture/secrets.mdx b/apps/docs/content/concepts/architecture/secrets.mdx index dfd5c1d42..6aecaf9ed 100644 --- a/apps/docs/content/concepts/architecture/secrets.mdx +++ b/apps/docs/content/concepts/architecture/secrets.mdx @@ -1,5 +1,6 @@ --- title: How ZITADEL Processes and Stores Secrets +description: "How ZITADEL manages and protects secrets through encryption, hashing, and rotation mechanisms." sidebar_label: Secrets --- diff --git a/apps/docs/content/concepts/architecture/software.mdx b/apps/docs/content/concepts/architecture/software.mdx index ad813daec..81f0141e3 100644 --- a/apps/docs/content/concepts/architecture/software.mdx +++ b/apps/docs/content/concepts/architecture/software.mdx @@ -1,5 +1,6 @@ --- title: Zitadel's Software Architecture +description: "The software architecture of ZITADEL, built on Event Sourcing and CQRS patterns for audit trails, consistency, and scalability." sidebar_label: Software Architecture --- diff --git a/apps/docs/content/concepts/architecture/solution.mdx b/apps/docs/content/concepts/architecture/solution.mdx index 08c72b78b..c0005a2ac 100644 --- a/apps/docs/content/concepts/architecture/solution.mdx +++ b/apps/docs/content/concepts/architecture/solution.mdx @@ -1,5 +1,6 @@ --- title: Zitadel's Deployment Architecture +description: "Overview of ZITADEL's high-availability and multi-region deployment strategies for scalable and resilient identity services" sidebar_label: Deployment Architecture --- diff --git a/apps/docs/content/concepts/eventstore/implementation.mdx b/apps/docs/content/concepts/eventstore/implementation.mdx index 1f67e8bb7..b09d92d44 100644 --- a/apps/docs/content/concepts/eventstore/implementation.mdx +++ b/apps/docs/content/concepts/eventstore/implementation.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Database Structure +description: "Overview of ZITADEL's database schema, focusing on event storage and projection tables." sidebar_label: Database Structure --- diff --git a/apps/docs/content/concepts/eventstore/overview.mdx b/apps/docs/content/concepts/eventstore/overview.mdx index 7b5fa4633..f5a1de533 100644 --- a/apps/docs/content/concepts/eventstore/overview.mdx +++ b/apps/docs/content/concepts/eventstore/overview.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Event Store +description: "Implement Event Sourcing with ZITADEL's Event Store to track changes and derive system state from immutable events" sidebar_label: Overview --- diff --git a/apps/docs/content/concepts/features/account-linking.mdx b/apps/docs/content/concepts/features/account-linking.mdx index 3887822a3..eb1cc2ab1 100644 --- a/apps/docs/content/concepts/features/account-linking.mdx +++ b/apps/docs/content/concepts/features/account-linking.mdx @@ -1,5 +1,6 @@ --- title: Account linking +description: "Link multiple identities from social or enterprise IdPs to a single ZITADEL user profile for SSO and unified auditing." --- ZITADEL supports linking user accounts from different external identity providers, such as social logins or enterprise IdPs, to a single ZITADEL user profile. This enables users to be recognized as the same user in your applications, regardless of which external account they use to log in. diff --git a/apps/docs/content/concepts/features/actions.mdx b/apps/docs/content/concepts/features/actions.mdx index e6b1b7205..701a19eea 100644 --- a/apps/docs/content/concepts/features/actions.mdx +++ b/apps/docs/content/concepts/features/actions.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Actions +description: "Customize authentication and authorization flows by adding custom JavaScript business logic to specific trigger points." sidebar_label: Actions --- diff --git a/apps/docs/content/concepts/features/actions_v2.mdx b/apps/docs/content/concepts/features/actions_v2.mdx index c574e6eb8..c8231a4ae 100644 --- a/apps/docs/content/concepts/features/actions_v2.mdx +++ b/apps/docs/content/concepts/features/actions_v2.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Actions v2 +description: "Execute custom logic on API calls, events, or functions with ZITADEL Actions v2 to meet specific business requirements." sidebar_label: Actions v2 --- diff --git a/apps/docs/content/concepts/features/audit-trail.mdx b/apps/docs/content/concepts/features/audit-trail.mdx index b68a2b9c8..4421bbf45 100644 --- a/apps/docs/content/concepts/features/audit-trail.mdx +++ b/apps/docs/content/concepts/features/audit-trail.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL's In-built Audit Trail +description: "Track all system changes and user events with ZITADEL's audit trail to maintain historical records for compliance." sidebar_label: Audit Trail --- diff --git a/apps/docs/content/concepts/features/custom-domain.mdx b/apps/docs/content/concepts/features/custom-domain.mdx index 04295d9a2..d18328ab7 100644 --- a/apps/docs/content/concepts/features/custom-domain.mdx +++ b/apps/docs/content/concepts/features/custom-domain.mdx @@ -1,5 +1,6 @@ --- title: Custom Domain +description: "Use your own custom domain for ZITADEL to provide a branded, professional, and secure authentication experience." sidebar_label: Custom Domain --- diff --git a/apps/docs/content/concepts/features/external-user-grant.mdx b/apps/docs/content/concepts/features/external-user-grant.mdx index a103bbd10..c61a6f0e1 100644 --- a/apps/docs/content/concepts/features/external-user-grant.mdx +++ b/apps/docs/content/concepts/features/external-user-grant.mdx @@ -1,5 +1,6 @@ --- title: External User Role Assignments +description: "Grant access to projects for external users from other organizations using ZITADEL's external user role assignments" --- ZITADEL's external user role assignment is a feature that allows you to grant access to projects within your organization to users from other organizations. diff --git a/apps/docs/content/concepts/features/identity-brokering.mdx b/apps/docs/content/concepts/features/identity-brokering.mdx index 96143959c..eef61c304 100644 --- a/apps/docs/content/concepts/features/identity-brokering.mdx +++ b/apps/docs/content/concepts/features/identity-brokering.mdx @@ -1,5 +1,6 @@ --- title: Identity Brokering +description: "Establish trust between your central IdP and third-party providers for login with preferred identity sources" sidebar_label: Identity Brokering --- diff --git a/apps/docs/content/concepts/features/index.mdx b/apps/docs/content/concepts/features/index.mdx index 0d2df7f1d..f6635ff66 100644 --- a/apps/docs/content/concepts/features/index.mdx +++ b/apps/docs/content/concepts/features/index.mdx @@ -1,5 +1,6 @@ --- title: Features +description: Explore core ZITADEL features including identity brokering, audit trails, and self-service --- diff --git a/apps/docs/content/concepts/features/passkeys.mdx b/apps/docs/content/concepts/features/passkeys.mdx index 4d43aa38a..281485bdb 100644 --- a/apps/docs/content/concepts/features/passkeys.mdx +++ b/apps/docs/content/concepts/features/passkeys.mdx @@ -1,5 +1,6 @@ --- title: "Passkeys in ZITADEL: Passwordless phishing-resistant authentication" +description: "Implement modern phishing-resistant passwordless authentication with FIDO2 passkeys." sidebar_label: Passkeys --- diff --git a/apps/docs/content/concepts/features/selfservice.mdx b/apps/docs/content/concepts/features/selfservice.mdx index 87f85d59e..48a2695d0 100644 --- a/apps/docs/content/concepts/features/selfservice.mdx +++ b/apps/docs/content/concepts/features/selfservice.mdx @@ -1,5 +1,6 @@ --- title: Self Service in ZITADEL +description: "Enable self-service registration, login, and profile management to reduce administrative overhead and improve user experience." sidebar_label: Self Service --- diff --git a/apps/docs/content/concepts/index.mdx b/apps/docs/content/concepts/index.mdx index 231a5170c..03cd97666 100644 --- a/apps/docs/content/concepts/index.mdx +++ b/apps/docs/content/concepts/index.mdx @@ -1,6 +1,6 @@ --- title: "Key Concepts" -description: "This part of our documentation contains ZITADEL specific or general concepts required to understand the system or our guides." +description: "Learn about ZITADEL's core architecture and terminology. This section covers identity management concepts, multi-tenancy, and technical structures essential for understanding our platform." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/concepts/knowledge/index.mdx b/apps/docs/content/concepts/knowledge/index.mdx index 6b7ad84eb..06fad14c8 100644 --- a/apps/docs/content/concepts/knowledge/index.mdx +++ b/apps/docs/content/concepts/knowledge/index.mdx @@ -1,5 +1,6 @@ --- title: Knowledge +description: Explore technical concepts and knowledge base articles for ZITADEL identity management --- diff --git a/apps/docs/content/concepts/knowledge/opaque-tokens.mdx b/apps/docs/content/concepts/knowledge/opaque-tokens.mdx index 095a2b85a..680d2c6a8 100644 --- a/apps/docs/content/concepts/knowledge/opaque-tokens.mdx +++ b/apps/docs/content/concepts/knowledge/opaque-tokens.mdx @@ -1,5 +1,6 @@ --- -title: "Opaque Tokens in Zitadel: Enhancing Application Security" +title: "Opaque Tokens in Zitadel" +description: "Introduction to opaque tokens in ZITADEL, their security benefits, and how to validate them via the introspection endpoint" sidebar_label: Opaque tokens --- diff --git a/apps/docs/content/concepts/principles.mdx b/apps/docs/content/concepts/principles.mdx index 48abb7536..bc6d79e01 100644 --- a/apps/docs/content/concepts/principles.mdx +++ b/apps/docs/content/concepts/principles.mdx @@ -1,5 +1,6 @@ --- title: Principles +description: "Overview of ZITADEL's core engineering and design principles, emphasizing transparency, scalability, and event sourcing." --- ## ZITADEL engineering and design principles diff --git a/apps/docs/content/concepts/structure/administrators.mdx b/apps/docs/content/concepts/structure/administrators.mdx index 196748d64..fe0f9d57f 100644 --- a/apps/docs/content/concepts/structure/administrators.mdx +++ b/apps/docs/content/concepts/structure/administrators.mdx @@ -1,5 +1,6 @@ --- title: Administrators +description: "Overview of administrative roles in ZITADEL, ranging from System Users to Instance and Organization Admins." sidebar_label: Administrators --- diff --git a/apps/docs/content/concepts/structure/granted_projects.mdx b/apps/docs/content/concepts/structure/granted_projects.mdx index 9bccc6c21..96e2c51bb 100644 --- a/apps/docs/content/concepts/structure/granted_projects.mdx +++ b/apps/docs/content/concepts/structure/granted_projects.mdx @@ -1,9 +1,10 @@ --- title: ZITADEL's Granted Projects +description: "Delegate user management for project roles to external organizations using Project Grants." sidebar_label: Granted Projects --- -# Granted Project +## Granted Project ![Project Grant](../../../public/img/concepts/objects/project_grants.png) diff --git a/apps/docs/content/concepts/structure/index.mdx b/apps/docs/content/concepts/structure/index.mdx index d59449977..924122e51 100644 --- a/apps/docs/content/concepts/structure/index.mdx +++ b/apps/docs/content/concepts/structure/index.mdx @@ -1,5 +1,6 @@ --- title: Structure +description: Explore the hierarchical structure of ZITADEL instances, organizations, and resource ownership --- diff --git a/apps/docs/content/concepts/structure/instance.mdx b/apps/docs/content/concepts/structure/instance.mdx index 3a902798f..22d55ff8e 100644 --- a/apps/docs/content/concepts/structure/instance.mdx +++ b/apps/docs/content/concepts/structure/instance.mdx @@ -1,5 +1,6 @@ --- title: Instances +description: "Overview of ZITADEL Instances—the virtual tenants providing full data isolation and independent settings." sidebar_label: Instances --- diff --git a/apps/docs/content/concepts/structure/policies.mdx b/apps/docs/content/concepts/structure/policies.mdx index adfe072c5..c9b66a66d 100644 --- a/apps/docs/content/concepts/structure/policies.mdx +++ b/apps/docs/content/concepts/structure/policies.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Settings and Policies +description: "Manage and override default behaviors with policies for authentication, password complexity, and security." sidebar_label: Setting and Policies --- diff --git a/apps/docs/content/examples/identity-proxy/oauth2-proxy.mdx b/apps/docs/content/examples/identity-proxy/oauth2-proxy.mdx index 911411ec8..91fd92f5c 100644 --- a/apps/docs/content/examples/identity-proxy/oauth2-proxy.mdx +++ b/apps/docs/content/examples/identity-proxy/oauth2-proxy.mdx @@ -1,5 +1,6 @@ --- title: OAuth 2.0 Proxy +description: "Configure OAuth2-proxy with ZITADEL as an Identity Provider (IdP) using the Authorization Code flow." --- [OAuth2-proxy](https://github.com/oauth2-proxy/oauth2-proxy) is a project which allows services to delegate the authentication flow to a IDP, for example **ZITADEL** diff --git a/apps/docs/content/examples/introduction/backend/index.mdx b/apps/docs/content/examples/introduction/backend/index.mdx index 1f5372cfa..fd7969973 100644 --- a/apps/docs/content/examples/introduction/backend/index.mdx +++ b/apps/docs/content/examples/introduction/backend/index.mdx @@ -1,6 +1,6 @@ --- title: "APIs / Backend Quickstart Guides" -description: "Quickstart guides for integrating ZITADEL authentication into APIs / Backend Services." +description: "Learn how to secure your APIs and backend services using ZITADEL. Includes examples for Node.js, Python, Go, Java, and NestJS to implement robust authentication." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/examples/introduction/frontend/index.mdx b/apps/docs/content/examples/introduction/frontend/index.mdx index 8f0cd1f35..c7c6fab27 100644 --- a/apps/docs/content/examples/introduction/frontend/index.mdx +++ b/apps/docs/content/examples/introduction/frontend/index.mdx @@ -1,6 +1,6 @@ --- title: "Frontend (SPA) Quickstart Guides" -description: "Quickstart guides for integrating ZITADEL authentication into frontend single-page applications." +description: "Step-by-step instructions for integrating ZITADEL authentication into your frontend single-page applications. Includes guides for React, Angular, Vue, and vanilla JS." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/examples/introduction/fullstack/index.mdx b/apps/docs/content/examples/introduction/fullstack/index.mdx index 148c1f7c2..3e105464a 100644 --- a/apps/docs/content/examples/introduction/fullstack/index.mdx +++ b/apps/docs/content/examples/introduction/fullstack/index.mdx @@ -1,6 +1,6 @@ --- title: "Full-Stack / SSR Quickstart Guides" -description: "Quickstart guides for integrating ZITADEL authentication into Full-Stack / SSR applications." +description: "Integrate ZITADEL with your full-stack and server-side rendered (SSR) applications. Follow our guides for Next.js, B2B scenarios, and other modern web frameworks." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/examples/introduction/index.mdx b/apps/docs/content/examples/introduction/index.mdx index 98420e693..6b6ccb020 100644 --- a/apps/docs/content/examples/introduction/index.mdx +++ b/apps/docs/content/examples/introduction/index.mdx @@ -1,6 +1,6 @@ --- title: "Example Applications" -description: "Practical examples showing how to integrate ZITADEL authentication and secure APIs across different application types and frameworks." +description: "Discover practical quickstart guides and example applications for ZITADEL. We provide step-by-step instructions for popular frameworks like React, Angular, Vue, Next.js, and more." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/examples/introduction/mobile/index.mdx b/apps/docs/content/examples/introduction/mobile/index.mdx index 1e35d7d37..82e5a5fdf 100644 --- a/apps/docs/content/examples/introduction/mobile/index.mdx +++ b/apps/docs/content/examples/introduction/mobile/index.mdx @@ -1,6 +1,6 @@ --- title: "Mobile & Native Quickstart Guides" -description: "Quickstart guides for integrating ZITADEL authentication into Mobile & Native applications." +description: "Quickstart guides for integrating ZITADEL authentication into mobile and native applications. Learn how to secure your mobile apps with our Flutter and .NET guides." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/examples/introduction/webapp/index.mdx b/apps/docs/content/examples/introduction/webapp/index.mdx index 4e802ae0b..46f7f23fe 100644 --- a/apps/docs/content/examples/introduction/webapp/index.mdx +++ b/apps/docs/content/examples/introduction/webapp/index.mdx @@ -1,6 +1,6 @@ --- title: "Web App (Server-Side) Quickstart Guides" -description: "Quickstart guides for integrating ZITADEL authentication into Web App (Server-Side) applications." +description: "Step-by-step guides for integrating ZITADEL into traditional server-side web applications. Learn how to secure Java Spring, PHP Symfony, Django, and Go apps." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/examples/login/angular.mdx b/apps/docs/content/examples/login/angular.mdx index 3cee11524..9e06a0d6c 100644 --- a/apps/docs/content/examples/login/angular.mdx +++ b/apps/docs/content/examples/login/angular.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Angular +description: "Integrate ZITADEL into Angular applications using OIDC and PKCE for user authentication." sidebar_label: Angular --- diff --git a/apps/docs/content/examples/login/flutter.mdx b/apps/docs/content/examples/login/flutter.mdx index 9391a7a99..6bea9b636 100644 --- a/apps/docs/content/examples/login/flutter.mdx +++ b/apps/docs/content/examples/login/flutter.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Flutter +description: "Integrate ZITADEL into a Flutter app using OAuth 2.0 with PKCE to authenticate users via custom scheme and secure tokens" sidebar_label: Flutter --- diff --git a/apps/docs/content/examples/login/go.mdx b/apps/docs/content/examples/login/go.mdx index 659a3f4e6..aaac601ba 100644 --- a/apps/docs/content/examples/login/go.mdx +++ b/apps/docs/content/examples/login/go.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Go +description: "Integrate ZITADEL for user login and profile retrieval in Go web applications." sidebar_label: Go --- diff --git a/apps/docs/content/examples/login/java-spring.mdx b/apps/docs/content/examples/login/java-spring.mdx index 02772c55c..547e4f504 100644 --- a/apps/docs/content/examples/login/java-spring.mdx +++ b/apps/docs/content/examples/login/java-spring.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Java Spring Boot +description: "Integrate ZITADEL into Java Spring Boot applications for user login and profile retrieval using OIDC." sidebar_label: Java Spring Boot --- diff --git a/apps/docs/content/examples/login/nextjs-b2b.mdx b/apps/docs/content/examples/login/nextjs-b2b.mdx index 0994ca474..d64c06fc9 100644 --- a/apps/docs/content/examples/login/nextjs-b2b.mdx +++ b/apps/docs/content/examples/login/nextjs-b2b.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Next.js – A B2B Scenario +description: "Authenticate users across multiple organizations using ZITADEL and the Next.js B2B template." sidebar_label: Next.js – B2B --- diff --git a/apps/docs/content/examples/login/nextjs.mdx b/apps/docs/content/examples/login/nextjs.mdx index 2db9bf0fa..91eafa189 100644 --- a/apps/docs/content/examples/login/nextjs.mdx +++ b/apps/docs/content/examples/login/nextjs.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Next.js +description: "Integrate ZITADEL authentication in Next.js applications using OIDC and the Authorization Code flow." sidebar_label: Next.js --- diff --git a/apps/docs/content/examples/login/python-django.mdx b/apps/docs/content/examples/login/python-django.mdx index cab6b8f93..0d8ca4414 100644 --- a/apps/docs/content/examples/login/python-django.mdx +++ b/apps/docs/content/examples/login/python-django.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Django Python +description: "Integrate ZITADEL into Python Django applications for user login and role mapping using OIDC." sidebar_label: Django --- diff --git a/apps/docs/content/examples/login/react.mdx b/apps/docs/content/examples/login/react.mdx index 9ff1b4446..5778cf219 100644 --- a/apps/docs/content/examples/login/react.mdx +++ b/apps/docs/content/examples/login/react.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with React +description: "Integrate ZITADEL into React applications for user login and profile management using OIDC and PKCE." sidebar_label: React --- diff --git a/apps/docs/content/examples/login/symfony.mdx b/apps/docs/content/examples/login/symfony.mdx index cda2cf284..512f02ea0 100644 --- a/apps/docs/content/examples/login/symfony.mdx +++ b/apps/docs/content/examples/login/symfony.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Symfony PHP +description: "Integrate ZITADEL into Symfony PHP applications for user login and profile management using OIDC." sidebar_label: Symfony --- diff --git a/apps/docs/content/examples/login/vue.mdx b/apps/docs/content/examples/login/vue.mdx index cfd6145f5..80fa1c2dd 100644 --- a/apps/docs/content/examples/login/vue.mdx +++ b/apps/docs/content/examples/login/vue.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Vue +description: "Integrate ZITADEL with a Vue application to enable secure user login and fetch user profile data using OIDC" sidebar_label: Vue --- diff --git a/apps/docs/content/examples/secure-api/go.mdx b/apps/docs/content/examples/secure-api/go.mdx index 4b5e01474..cdaf7cea4 100644 --- a/apps/docs/content/examples/secure-api/go.mdx +++ b/apps/docs/content/examples/secure-api/go.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Go +description: "Secure Go APIs using OAuth 2.0 Token Introspection with ZITADEL and role-based authorization." sidebar_label: Go --- diff --git a/apps/docs/content/examples/secure-api/java-spring.mdx b/apps/docs/content/examples/secure-api/java-spring.mdx index 623c357e7..b434294d5 100644 --- a/apps/docs/content/examples/secure-api/java-spring.mdx +++ b/apps/docs/content/examples/secure-api/java-spring.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Java Spring Boot +description: "Secure Java Spring Boot APIs using OAuth 2.0 Token Introspection with ZITADEL." sidebar_label: Java Spring Boot --- diff --git a/apps/docs/content/examples/secure-api/nodejs-nestjs.mdx b/apps/docs/content/examples/secure-api/nodejs-nestjs.mdx index 833f44d62..f4b5538e4 100644 --- a/apps/docs/content/examples/secure-api/nodejs-nestjs.mdx +++ b/apps/docs/content/examples/secure-api/nodejs-nestjs.mdx @@ -1,9 +1,10 @@ --- title: ZITADEL with Node.js +description: "Secure Node.js APIs in NestJS by validating access tokens with ZITADEL's introspection endpoint." sidebar_label: NestJS --- -# ZITADEL with Node.js (NestJS) +## ZITADEL with Node.js (NestJS) This documentation section guides you through the process of integrating ZITADEL into your Node.js backend using the NestJS framework. The provided example demonstrates authentication using an OIDC (OAuth2) token introspection strategy with a ZITADEL service account for machine-to-machine communication. diff --git a/apps/docs/content/examples/secure-api/pylon.mdx b/apps/docs/content/examples/secure-api/pylon.mdx index 3857731f2..b82737e3f 100644 --- a/apps/docs/content/examples/secure-api/pylon.mdx +++ b/apps/docs/content/examples/secure-api/pylon.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Pylon +description: "Integrate ZITADEL with Pylon services by validating tokens and checking permissions for secure API endpoints" sidebar_label: Pylon --- diff --git a/apps/docs/content/examples/secure-api/python-django.mdx b/apps/docs/content/examples/secure-api/python-django.mdx index 4bdba66c4..4b9814ad0 100644 --- a/apps/docs/content/examples/secure-api/python-django.mdx +++ b/apps/docs/content/examples/secure-api/python-django.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Django Python +description: "Integrate ZITADEL with Django Python to validate tokens and check permissions for secure API access using OIDC protocol standards" sidebar_label: Django --- diff --git a/apps/docs/content/examples/secure-api/python-flask.mdx b/apps/docs/content/examples/secure-api/python-flask.mdx index cf9f66b7c..164dda7ff 100644 --- a/apps/docs/content/examples/secure-api/python-flask.mdx +++ b/apps/docs/content/examples/secure-api/python-flask.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL with Python +description: "Secure Python Flask APIs with ZITADEL token validation and role-based access control." sidebar_label: Python --- diff --git a/apps/docs/content/guides/integrate/actions/migrate-from-v1.mdx b/apps/docs/content/guides/integrate/actions/migrate-from-v1.mdx index 5700fd1bf..408874be0 100644 --- a/apps/docs/content/guides/integrate/actions/migrate-from-v1.mdx +++ b/apps/docs/content/guides/integrate/actions/migrate-from-v1.mdx @@ -1,5 +1,6 @@ --- title: Migrate from Actions V1 to V2 +description: "Migrate from Actions V1 to V2 by transitioning custom logic to external HTTP endpoints using webhooks for better scalability and flexibility" sidebar_label: Migrate from V1 to V2 --- diff --git a/apps/docs/content/guides/integrate/actions/testing-event.mdx b/apps/docs/content/guides/integrate/actions/testing-event.mdx index 021534713..81aa44acc 100644 --- a/apps/docs/content/guides/integrate/actions/testing-event.mdx +++ b/apps/docs/content/guides/integrate/actions/testing-event.mdx @@ -1,5 +1,6 @@ --- title: Test Actions Event +description: "Configure HTTP target endpoints to test and integrate custom workflows triggered by ZITADEL events." --- This guide shows you how to leverage the ZITADEL actions feature to react to events in your ZITADEL instance. diff --git a/apps/docs/content/guides/integrate/actions/testing-function-manipulation.mdx b/apps/docs/content/guides/integrate/actions/testing-function-manipulation.mdx index 07b7d3bc4..8119519dd 100644 --- a/apps/docs/content/guides/integrate/actions/testing-function-manipulation.mdx +++ b/apps/docs/content/guides/integrate/actions/testing-function-manipulation.mdx @@ -1,5 +1,6 @@ --- title: Test Actions Function Manipulation +description: "Create targets for specific ZITADEL functions and execute external code during OIDC flows using HTTP requests and custom claims" --- This guide shows you how to leverage the ZITADEL actions feature to enhance different functions in your ZITADEL instance. diff --git a/apps/docs/content/guides/integrate/actions/testing-function.mdx b/apps/docs/content/guides/integrate/actions/testing-function.mdx index 9da0e7a2d..1b7991a5d 100644 --- a/apps/docs/content/guides/integrate/actions/testing-function.mdx +++ b/apps/docs/content/guides/integrate/actions/testing-function.mdx @@ -1,5 +1,6 @@ --- title: Test Actions Function +description: "Create an HTTP server as a target for ZITADEL actions to execute custom logic during OIDC or SAML flows" --- This guide shows you how to leverage the ZITADEL actions feature to enhance different functions in your ZITADEL instance. diff --git a/apps/docs/content/guides/integrate/actions/testing-request-manipulation.mdx b/apps/docs/content/guides/integrate/actions/testing-request-manipulation.mdx index e7a0252b2..1412ecb8f 100644 --- a/apps/docs/content/guides/integrate/actions/testing-request-manipulation.mdx +++ b/apps/docs/content/guides/integrate/actions/testing-request-manipulation.mdx @@ -1,5 +1,6 @@ --- title: Test Actions Request Manipulation +description: "Create an HTTP server as a target to receive and manipulate API requests using ZITADEL's actions feature for custom integration" --- This guide shows you how to leverage the ZITADEL actions feature to manipulate API requests in your ZITADEL instance. diff --git a/apps/docs/content/guides/integrate/actions/testing-request-signature.mdx b/apps/docs/content/guides/integrate/actions/testing-request-signature.mdx index d66ddd2ac..b93dd48d4 100644 --- a/apps/docs/content/guides/integrate/actions/testing-request-signature.mdx +++ b/apps/docs/content/guides/integrate/actions/testing-request-signature.mdx @@ -1,5 +1,6 @@ --- title: Verify Payload Integrity +description: "Validate payload integrity by verifying JSON, JWT, or JWE signatures when receiving data from ZITADEL actions" --- import JsonGo from './go/json.go'; diff --git a/apps/docs/content/guides/integrate/actions/testing-request.mdx b/apps/docs/content/guides/integrate/actions/testing-request.mdx index 27935730b..14cd612b7 100644 --- a/apps/docs/content/guides/integrate/actions/testing-request.mdx +++ b/apps/docs/content/guides/integrate/actions/testing-request.mdx @@ -1,5 +1,6 @@ --- title: Test Actions Request +description: "Create an HTTP server as a target to receive and process Actions Request from ZITADEL instances during API calls" --- This guide shows you how to leverage the ZITADEL actions feature to react to API requests in your ZITADEL instance. diff --git a/apps/docs/content/guides/integrate/actions/testing-response-manipulation.mdx b/apps/docs/content/guides/integrate/actions/testing-response-manipulation.mdx index 7f1ad8fc1..358c51128 100644 --- a/apps/docs/content/guides/integrate/actions/testing-response-manipulation.mdx +++ b/apps/docs/content/guides/integrate/actions/testing-response-manipulation.mdx @@ -1,5 +1,6 @@ --- title: Test Actions Response Manipulation +description: "Manipulate API responses in your ZITADEL instance by creating targets that handle specific response events with custom logic" --- This guide shows you how to leverage the ZITADEL actions feature to manipulate API responses in your ZITADEL instance. diff --git a/apps/docs/content/guides/integrate/actions/testing-response.mdx b/apps/docs/content/guides/integrate/actions/testing-response.mdx index 1f8c3a02a..cc61b8195 100644 --- a/apps/docs/content/guides/integrate/actions/testing-response.mdx +++ b/apps/docs/content/guides/integrate/actions/testing-response.mdx @@ -1,5 +1,6 @@ --- title: Test Actions Response +description: "Create an HTTP server as a target to receive and process API response events from ZITADEL instances using Actions" --- This guide shows you how to leverage the ZITADEL actions feature to react to API responses in your ZITADEL instance. diff --git a/apps/docs/content/guides/integrate/actions/usage.mdx b/apps/docs/content/guides/integrate/actions/usage.mdx index d39556088..0cc4364ba 100644 --- a/apps/docs/content/guides/integrate/actions/usage.mdx +++ b/apps/docs/content/guides/integrate/actions/usage.mdx @@ -1,5 +1,6 @@ --- title: Using Actions +description: "Define targets and executions to create custom workflows triggered by API requests, events, or internal scripts with ZITADEL Actions." --- The Action API provides a flexible mechanism for customizing and extending the functionality of ZITADEL. By allowing you to define targets and executions, you can implement custom workflows triggered on an API requests and responses, events or specific functions. diff --git a/apps/docs/content/guides/integrate/actions/webhook-site-setup.mdx b/apps/docs/content/guides/integrate/actions/webhook-site-setup.mdx index 1dfd34643..3ceef052e 100644 --- a/apps/docs/content/guides/integrate/actions/webhook-site-setup.mdx +++ b/apps/docs/content/guides/integrate/actions/webhook-site-setup.mdx @@ -1,5 +1,6 @@ --- title: Testing Actions V2 with Webhook.site +description: "Forward ZITADEL Actions V2 events to Webhook.site and verify them locally using XHR Redirect and CORS headers setup" sidebar_label: Testing Actions V2 with Webhook.site --- diff --git a/apps/docs/content/guides/integrate/authenticated-mongodb-charts.mdx b/apps/docs/content/guides/integrate/authenticated-mongodb-charts.mdx index c8c633671..9391269df 100644 --- a/apps/docs/content/guides/integrate/authenticated-mongodb-charts.mdx +++ b/apps/docs/content/guides/integrate/authenticated-mongodb-charts.mdx @@ -1,5 +1,6 @@ --- title: Embed Authenticated MongoDB Charts Using ZITADEL +description: "Configure ZITADEL as custom JWT provider for authenticated MongoDB Charts using RS256 and JWKs URL" sidebar_label: Authenticated MongoDB Charts --- diff --git a/apps/docs/content/guides/integrate/back-channel-logout.mdx b/apps/docs/content/guides/integrate/back-channel-logout.mdx index b19497bf3..9351fd021 100644 --- a/apps/docs/content/guides/integrate/back-channel-logout.mdx +++ b/apps/docs/content/guides/integrate/back-channel-logout.mdx @@ -1,5 +1,6 @@ --- title: OIDC Back-Channel Logout +description: "Notify applications about session termination at OpenID Providers using ZITADEL's Back-Channel Logout implementation and logout tokens" sidebar_label: Back-Channel Logout --- diff --git a/apps/docs/content/guides/integrate/external-audit-log.mdx b/apps/docs/content/guides/integrate/external-audit-log.mdx index dd815f471..ae1641d34 100644 --- a/apps/docs/content/guides/integrate/external-audit-log.mdx +++ b/apps/docs/content/guides/integrate/external-audit-log.mdx @@ -1,5 +1,6 @@ --- title: Streaming audit logs to external systems (SIEM/SOC) +description: "Stream ZITADEL audit logs to external systems like SIEM solutions using Events API or Webhooks for centralized monitoring and compliance reporting" sidebar_label: Audit Logs (SIEM / SOC) --- diff --git a/apps/docs/content/guides/integrate/identity-providers/additional-information.mdx b/apps/docs/content/guides/integrate/identity-providers/additional-information.mdx index 4337224f1..b48393bc7 100644 --- a/apps/docs/content/guides/integrate/identity-providers/additional-information.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/additional-information.mdx @@ -1,5 +1,6 @@ --- title: Profile Pre-filling from External IdP +description: "Pre-fill user profiles using attributes from external identity providers to automate onboarding." sidebar_label: Profile Pre-filling from External IdP --- diff --git a/apps/docs/content/guides/integrate/identity-providers/apple.mdx b/apps/docs/content/guides/integrate/identity-providers/apple.mdx index dfa85c904..32b0bbd9c 100644 --- a/apps/docs/content/guides/integrate/identity-providers/apple.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/apple.mdx @@ -1,5 +1,6 @@ --- title: Set up Apple as an Identity Provider in ZITADEL +description: "Configure Apple as an OIDC identity provider in ZITADEL to allow your users to sign in with their Apple IDs." sidebar_label: Apple --- diff --git a/apps/docs/content/guides/integrate/identity-providers/azure-ad-oidc.mdx b/apps/docs/content/guides/integrate/identity-providers/azure-ad-oidc.mdx index edc5bcd13..9bb784e4d 100644 --- a/apps/docs/content/guides/integrate/identity-providers/azure-ad-oidc.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/azure-ad-oidc.mdx @@ -1,5 +1,6 @@ --- title: Set up Entra ID as an Identity Provider in ZITADEL +description: "Configure Microsoft Entra ID (formerly Azure AD) as an OIDC identity provider for enterprise Single Sign-On." sidebar_label: Entra ID --- diff --git a/apps/docs/content/guides/integrate/identity-providers/azure-ad-saml.mdx b/apps/docs/content/guides/integrate/identity-providers/azure-ad-saml.mdx index 92d06538f..6dd63af6a 100644 --- a/apps/docs/content/guides/integrate/identity-providers/azure-ad-saml.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/azure-ad-saml.mdx @@ -1,5 +1,6 @@ --- title: Set up Entra ID as a SAML Service Provider in ZITADEL +description: "Configure Entra ID as a SAML Service Provider in ZITADEL for secure authentication with custom attribute mapping" sidebar_label: Entra ID SAML --- diff --git a/apps/docs/content/guides/integrate/identity-providers/generic-oidc.mdx b/apps/docs/content/guides/integrate/identity-providers/generic-oidc.mdx index f6dccc0a7..a0039f9e1 100644 --- a/apps/docs/content/guides/integrate/identity-providers/generic-oidc.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/generic-oidc.mdx @@ -1,5 +1,6 @@ --- title: Configure a Generic OIDC Identity Provider in ZITADEL +description: "Configure a generic OpenID Connect (OIDC) Identity Provider in ZITADEL to enable user authentication with external credentials." sidebar_label: Generic OIDC id: generic-oidc --- diff --git a/apps/docs/content/guides/integrate/identity-providers/github.mdx b/apps/docs/content/guides/integrate/identity-providers/github.mdx index 7cdbfcf69..26a66aa20 100644 --- a/apps/docs/content/guides/integrate/identity-providers/github.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/github.mdx @@ -1,5 +1,6 @@ --- title: Configure GitHub as an Identity Provider in ZITADEL +description: "Enable GitHub social login by configuring GitHub as an external identity provider in ZITADEL." sidebar_label: GitHub --- diff --git a/apps/docs/content/guides/integrate/identity-providers/gitlab.mdx b/apps/docs/content/guides/integrate/identity-providers/gitlab.mdx index d62adc907..ca58444ab 100644 --- a/apps/docs/content/guides/integrate/identity-providers/gitlab.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/gitlab.mdx @@ -1,5 +1,6 @@ --- title: Configure GitLab as an Identity Provider in ZITADEL +description: "Connect GitLab as an external Identity Provider in ZITADEL for secure authentication using client ID and secret" sidebar_label: GitLab --- diff --git a/apps/docs/content/guides/integrate/identity-providers/google.mdx b/apps/docs/content/guides/integrate/identity-providers/google.mdx index f2209d4e7..9c836bdb7 100644 --- a/apps/docs/content/guides/integrate/identity-providers/google.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/google.mdx @@ -1,5 +1,6 @@ --- title: Configure Google as an Identity Provider in ZITADEL +description: "Configuring Google as an external identity provider for social login in ZITADEL." sidebar_label: Google --- diff --git a/apps/docs/content/guides/integrate/identity-providers/introduction.mdx b/apps/docs/content/guides/integrate/identity-providers/introduction.mdx index a70e67d50..0a5ad9f34 100644 --- a/apps/docs/content/guides/integrate/identity-providers/introduction.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/introduction.mdx @@ -1,5 +1,6 @@ --- title: Let Users Login with Preferred Identity Provider +description: "Configure external Identity Providers (IdPs) like Google, GitHub, and Microsoft Entra ID with ZITADEL for Single Sign-On." sidebar_label: Login users with SSO --- diff --git a/apps/docs/content/guides/integrate/identity-providers/jwt_idp.mdx b/apps/docs/content/guides/integrate/identity-providers/jwt_idp.mdx index edb40180f..f710fa765 100644 --- a/apps/docs/content/guides/integrate/identity-providers/jwt_idp.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/jwt_idp.mdx @@ -1,5 +1,6 @@ --- title: JWT IdP +description: "Validate JSON Web Tokens from external systems as proof of user authentication in ZITADEL for single sign-on." sidebar_label: JWT IdP --- diff --git a/apps/docs/content/guides/integrate/identity-providers/keycloak.mdx b/apps/docs/content/guides/integrate/identity-providers/keycloak.mdx index f0e9f0600..3af37b138 100644 --- a/apps/docs/content/guides/integrate/identity-providers/keycloak.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/keycloak.mdx @@ -1,5 +1,6 @@ --- title: Configure Keycloak as an Identity Provider in ZITADEL +description: "Configure Keycloak as an OIDC Identity Provider in ZITADEL to enable secure authentication and authorization flows" sidebar_label: Keycloak generic OIDC id: keycloak --- diff --git a/apps/docs/content/guides/integrate/identity-providers/ldap.mdx b/apps/docs/content/guides/integrate/identity-providers/ldap.mdx index 878190bce..5f0397ec2 100644 --- a/apps/docs/content/guides/integrate/identity-providers/ldap.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/ldap.mdx @@ -1,5 +1,6 @@ --- title: Configure LDAP as an Identity Provider in ZITADEL +description: "Connect ZITADEL to an LDAP server to use existing directory users for authentication and authorization." sidebar_label: LDAP --- diff --git a/apps/docs/content/guides/integrate/identity-providers/linkedin_oauth.mdx b/apps/docs/content/guides/integrate/identity-providers/linkedin_oauth.mdx index 8050c19e0..e0c7a566e 100644 --- a/apps/docs/content/guides/integrate/identity-providers/linkedin_oauth.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/linkedin_oauth.mdx @@ -1,5 +1,6 @@ --- title: Set up LinkedIn as an OAuth Identity Provider in ZITADEL +description: "Configure LinkedIn as an OAuth Identity Provider in ZITADEL to enable secure login with LinkedIn credentials" sidebar_label: LinkedIn generic OAuth id: linkedin-oauth --- diff --git a/apps/docs/content/guides/integrate/identity-providers/migrate.mdx b/apps/docs/content/guides/integrate/identity-providers/migrate.mdx index facad26c2..e9d93d293 100644 --- a/apps/docs/content/guides/integrate/identity-providers/migrate.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/migrate.mdx @@ -1,5 +1,6 @@ --- title: Migrate from Generic Provider to specific Identity Provider +description: "Migrate from generic OIDC provider to Entra ID or Google using API requests or Terraform for user connectivity" sidebar_label: Migrate IdP --- diff --git a/apps/docs/content/guides/integrate/identity-providers/mocksaml.mdx b/apps/docs/content/guides/integrate/identity-providers/mocksaml.mdx index 71dbc9006..04110978d 100644 --- a/apps/docs/content/guides/integrate/identity-providers/mocksaml.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/mocksaml.mdx @@ -1,5 +1,6 @@ --- title: Set up MockSAML as an Identity Provider in ZITADEL +description: "Set up MockSAML as an Identity Provider in ZITADEL to test user authentication and autofill user data using Actions" sidebar_label: MockSAML id: mocksaml --- diff --git a/apps/docs/content/guides/integrate/identity-providers/okta-oidc.mdx b/apps/docs/content/guides/integrate/identity-providers/okta-oidc.mdx index 40397af93..7351d5c38 100644 --- a/apps/docs/content/guides/integrate/identity-providers/okta-oidc.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/okta-oidc.mdx @@ -1,5 +1,6 @@ --- title: Set up OKTA as an OIDC Identity Provider in ZITADEL +description: "Configure OKTA as an OIDC Identity Provider in ZITADEL by registering a new client and adding it to your login policy" sidebar_label: OKTA generic OIDC id: okta-oidc --- diff --git a/apps/docs/content/guides/integrate/identity-providers/okta_saml.mdx b/apps/docs/content/guides/integrate/identity-providers/okta_saml.mdx index 5874eb159..a2fc6f418 100644 --- a/apps/docs/content/guides/integrate/identity-providers/okta_saml.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/okta_saml.mdx @@ -1,5 +1,6 @@ --- title: Set up OKTA as a SAML Identity Provider in ZITADEL +description: "Configure OKTA as a SAML Identity Provider in ZITADEL to enable single sign-on with custom attribute mappings" sidebar_label: OKTA SAML id: okta-saml --- diff --git a/apps/docs/content/guides/integrate/identity-providers/onelogin-saml.mdx b/apps/docs/content/guides/integrate/identity-providers/onelogin-saml.mdx index a08aba180..c7096fb13 100644 --- a/apps/docs/content/guides/integrate/identity-providers/onelogin-saml.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/onelogin-saml.mdx @@ -1,5 +1,6 @@ --- title: Set up OneLogin as a SAML Identity Provider in ZITADEL +description: "Configure OneLogin as a SAML Identity Provider in ZITADEL to enable secure authentication and single sign-on" sidebar_label: OneLogin SAML id: onelogin-saml --- diff --git a/apps/docs/content/guides/integrate/identity-providers/openldap.mdx b/apps/docs/content/guides/integrate/identity-providers/openldap.mdx index dcf7f0cd9..7cf5ced74 100644 --- a/apps/docs/content/guides/integrate/identity-providers/openldap.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/openldap.mdx @@ -1,5 +1,6 @@ --- title: Set up Local OpenLDAP as an Identity Provider in ZITADEL +description: "Configure a local OpenLDAP server as an Identity Provider in ZITADEL to authenticate users with custom credentials" sidebar_label: Local OpenLDAP --- diff --git a/apps/docs/content/guides/integrate/identity-providers/pingfederate-saml.mdx b/apps/docs/content/guides/integrate/identity-providers/pingfederate-saml.mdx index 15c1aaf36..a46ad3c83 100644 --- a/apps/docs/content/guides/integrate/identity-providers/pingfederate-saml.mdx +++ b/apps/docs/content/guides/integrate/identity-providers/pingfederate-saml.mdx @@ -1,5 +1,6 @@ --- title: Set up PingFederate as a SAML Identity Provider in ZITADEL +description: "Configure PingFederate as a SAML Identity Provider in ZITADEL to enable secure authentication and single sign-on" sidebar_label: PingFederate SAML id: pingfederate-saml --- diff --git a/apps/docs/content/guides/integrate/login-ui/device-auth.mdx b/apps/docs/content/guides/integrate/login-ui/device-auth.mdx index 7c5f4b8a4..4af663984 100644 --- a/apps/docs/content/guides/integrate/login-ui/device-auth.mdx +++ b/apps/docs/content/guides/integrate/login-ui/device-auth.mdx @@ -1,5 +1,6 @@ --- title: Support for the Device Authorization Grant in a Custom Login UI +description: "Implement the OAuth 2.0 Device Authorization Grant in your custom login UI for browserless devices." sidebar_label: Device Authorization --- diff --git a/apps/docs/content/guides/integrate/login-ui/external-login.mdx b/apps/docs/content/guides/integrate/login-ui/external-login.mdx index 669a6e1f2..2524aa8e5 100644 --- a/apps/docs/content/guides/integrate/login-ui/external-login.mdx +++ b/apps/docs/content/guides/integrate/login-ui/external-login.mdx @@ -1,5 +1,6 @@ --- title: Handle External Logins in a Custom Login UI +description: "Manage external identity provider logins (Google, GitHub, etc.) within a custom Login UI." sidebar_label: External Identity Provider --- diff --git a/apps/docs/content/guides/integrate/login-ui/index.mdx b/apps/docs/content/guides/integrate/login-ui/index.mdx index af4af1940..92b88f8e1 100644 --- a/apps/docs/content/guides/integrate/login-ui/index.mdx +++ b/apps/docs/content/guides/integrate/login-ui/index.mdx @@ -1,6 +1,6 @@ --- title: "Build your own Login UI" -description: "In the following guides you will learn how to create your own login UI with our APIs. The different scenarios like username/password, external identity provider, etc. will be shown." +description: "Create a completely customized login experience using the ZITADEL Session and OIDC APIs. Learn how to handle username/password, MFA, passkeys, and external identity providers." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/guides/integrate/login-ui/login-app.mdx b/apps/docs/content/guides/integrate/login-ui/login-app.mdx index 5538b5124..9013f9152 100644 --- a/apps/docs/content/guides/integrate/login-ui/login-app.mdx +++ b/apps/docs/content/guides/integrate/login-ui/login-app.mdx @@ -1,5 +1,6 @@ --- title: Login App +description: "Building a custom login application with ZITADEL: an overview of the OIDC and Session API integration." sidebar_label: Login App --- diff --git a/apps/docs/content/guides/integrate/login-ui/logout.mdx b/apps/docs/content/guides/integrate/login-ui/logout.mdx index be74c7f95..61cb9169c 100644 --- a/apps/docs/content/guides/integrate/login-ui/logout.mdx +++ b/apps/docs/content/guides/integrate/login-ui/logout.mdx @@ -1,5 +1,6 @@ --- title: Logging Out via a Custom Login UI +description: "Secure logout and session termination in a custom login user interface." sidebar_label: Logout --- diff --git a/apps/docs/content/guides/integrate/login-ui/mfa.mdx b/apps/docs/content/guides/integrate/login-ui/mfa.mdx index 5a6fefeac..5279dea39 100644 --- a/apps/docs/content/guides/integrate/login-ui/mfa.mdx +++ b/apps/docs/content/guides/integrate/login-ui/mfa.mdx @@ -1,5 +1,6 @@ --- title: Multi-Factor Authentication (MFA) in a Custom Login UI +description: "Support multi-factor authentication (MFA) methods like TOTP, SMS, and WebAuthn in your custom login UI." sidebar_label: Multi-Factor Authentication (MFA) --- diff --git a/apps/docs/content/guides/integrate/login-ui/oidc-standard.mdx b/apps/docs/content/guides/integrate/login-ui/oidc-standard.mdx index 71752e0f9..0852190ce 100644 --- a/apps/docs/content/guides/integrate/login-ui/oidc-standard.mdx +++ b/apps/docs/content/guides/integrate/login-ui/oidc-standard.mdx @@ -1,5 +1,6 @@ --- title: Support for the OpenID Connect(OIDC) Standard in a Custom Login UI +description: "Support for the full OpenID Connect (OIDC) standard when building a custom login UI with ZITADEL." sidebar_label: OIDC Standard --- diff --git a/apps/docs/content/guides/integrate/login-ui/passkey.mdx b/apps/docs/content/guides/integrate/login-ui/passkey.mdx index 8cd9440da..b4e643374 100644 --- a/apps/docs/content/guides/integrate/login-ui/passkey.mdx +++ b/apps/docs/content/guides/integrate/login-ui/passkey.mdx @@ -1,5 +1,6 @@ --- title: Using Passkeys in a Custom Login UI +description: "Register and verify a Passkey with ZITADEL to enable phishing-resistant authentication using the FIDO Standard protocol" sidebar_label: Passkeys --- diff --git a/apps/docs/content/guides/integrate/login-ui/password-reset.mdx b/apps/docs/content/guides/integrate/login-ui/password-reset.mdx index 761df323e..b77c5f20d 100644 --- a/apps/docs/content/guides/integrate/login-ui/password-reset.mdx +++ b/apps/docs/content/guides/integrate/login-ui/password-reset.mdx @@ -1,5 +1,6 @@ --- title: Password Reset/Change in a Custom Login UI +description: "Request a password reset and send a verification code via ZITADEL or custom channel to users who forgot their passwords" sidebar_label: Password Reset/Change --- diff --git a/apps/docs/content/guides/integrate/login-ui/saml-standard.mdx b/apps/docs/content/guides/integrate/login-ui/saml-standard.mdx index 100cb5d8f..67882907d 100644 --- a/apps/docs/content/guides/integrate/login-ui/saml-standard.mdx +++ b/apps/docs/content/guides/integrate/login-ui/saml-standard.mdx @@ -1,5 +1,6 @@ --- title: Support for the SAML Standard in a Custom Login UI +description: "Proxy SAML requests from a custom login UI to the ZITADEL API for authentication with external applications" sidebar_label: SAML Standard --- diff --git a/apps/docs/content/guides/integrate/login-ui/select-account.mdx b/apps/docs/content/guides/integrate/login-ui/select-account.mdx index dba6830ae..8f8522cc8 100644 --- a/apps/docs/content/guides/integrate/login-ui/select-account.mdx +++ b/apps/docs/content/guides/integrate/login-ui/select-account.mdx @@ -1,5 +1,6 @@ --- title: Select Account in a Custom Login UI +description: "Implement custom account selection logic using React components to handle user authentication flows with multiple identity providers" --- import SelectAccount from './_select-account.mdx'; diff --git a/apps/docs/content/guides/integrate/login-ui/session-validation.mdx b/apps/docs/content/guides/integrate/login-ui/session-validation.mdx index 5966660e2..3f13715fa 100644 --- a/apps/docs/content/guides/integrate/login-ui/session-validation.mdx +++ b/apps/docs/content/guides/integrate/login-ui/session-validation.mdx @@ -1,5 +1,6 @@ --- title: How to Handle Session Validation +description: "Validate user sessions in a custom Login UI by verifying authentication factors and expiration." sidebar_label: Session Validation --- diff --git a/apps/docs/content/guides/integrate/login-ui/username-password.mdx b/apps/docs/content/guides/integrate/login-ui/username-password.mdx index bbe64e6db..ccd772861 100644 --- a/apps/docs/content/guides/integrate/login-ui/username-password.mdx +++ b/apps/docs/content/guides/integrate/login-ui/username-password.mdx @@ -1,5 +1,6 @@ --- title: Register and Login User with Password in a Custom Login UI +description: "Create a new user with profile data and verify their email address using ZITADEL's registration flow" sidebar_label: Username and Password --- diff --git a/apps/docs/content/guides/integrate/login/hosted-login.mdx b/apps/docs/content/guides/integrate/login/hosted-login.mdx index c05b1aa83..7dc6c5ade 100644 --- a/apps/docs/content/guides/integrate/login/hosted-login.mdx +++ b/apps/docs/content/guides/integrate/login/hosted-login.mdx @@ -1,5 +1,6 @@ --- title: Login users into your application with a hosted login UI +description: "Securely authenticate users via ZITADEL's hosted Single Sign-On (SSO) login page, supporting OIDC and SAML protocols." sidebar_label: Hosted Login UI --- diff --git a/apps/docs/content/guides/integrate/login/login-users.mdx b/apps/docs/content/guides/integrate/login/login-users.mdx index 31a540714..56442377d 100644 --- a/apps/docs/content/guides/integrate/login/login-users.mdx +++ b/apps/docs/content/guides/integrate/login/login-users.mdx @@ -1,5 +1,6 @@ --- title: Log users into your application with different authentication options +description: "Overview of authentication protocols supported by ZITADEL, including OpenID Connect and SAML, for unified user login." sidebar_label: Authentication Options --- diff --git a/apps/docs/content/guides/integrate/login/oidc/authmethods.mdx b/apps/docs/content/guides/integrate/login/oidc/authmethods.mdx index 819e1d6ef..968166813 100644 --- a/apps/docs/content/guides/integrate/login/oidc/authmethods.mdx +++ b/apps/docs/content/guides/integrate/login/oidc/authmethods.mdx @@ -1,5 +1,6 @@ --- title: Authentication Methods +description: "Overview of authentication methods for OIDC clients in ZITADEL, including JWT with Private Key and Client Secret." --- import AuthMethods from './_authmethods.mdx'; diff --git a/apps/docs/content/guides/integrate/login/oidc/device-authorization.mdx b/apps/docs/content/guides/integrate/login/oidc/device-authorization.mdx index 5b732d368..88098b04c 100644 --- a/apps/docs/content/guides/integrate/login/oidc/device-authorization.mdx +++ b/apps/docs/content/guides/integrate/login/oidc/device-authorization.mdx @@ -1,5 +1,6 @@ --- title: Integrating Your Application with ZITADEL using RFC 8628 OAuth 2.0 Device Authorization Flow +description: "Authenticate with ZITADEL using RFC 8628 Device Authorization Flow by obtaining user consent without browser interaction" sidebar_label: Device Authorization Flow --- diff --git a/apps/docs/content/guides/integrate/login/oidc/index.mdx b/apps/docs/content/guides/integrate/login/oidc/index.mdx index be4562643..4d1edceee 100644 --- a/apps/docs/content/guides/integrate/login/oidc/index.mdx +++ b/apps/docs/content/guides/integrate/login/oidc/index.mdx @@ -1,6 +1,6 @@ --- title: "Authenticate users with OpenID Connect (OIDC)" -description: "This guide explains how to utilize ZITADEL for user authentication within your applications using OpenID Connect (OIDC). Here, we offer comprehensive guidance on seamlessly integrating ZITADEL's authentication features, ensuring both security and user experience excellence. Throughout this documentation, we'll cover the setup process for ZITADEL authentication, including the recommended OIDC flows tailored to different application types. Additionally, we'll provide clear instructions on securely signing out or logging out users from your application, ensuring data security and user privacy. With our guidance, you'll be equipped to leverage ZITADEL's authentication capabilities effectively, enhancing your application's security posture while delivering a seamless login experience for your users." +description: "Comprehensive guide to user authentication in ZITADEL using OpenID Connect (OIDC), including recommended flows and session management." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/guides/integrate/login/oidc/login-users.mdx b/apps/docs/content/guides/integrate/login/oidc/login-users.mdx index 370b18624..7cda997eb 100644 --- a/apps/docs/content/guides/integrate/login/oidc/login-users.mdx +++ b/apps/docs/content/guides/integrate/login/oidc/login-users.mdx @@ -1,5 +1,6 @@ --- title: Authenticate users with OpenID Connect +description: "Authenticate users with OpenID Connect using ZITADEL's authorization code flow and Proof Key for Code Exchange (PKCE)" sidebar_label: OIDC Code Flow + PKCE --- diff --git a/apps/docs/content/guides/integrate/login/oidc/logout.mdx b/apps/docs/content/guides/integrate/login/oidc/logout.mdx index 8997419c5..35b8ec8ca 100644 --- a/apps/docs/content/guides/integrate/login/oidc/logout.mdx +++ b/apps/docs/content/guides/integrate/login/oidc/logout.mdx @@ -1,5 +1,6 @@ --- title: Log Out Users from an Application with ZITADEL +description: "Terminate user sessions across applications using OpenID Connect Single Logout with ZITADEL for secure logouts" sidebar_label: Logout --- diff --git a/apps/docs/content/guides/integrate/login/oidc/oauth-recommended-flows.mdx b/apps/docs/content/guides/integrate/login/oidc/oauth-recommended-flows.mdx index 9fd57f530..7b480e9d6 100644 --- a/apps/docs/content/guides/integrate/login/oidc/oauth-recommended-flows.mdx +++ b/apps/docs/content/guides/integrate/login/oidc/oauth-recommended-flows.mdx @@ -1,5 +1,6 @@ --- title: Recommended authorization flows with OpenID Connect (OIDC) and OAuth 2.x +description: "Overview of recommended OIDC and OAuth 2.x authorization flows for secure user authentication and resource access" sidebar_label: Recommended authorization flows --- diff --git a/apps/docs/content/guides/integrate/login/oidc/webkeys.mdx b/apps/docs/content/guides/integrate/login/oidc/webkeys.mdx index b015d44c5..e1dfb6452 100644 --- a/apps/docs/content/guides/integrate/login/oidc/webkeys.mdx +++ b/apps/docs/content/guides/integrate/login/oidc/webkeys.mdx @@ -1,5 +1,6 @@ --- title: OpenID Connect and OAuth2 web keys +description: "Manage JSON Web Keys (JWKS) in ZITADEL to sign and verify tokens during OIDC and OAuth 2.0 authorization flows" sidebar_label: Web Keys --- diff --git a/apps/docs/content/guides/integrate/login/saml.mdx b/apps/docs/content/guides/integrate/login/saml.mdx index 4ecbe47ad..69e9d9f3a 100644 --- a/apps/docs/content/guides/integrate/login/saml.mdx +++ b/apps/docs/content/guides/integrate/login/saml.mdx @@ -1,5 +1,6 @@ --- title: Authenticate users with SAML +description: "Integrate SAML Single Sign-On (SSO) in your applications using ZITADEL as an Identity Provider (IdP)." sidebar_label: SAML --- diff --git a/apps/docs/content/guides/integrate/onboarding/b2b.mdx b/apps/docs/content/guides/integrate/onboarding/b2b.mdx index 9897a56ac..b430be087 100644 --- a/apps/docs/content/guides/integrate/onboarding/b2b.mdx +++ b/apps/docs/content/guides/integrate/onboarding/b2b.mdx @@ -1,5 +1,6 @@ --- title: Onboard B2B customers using organizations +description: "Create and set up new organizations in ZITADEL to onboard B2B customers with multi-tenancy separation of teams or groups" sidebar_label: Onboard B2B customer --- diff --git a/apps/docs/content/guides/integrate/onboarding/end-users.mdx b/apps/docs/content/guides/integrate/onboarding/end-users.mdx index 472a233a1..9acae5cd3 100644 --- a/apps/docs/content/guides/integrate/onboarding/end-users.mdx +++ b/apps/docs/content/guides/integrate/onboarding/end-users.mdx @@ -1,5 +1,6 @@ --- title: Onboard Users +description: "Onboard end-users with ZITADEL by enabling self-registration, manual user invites or automated provisioning using OIDC and external IdPs" sidebar_label: Onboard Users --- diff --git a/apps/docs/content/guides/integrate/retrieve-user-roles.mdx b/apps/docs/content/guides/integrate/retrieve-user-roles.mdx index 444bbb09e..362c74ea1 100644 --- a/apps/docs/content/guides/integrate/retrieve-user-roles.mdx +++ b/apps/docs/content/guides/integrate/retrieve-user-roles.mdx @@ -1,5 +1,6 @@ --- title: Retrieve User Roles in ZITADEL +description: "Methods for retrieving assigned user roles and authorizations for projects and organizations via ZITADEL APIs." sidebar_label: Retrieve User Roles --- diff --git a/apps/docs/content/guides/integrate/scim-okta-guide.mdx b/apps/docs/content/guides/integrate/scim-okta-guide.mdx index 7e3edf841..2dff17c66 100644 --- a/apps/docs/content/guides/integrate/scim-okta-guide.mdx +++ b/apps/docs/content/guides/integrate/scim-okta-guide.mdx @@ -1,5 +1,6 @@ --- title: SCIM Provisioning from Okta +description: "Configure SCIM provisioning from Okta to ZITADEL for automated user management and synchronization of identity records" --- This guide provides step-by-step instructions to configure SCIM provisioning from Okta into ZITADEL. diff --git a/apps/docs/content/guides/integrate/service-accounts/authenticate-service-accounts.mdx b/apps/docs/content/guides/integrate/service-accounts/authenticate-service-accounts.mdx index c0eab4bb9..bbdf37c4b 100644 --- a/apps/docs/content/guides/integrate/service-accounts/authenticate-service-accounts.mdx +++ b/apps/docs/content/guides/integrate/service-accounts/authenticate-service-accounts.mdx @@ -1,5 +1,6 @@ --- title: Authenticate service accounts and client applications +description: "Detailed guide to authenticating service accounts in ZITADEL using Private Key JWT or Client Credentials for machine-to-machine security." sidebar_label: Authenticate service accounts --- diff --git a/apps/docs/content/guides/integrate/service-accounts/client-credentials.mdx b/apps/docs/content/guides/integrate/service-accounts/client-credentials.mdx index 741863ad5..759353529 100644 --- a/apps/docs/content/guides/integrate/service-accounts/client-credentials.mdx +++ b/apps/docs/content/guides/integrate/service-accounts/client-credentials.mdx @@ -1,5 +1,6 @@ --- title: Configure client credential authentication for service accounts +description: "Authenticate service accounts using the industry-standard OAuth 2.0 Client Credentials flow." sidebar_label: Client credential authentication --- diff --git a/apps/docs/content/guides/integrate/service-accounts/personal-access-token.mdx b/apps/docs/content/guides/integrate/service-accounts/personal-access-token.mdx index f9e28547d..73cab93e1 100644 --- a/apps/docs/content/guides/integrate/service-accounts/personal-access-token.mdx +++ b/apps/docs/content/guides/integrate/service-accounts/personal-access-token.mdx @@ -1,5 +1,6 @@ --- title: Configure personal access token authentication for service accounts +description: "Generate and manage Personal Access Tokens (PAT) for service accounts to enable non-interactive API access to ZITADEL." sidebar_label: Personal access token authentication --- diff --git a/apps/docs/content/guides/integrate/service-accounts/private-key-jwt.mdx b/apps/docs/content/guides/integrate/service-accounts/private-key-jwt.mdx index 260682976..cc77928a4 100644 --- a/apps/docs/content/guides/integrate/service-accounts/private-key-jwt.mdx +++ b/apps/docs/content/guides/integrate/service-accounts/private-key-jwt.mdx @@ -1,5 +1,6 @@ --- title: Configure private key JWT authentication for service accounts +description: "Use RFC 7523 Private Key JWT authentication for secure, certificate-based service account login in ZITADEL." sidebar_label: Private key JWT authentication --- diff --git a/apps/docs/content/guides/integrate/services/atlassian-saml.mdx b/apps/docs/content/guides/integrate/services/atlassian-saml.mdx index 90a24d6b2..bb8143b6e 100644 --- a/apps/docs/content/guides/integrate/services/atlassian-saml.mdx +++ b/apps/docs/content/guides/integrate/services/atlassian-saml.mdx @@ -1,5 +1,6 @@ --- title: Log in with ZITADEL on Atlassian through SAML 2.0 +description: "Configure SAML 2.0 on Atlassian with ZITADEL as an external Identity Provider for Single Sign-On (SSO)" sidebar_label: Atlassian --- diff --git a/apps/docs/content/guides/integrate/services/auth0-oidc.mdx b/apps/docs/content/guides/integrate/services/auth0-oidc.mdx index 341ef7989..48bdbdfc1 100644 --- a/apps/docs/content/guides/integrate/services/auth0-oidc.mdx +++ b/apps/docs/content/guides/integrate/services/auth0-oidc.mdx @@ -1,5 +1,6 @@ --- title: Log in with ZITADEL on Auth0 through OIDC +description: "Connect Auth0 to ZITADEL using OIDC to enable secure login with custom authentication logic and OpenID Connect tokens" sidebar_label: Auth0 (OIDC) --- diff --git a/apps/docs/content/guides/integrate/services/auth0-saml.mdx b/apps/docs/content/guides/integrate/services/auth0-saml.mdx index 7e026da1a..799bbf70c 100644 --- a/apps/docs/content/guides/integrate/services/auth0-saml.mdx +++ b/apps/docs/content/guides/integrate/services/auth0-saml.mdx @@ -1,5 +1,6 @@ --- title: Log in with ZITADEL on Auth0 through SAML 2.0 +description: "Configure a SAML 2.0 connection between Auth0 and ZITADEL to enable login with ZITADEL on Auth0 using enterprise connections" sidebar_label: Auth0 (SAML) --- diff --git a/apps/docs/content/guides/integrate/services/aws-saml.mdx b/apps/docs/content/guides/integrate/services/aws-saml.mdx index 76b986b99..5ad4a3868 100644 --- a/apps/docs/content/guides/integrate/services/aws-saml.mdx +++ b/apps/docs/content/guides/integrate/services/aws-saml.mdx @@ -1,5 +1,6 @@ --- title: Log in with ZITADEL on AWS through SAML 2.0 +description: "Enable SAML 2.0 Single Sign-On for AWS IAM Identity Center (formerly AWS SSO) using ZITADEL as the identity provider." sidebar_label: Amazon Web Services --- diff --git a/apps/docs/content/guides/integrate/services/cloudflare-oidc.mdx b/apps/docs/content/guides/integrate/services/cloudflare-oidc.mdx index 52cd3d650..291e59fd5 100644 --- a/apps/docs/content/guides/integrate/services/cloudflare-oidc.mdx +++ b/apps/docs/content/guides/integrate/services/cloudflare-oidc.mdx @@ -1,5 +1,6 @@ --- title: Configure ZITADEL as an OIDC Identity Provider on Cloudflare Zero Trust +description: "Configure ZITADEL as an OIDC Identity Provider on Cloudflare Zero Trust with custom user info and authentication flows" sidebar_label: Cloudflare Zero Trust --- diff --git a/apps/docs/content/guides/integrate/services/gitlab-saml.mdx b/apps/docs/content/guides/integrate/services/gitlab-saml.mdx index cc2428b9b..c26ff6b99 100644 --- a/apps/docs/content/guides/integrate/services/gitlab-saml.mdx +++ b/apps/docs/content/guides/integrate/services/gitlab-saml.mdx @@ -1,5 +1,6 @@ --- title: Log in with ZITADEL on Gitlab through SAML 2.0 +description: "Configure SAML 2.0 Single Sign-On for GitLab using ZITADEL as the Identity Provider." sidebar_label: Gitlab --- diff --git a/apps/docs/content/guides/integrate/services/gitlab-self-hosted.mdx b/apps/docs/content/guides/integrate/services/gitlab-self-hosted.mdx index 7fa437fe2..3df5931e3 100644 --- a/apps/docs/content/guides/integrate/services/gitlab-self-hosted.mdx +++ b/apps/docs/content/guides/integrate/services/gitlab-self-hosted.mdx @@ -1,5 +1,6 @@ --- title: Log in with ZITADEL on Gitlab OmniAuth Provider +description: "Enable OIDC-based login for self-hosted GitLab instances using ZITADEL as the OmniAuth provider." --- import CreateApp from "../application/_application.mdx"; diff --git a/apps/docs/content/guides/integrate/services/google-cloud.mdx b/apps/docs/content/guides/integrate/services/google-cloud.mdx index adad97cd7..36bd75e5d 100644 --- a/apps/docs/content/guides/integrate/services/google-cloud.mdx +++ b/apps/docs/content/guides/integrate/services/google-cloud.mdx @@ -1,5 +1,6 @@ --- title: Log in with ZITADEL on Google Cloud with Workforce Identity Federation (OIDC) +description: "Configure Workforce Identity Federation with ZITADEL to log in users and assign roles on Google Cloud using OIDC claims" sidebar_label: Google Cloud --- diff --git a/apps/docs/content/guides/integrate/services/google-workspace.mdx b/apps/docs/content/guides/integrate/services/google-workspace.mdx index ed260756b..4e3574e74 100644 --- a/apps/docs/content/guides/integrate/services/google-workspace.mdx +++ b/apps/docs/content/guides/integrate/services/google-workspace.mdx @@ -1,5 +1,6 @@ --- title: Google Workspace SSO with ZITADEL +description: "Configure ZITADEL as the SAML 2.0 Identity Provider (IdP) for Single Sign-On (SSO) in Google Workspace." sidebar_label: Google Workspace --- diff --git a/apps/docs/content/guides/integrate/services/index.mdx b/apps/docs/content/guides/integrate/services/index.mdx index 640a4bc4b..3119b7301 100644 --- a/apps/docs/content/guides/integrate/services/index.mdx +++ b/apps/docs/content/guides/integrate/services/index.mdx @@ -1,6 +1,6 @@ --- title: "Integrate ZITADEL with your Favorite Services" -description: "With the guides in this section you will learn how to integrate ZITADEL with your services." +description: "Step-by-step guides for integrating ZITADEL with popular services and tools including Google Workspace, AWS, Atlassian, Cloudflare, GitLab, and many other software solutions." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/guides/integrate/services/pingidentity-saml.mdx b/apps/docs/content/guides/integrate/services/pingidentity-saml.mdx index 0686bdfcc..ac849a866 100644 --- a/apps/docs/content/guides/integrate/services/pingidentity-saml.mdx +++ b/apps/docs/content/guides/integrate/services/pingidentity-saml.mdx @@ -1,5 +1,6 @@ --- title: Log in with ZITADEL on Ping Identity through SAML 2.0 +description: "Configure SAML 2.0 connection between Ping Identity and ZITADEL to enable login with ZITADEL on Ping Identity" sidebar_label: Ping Identity --- diff --git a/apps/docs/content/guides/integrate/token-exchange.mdx b/apps/docs/content/guides/integrate/token-exchange.mdx index 87494e2b9..800ff6ddb 100644 --- a/apps/docs/content/guides/integrate/token-exchange.mdx +++ b/apps/docs/content/guides/integrate/token-exchange.mdx @@ -1,5 +1,6 @@ --- title: Impersonation and delegation using Token Exchange +description: "Exchange tokens with different scopes, audiences, or subjects using RFC 8693 OAuth 2.0 Token Exchange grant and ZITADEL" sidebar_label: Token Exchange --- diff --git a/apps/docs/content/guides/integrate/token-introspection/basic-auth.mdx b/apps/docs/content/guides/integrate/token-introspection/basic-auth.mdx index 999fa9f70..cf768e3fa 100644 --- a/apps/docs/content/guides/integrate/token-introspection/basic-auth.mdx +++ b/apps/docs/content/guides/integrate/token-introspection/basic-auth.mdx @@ -1,5 +1,6 @@ --- title: Basic Authentication in ZITADEL +description: "Authenticate with ZITADEL's token introspection endpoint using Basic Authentication (client secret basic)" sidebar_label: Basic Authentication --- diff --git a/apps/docs/content/guides/integrate/token-introspection/index.mdx b/apps/docs/content/guides/integrate/token-introspection/index.mdx index 73157eee3..aefe6c90c 100644 --- a/apps/docs/content/guides/integrate/token-introspection/index.mdx +++ b/apps/docs/content/guides/integrate/token-introspection/index.mdx @@ -1,6 +1,7 @@ --- title: Token introspection sidebar_label: Token introspection +description: Integrate OAuth 2.0 token introspection to verify access token validity in resource servers --- import DocCardList from '@/components/docusaurus/doc-card-list'; diff --git a/apps/docs/content/guides/integrate/token-introspection/private-key-jwt.mdx b/apps/docs/content/guides/integrate/token-introspection/private-key-jwt.mdx index 1066301e7..24fbdfbc9 100644 --- a/apps/docs/content/guides/integrate/token-introspection/private-key-jwt.mdx +++ b/apps/docs/content/guides/integrate/token-introspection/private-key-jwt.mdx @@ -1,5 +1,6 @@ --- title: Private Key JWT +description: "Authenticate with ZITADEL's token introspection endpoint using Private Key JWT to validate access tokens" sidebar_label: Private Key JWT --- diff --git a/apps/docs/content/guides/integrate/tools/apache2.mdx b/apps/docs/content/guides/integrate/tools/apache2.mdx index c42cd9745..51b823e77 100644 --- a/apps/docs/content/guides/integrate/tools/apache2.mdx +++ b/apps/docs/content/guides/integrate/tools/apache2.mdx @@ -1,5 +1,6 @@ --- title: Apache 2.0 +description: "Configure OpenID Connect with Apache 2.0 and ZITADEL using modauthopenidc to secure routes and handle logout requests" --- This integration guide shows you the basic OpenID Connect integration with ZITADEL and an Apache 2.0 server. diff --git a/apps/docs/content/guides/integrate/zitadel-apis/access-zitadel-apis.mdx b/apps/docs/content/guides/integrate/zitadel-apis/access-zitadel-apis.mdx index ff8240b71..6618b3b49 100644 --- a/apps/docs/content/guides/integrate/zitadel-apis/access-zitadel-apis.mdx +++ b/apps/docs/content/guides/integrate/zitadel-apis/access-zitadel-apis.mdx @@ -1,5 +1,6 @@ --- title: Access ZITADEL APIs +description: "Authenticate and authorize requests to ZITADEL APIs to manage instances, organizations, and user resources." --- This guide explains what ZITADEL APIs are and how to access ZITADEL APIs using a service account to manage all types of resources and settings. diff --git a/apps/docs/content/guides/integrate/zitadel-apis/access-zitadel-system-api.mdx b/apps/docs/content/guides/integrate/zitadel-apis/access-zitadel-system-api.mdx index 22f51f6c7..60c2d5b6e 100644 --- a/apps/docs/content/guides/integrate/zitadel-apis/access-zitadel-system-api.mdx +++ b/apps/docs/content/guides/integrate/zitadel-apis/access-zitadel-system-api.mdx @@ -1,5 +1,6 @@ --- title: Access ZITADEL System API +description: "Authenticate with the ZITADEL System API using JWT profiles to manage instances and global settings in self-hosted deployments." sidebar_label: System API --- diff --git a/apps/docs/content/guides/integrate/zitadel-apis/event-api.mdx b/apps/docs/content/guides/integrate/zitadel-apis/event-api.mdx index 99f0c9c54..10fac760c 100644 --- a/apps/docs/content/guides/integrate/zitadel-apis/event-api.mdx +++ b/apps/docs/content/guides/integrate/zitadel-apis/event-api.mdx @@ -1,5 +1,6 @@ --- title: Get Events from ZITADEL +description: "Consume and query audit logs and system changes via ZITADEL's Event API for integration, monitoring, and reporting." sidebar_label: Event API --- diff --git a/apps/docs/content/guides/integrate/zitadel-apis/example-zitadel-api-with-dot-net.mdx b/apps/docs/content/guides/integrate/zitadel-apis/example-zitadel-api-with-dot-net.mdx index 64be257da..f34aa26c1 100644 --- a/apps/docs/content/guides/integrate/zitadel-apis/example-zitadel-api-with-dot-net.mdx +++ b/apps/docs/content/guides/integrate/zitadel-apis/example-zitadel-api-with-dot-net.mdx @@ -1,5 +1,6 @@ --- title: Integrate ZITADEL APIs into a .NET Application +description: "Fetch organization details using ZITADEL management API and .NET SDK with a service account and valid key JSON" sidebar_label: Example .NET --- diff --git a/apps/docs/content/guides/integrate/zitadel-apis/example-zitadel-api-with-go.mdx b/apps/docs/content/guides/integrate/zitadel-apis/example-zitadel-api-with-go.mdx index 784f6dce5..8d487755e 100644 --- a/apps/docs/content/guides/integrate/zitadel-apis/example-zitadel-api-with-go.mdx +++ b/apps/docs/content/guides/integrate/zitadel-apis/example-zitadel-api-with-go.mdx @@ -1,5 +1,6 @@ --- title: Integrate ZITADEL APIs into a Go Application +description: "Example showing how to call ZITADEL Management APIs from a Go application using service account credentials." sidebar_label: Example Go --- diff --git a/apps/docs/content/guides/manage/cloud/billing.mdx b/apps/docs/content/guides/manage/cloud/billing.mdx index a0a0b8173..0e284d25c 100644 --- a/apps/docs/content/guides/manage/cloud/billing.mdx +++ b/apps/docs/content/guides/manage/cloud/billing.mdx @@ -1,5 +1,6 @@ --- title: Billing +description: "Manage billing, payment methods, and customer details in ZITADEL Cloud." --- ## Billing diff --git a/apps/docs/content/guides/manage/cloud/egress.mdx b/apps/docs/content/guides/manage/cloud/egress.mdx index b3c1cf7cf..6c0218065 100644 --- a/apps/docs/content/guides/manage/cloud/egress.mdx +++ b/apps/docs/content/guides/manage/cloud/egress.mdx @@ -1,7 +1,7 @@ --- title: ZITADEL Cloud Egress IP Addresses sidebar_label: Egress IPs -description: A list of static IP addresses ZITADEL Cloud uses to make outbound connections to your services. +description: "The static egress IP addresses used by ZITADEL Cloud for secure outbound connections to your infrastructure." --- When configuring your firewall or network security groups, you may need to allow traffic **from** ZITADEL Cloud to your internal infrastructure. diff --git a/apps/docs/content/guides/manage/cloud/instances.mdx b/apps/docs/content/guides/manage/cloud/instances.mdx index f2db247ec..e9e953fc8 100644 --- a/apps/docs/content/guides/manage/cloud/instances.mdx +++ b/apps/docs/content/guides/manage/cloud/instances.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Instances +description: "Create and manage multiple ZITADEL instances for dev, test, and production environments in the Customer Portal." sidebar_label: Instances --- diff --git a/apps/docs/content/guides/manage/cloud/settings.mdx b/apps/docs/content/guides/manage/cloud/settings.mdx index 13b567517..3bcf2e9e8 100644 --- a/apps/docs/content/guides/manage/cloud/settings.mdx +++ b/apps/docs/content/guides/manage/cloud/settings.mdx @@ -1,5 +1,6 @@ --- title: Settings +description: "Configure your ZITADEL Cloud team settings, including notification preferences and subscriptions." --- In the settings you can change your team name, notification settings and delete your team. diff --git a/apps/docs/content/guides/manage/cloud/start.mdx b/apps/docs/content/guides/manage/cloud/start.mdx index 587deb1b9..0d55c3201 100644 --- a/apps/docs/content/guides/manage/cloud/start.mdx +++ b/apps/docs/content/guides/manage/cloud/start.mdx @@ -1,5 +1,6 @@ --- title: Getting Started with ZITADEL +description: "Create your ZITADEL Cloud account and first instance." sidebar_label: Getting Started --- diff --git a/apps/docs/content/guides/manage/cloud/support.mdx b/apps/docs/content/guides/manage/cloud/support.mdx index 7e4053c55..da70c6567 100644 --- a/apps/docs/content/guides/manage/cloud/support.mdx +++ b/apps/docs/content/guides/manage/cloud/support.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Support +description: "Submit a support request to ZITADEL's customer portal with required information for timely assistance." sidebar_label: Customer Support --- diff --git a/apps/docs/content/guides/manage/cloud/users.mdx b/apps/docs/content/guides/manage/cloud/users.mdx index 73ce544a3..0a02ca9e2 100644 --- a/apps/docs/content/guides/manage/cloud/users.mdx +++ b/apps/docs/content/guides/manage/cloud/users.mdx @@ -1,5 +1,6 @@ --- title: Customer Portal Administrators +description: "Manage administrators who have access to the ZITADEL Customer Portal." sidebar_label: Customer Portal Administrators --- diff --git a/apps/docs/content/guides/manage/console/actions-overview.mdx b/apps/docs/content/guides/manage/console/actions-overview.mdx index 0e1607e33..cb9a679b8 100644 --- a/apps/docs/content/guides/manage/console/actions-overview.mdx +++ b/apps/docs/content/guides/manage/console/actions-overview.mdx @@ -1,5 +1,6 @@ --- title: Actions +description: "Extend ZITADEL with custom JavaScript logic using Actions." sidebar_label: Overview --- diff --git a/apps/docs/content/guides/manage/console/administrators.mdx b/apps/docs/content/guides/manage/console/administrators.mdx index e3676ee8c..9b7ac0b2a 100644 --- a/apps/docs/content/guides/manage/console/administrators.mdx +++ b/apps/docs/content/guides/manage/console/administrators.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Administrators +description: "Manage administrators and their roles within ZITADEL instances and organizations." sidebar_label: Administrators --- @@ -58,7 +59,7 @@ InternalAuthZ: - "iam.write" ``` -# Administrator Permission Matrix +## Administrator Permission Matrix This table is generated dynamically from our settings file. diff --git a/apps/docs/content/guides/manage/console/applications-overview.mdx b/apps/docs/content/guides/manage/console/applications-overview.mdx index be99c0589..2f4edbd94 100644 --- a/apps/docs/content/guides/manage/console/applications-overview.mdx +++ b/apps/docs/content/guides/manage/console/applications-overview.mdx @@ -1,5 +1,6 @@ --- title: Applications +description: "Create and configure applications in ZITADEL to enable secure OIDC or SAML authentication." sidebar_label: Applications sidebar_position: 5 diff --git a/apps/docs/content/guides/manage/console/console-overview.mdx b/apps/docs/content/guides/manage/console/console-overview.mdx index ecd44a151..3bf96119e 100644 --- a/apps/docs/content/guides/manage/console/console-overview.mdx +++ b/apps/docs/content/guides/manage/console/console-overview.mdx @@ -1,5 +1,6 @@ --- title: Management Console +description: "Overview of the ZITADEL Management Console for identity and access management tasks." sidebar_label: Management Console --- diff --git a/apps/docs/content/guides/manage/console/default-settings.mdx b/apps/docs/content/guides/manage/console/default-settings.mdx index f4a205d7f..b9040f8e8 100644 --- a/apps/docs/content/guides/manage/console/default-settings.mdx +++ b/apps/docs/content/guides/manage/console/default-settings.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Default Settings +description: "Configure default settings in ZITADEL to establish fallback organizational settings for features, branding, and authentication preferences" sidebar_label: Default Settings --- diff --git a/apps/docs/content/guides/manage/console/organizations-overview.mdx b/apps/docs/content/guides/manage/console/organizations-overview.mdx index 329c715bb..c05a1e6f6 100644 --- a/apps/docs/content/guides/manage/console/organizations-overview.mdx +++ b/apps/docs/content/guides/manage/console/organizations-overview.mdx @@ -1,5 +1,6 @@ --- title: Organizations +description: "Manage organizations, data isolation, and branding within ZITADEL." sidebar_label: Organizations --- diff --git a/apps/docs/content/guides/manage/console/projects-overview.mdx b/apps/docs/content/guides/manage/console/projects-overview.mdx index f90d982c6..ea9294b81 100644 --- a/apps/docs/content/guides/manage/console/projects-overview.mdx +++ b/apps/docs/content/guides/manage/console/projects-overview.mdx @@ -1,5 +1,6 @@ --- title: Organize applications, services, and roles with projects +description: "Use projects to group applications and manage roles and authorizations across multiple clients." sidebar_label: Projects sidebar_position: 4 --- diff --git a/apps/docs/content/guides/manage/console/roles.mdx b/apps/docs/content/guides/manage/console/roles.mdx index d906bbafe..c30b03bbf 100644 --- a/apps/docs/content/guides/manage/console/roles.mdx +++ b/apps/docs/content/guides/manage/console/roles.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Roles and Role Assignments +description: "Define custom roles and manage user role assignments within your ZITADEL projects." sidebar_label: Roles and Role Assignments --- diff --git a/apps/docs/content/guides/manage/console/users-overview.mdx b/apps/docs/content/guides/manage/console/users-overview.mdx index d90a134f4..606d18904 100644 --- a/apps/docs/content/guides/manage/console/users-overview.mdx +++ b/apps/docs/content/guides/manage/console/users-overview.mdx @@ -1,5 +1,6 @@ --- title: Users +description: "Manage users, authentication methods, and identity providers in the ZITADEL Console." sidebar_label: Users sidebar_position: 3 --- diff --git a/apps/docs/content/guides/manage/customize/behavior.mdx b/apps/docs/content/guides/manage/customize/behavior.mdx index 3d6391a11..ff9d2d76d 100644 --- a/apps/docs/content/guides/manage/customize/behavior.mdx +++ b/apps/docs/content/guides/manage/customize/behavior.mdx @@ -1,5 +1,6 @@ --- title: Behavior Customization +description: "Assign user roles during registration via external identity providers using ZITADEL actions." --- In this guide, you will create a [ZITADEL action](../../../concepts/features/actions). diff --git a/apps/docs/content/guides/manage/customize/branding.mdx b/apps/docs/content/guides/manage/customize/branding.mdx index c8bf9bc7e..bdfa9f9db 100644 --- a/apps/docs/content/guides/manage/customize/branding.mdx +++ b/apps/docs/content/guides/manage/customize/branding.mdx @@ -1,5 +1,6 @@ --- title: Brand Customization +description: "Customize ZITADEL's logos, colors, fonts, and styles at the instance or organization level for consistent branding." --- ZITADEL offers various customization options for your projects brand design. The branding can be configured on two different levels. diff --git a/apps/docs/content/guides/manage/customize/notification-providers.mdx b/apps/docs/content/guides/manage/customize/notification-providers.mdx index fe07f82c3..ba9131174 100644 --- a/apps/docs/content/guides/manage/customize/notification-providers.mdx +++ b/apps/docs/content/guides/manage/customize/notification-providers.mdx @@ -1,5 +1,6 @@ --- title: SMS, SMTP and HTTP Provider for Notifications +description: "Configure SMTP, SMS (Twilio), and HTTP webhook providers to manage how ZITADEL sends notifications." sidebar_label: Notification Providers --- diff --git a/apps/docs/content/guides/manage/customize/restrictions.mdx b/apps/docs/content/guides/manage/customize/restrictions.mdx index 79735db15..110f813d0 100644 --- a/apps/docs/content/guides/manage/customize/restrictions.mdx +++ b/apps/docs/content/guides/manage/customize/restrictions.mdx @@ -1,5 +1,6 @@ --- title: Feature Restrictions +description: "Configure feature restrictions on ZITADEL instances using the Feature Restrictions Admin API or DefaultInstance settings" --- New self-hosted and [ZITADEL Cloud instances](https://zitadel.com/admin) are unrestricted by default. diff --git a/apps/docs/content/guides/manage/customize/texts.mdx b/apps/docs/content/guides/manage/customize/texts.mdx index 6c5ff75a6..3c1c3f000 100644 --- a/apps/docs/content/guides/manage/customize/texts.mdx +++ b/apps/docs/content/guides/manage/customize/texts.mdx @@ -1,5 +1,6 @@ --- title: Customized Texts +description: "Localize and customize login screen messages and automated emails at the instance or organization level." --- You are able to customize the texts used from ZITADEL. This is possibly on the instance or organization level. diff --git a/apps/docs/content/guides/manage/customize/user-metadata.mdx b/apps/docs/content/guides/manage/customize/user-metadata.mdx index 93b7c3528..445a77369 100644 --- a/apps/docs/content/guides/manage/customize/user-metadata.mdx +++ b/apps/docs/content/guides/manage/customize/user-metadata.mdx @@ -1,5 +1,6 @@ --- title: User Metadata +description: "Retrieve user metadata using tokens by requesting from ZITADEL's userinfo endpoint, ID token, or authentication API with required scopes" --- This guide shows you how to request metadata from a user. diff --git a/apps/docs/content/guides/manage/terraform-provider.mdx b/apps/docs/content/guides/manage/terraform-provider.mdx index 753167722..a810120fe 100644 --- a/apps/docs/content/guides/manage/terraform-provider.mdx +++ b/apps/docs/content/guides/manage/terraform-provider.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Terraform Provider +description: "Manage ZITADEL instances, organizations, and resources programmatically using the official Terraform Provider." sidebar_label: Terraform Provider --- diff --git a/apps/docs/content/guides/manage/user/reg-create-user.mdx b/apps/docs/content/guides/manage/user/reg-create-user.mdx index 63ed09e5b..cf640c078 100644 --- a/apps/docs/content/guides/manage/user/reg-create-user.mdx +++ b/apps/docs/content/guides/manage/user/reg-create-user.mdx @@ -1,5 +1,6 @@ --- title: Register and Create User +description: "Methods for creating users via ZITADEL APIs, including human users with passwords, passkeys, or social logins." --- The ZITADEL API has different possibilities to create users. diff --git a/apps/docs/content/guides/manage/user/scim2.mdx b/apps/docs/content/guides/manage/user/scim2.mdx index 9ee85c85b..697f38dfc 100644 --- a/apps/docs/content/guides/manage/user/scim2.mdx +++ b/apps/docs/content/guides/manage/user/scim2.mdx @@ -1,5 +1,6 @@ --- title: SCIM v2.0 +description: "Automate user provisioning and lifecycle management using ZITADEL's SCIM v2.0 compliant service provider interface." --- Zitadel’s **[SCIM v2](https://scim.cloud/) service provider interface** enables standardized provisioning and lifecycle management of users and other instance resources. diff --git a/apps/docs/content/guides/migrate/introduction.mdx b/apps/docs/content/guides/migrate/introduction.mdx index a6ef42746..512c66ac7 100644 --- a/apps/docs/content/guides/migrate/introduction.mdx +++ b/apps/docs/content/guides/migrate/introduction.mdx @@ -1,5 +1,6 @@ --- title: Migrate to ZITADEL +description: "Strategy for migrating identity data, users, and configurations to ZITADEL from other providers." sidebar_label: Introduction --- diff --git a/apps/docs/content/guides/migrate/sources/auth0.mdx b/apps/docs/content/guides/migrate/sources/auth0.mdx index 365dc726d..93d28c0ef 100644 --- a/apps/docs/content/guides/migrate/sources/auth0.mdx +++ b/apps/docs/content/guides/migrate/sources/auth0.mdx @@ -1,5 +1,6 @@ --- title: Migrate from Auth0 to ZITADEL (Including Password Hashes) +description: "Migrate users, metadata, and password hashes from Auth0 to ZITADEL." sidebar_label: From Auth0 --- diff --git a/apps/docs/content/guides/migrate/sources/keycloak.mdx b/apps/docs/content/guides/migrate/sources/keycloak.mdx index 4db466a7b..fa3b235c1 100644 --- a/apps/docs/content/guides/migrate/sources/keycloak.mdx +++ b/apps/docs/content/guides/migrate/sources/keycloak.mdx @@ -1,6 +1,7 @@ --- title: Migrate from Keycloak +description: "Transition from Keycloak to ZITADEL using CLI tools to migrate users, configurations, and password hashes." sidebar_label: From Keycloak --- diff --git a/apps/docs/content/guides/migrate/sources/zitadel.mdx b/apps/docs/content/guides/migrate/sources/zitadel.mdx index 9b2ee4731..e7e31b536 100644 --- a/apps/docs/content/guides/migrate/sources/zitadel.mdx +++ b/apps/docs/content/guides/migrate/sources/zitadel.mdx @@ -1,5 +1,6 @@ --- title: Migrate from ZITADEL +description: "Strategy for migrating between ZITADEL instances, including data export and import using service accounts." sidebar_label: From ZITADEL --- diff --git a/apps/docs/content/guides/migrate/users.mdx b/apps/docs/content/guides/migrate/users.mdx index cf7c76973..bb44af194 100644 --- a/apps/docs/content/guides/migrate/users.mdx +++ b/apps/docs/content/guides/migrate/users.mdx @@ -1,5 +1,6 @@ --- title: Migrate Users +description: "Explore APIs and strategies for importing user accounts and legacy credentials into ZITADEL." sidebar_label: Users --- diff --git a/apps/docs/content/guides/solution-scenarios/b2b.mdx b/apps/docs/content/guides/solution-scenarios/b2b.mdx index ee06e4fd4..8e34d55dc 100644 --- a/apps/docs/content/guides/solution-scenarios/b2b.mdx +++ b/apps/docs/content/guides/solution-scenarios/b2b.mdx @@ -1,5 +1,6 @@ --- title: Authentication and authorization in multi-tenancy B2B scenarios +description: "Implement multi-tenancy authentication and authorization for B2B applications using ZITADEL." sidebar_label: B2B --- diff --git a/apps/docs/content/guides/solution-scenarios/b2c.mdx b/apps/docs/content/guides/solution-scenarios/b2c.mdx index 85143f771..11cf038fa 100644 --- a/apps/docs/content/guides/solution-scenarios/b2c.mdx +++ b/apps/docs/content/guides/solution-scenarios/b2c.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL for B2C Scenarios +description: "Build secure and scalable B2C applications with ZITADEL, covering user registration and branding." sidebar_label: B2C --- diff --git a/apps/docs/content/guides/solution-scenarios/configurations.mdx b/apps/docs/content/guides/solution-scenarios/configurations.mdx index 19b548fd7..9aa78964b 100644 --- a/apps/docs/content/guides/solution-scenarios/configurations.mdx +++ b/apps/docs/content/guides/solution-scenarios/configurations.mdx @@ -1,5 +1,6 @@ --- title: Set up ZITADEL for your Scenario +description: "Common configuration patterns for different identity and access management scenarios in ZITADEL." sidebar_label: Common Settings --- diff --git a/apps/docs/content/guides/solution-scenarios/domain-discovery.mdx b/apps/docs/content/guides/solution-scenarios/domain-discovery.mdx index 216291ba2..8f85b9004 100644 --- a/apps/docs/content/guides/solution-scenarios/domain-discovery.mdx +++ b/apps/docs/content/guides/solution-scenarios/domain-discovery.mdx @@ -1,5 +1,6 @@ --- title: Domain Discovery in ZITADEL +description: "Enable automatic routing to the correct organization identity provider using domain-based discovery for multi-tenant login." sidebar_label: Domain Discovery --- diff --git a/apps/docs/content/guides/solution-scenarios/frontend-calling-backend-API.mdx b/apps/docs/content/guides/solution-scenarios/frontend-calling-backend-API.mdx index 8ca1b3cc7..45e2640be 100644 --- a/apps/docs/content/guides/solution-scenarios/frontend-calling-backend-API.mdx +++ b/apps/docs/content/guides/solution-scenarios/frontend-calling-backend-API.mdx @@ -1,5 +1,6 @@ --- title: Frontend and Back-end API Communication in ZITADEL +description: "Secure cross-origin communication between frontend apps and backend APIs using ZITADEL's OIDC and OAuth 2.0 implementation." sidebar_label: Frontend and API Communication --- diff --git a/apps/docs/content/guides/solution-scenarios/index.mdx b/apps/docs/content/guides/solution-scenarios/index.mdx index 47b85de87..21be2ee02 100644 --- a/apps/docs/content/guides/solution-scenarios/index.mdx +++ b/apps/docs/content/guides/solution-scenarios/index.mdx @@ -1,5 +1,6 @@ --- title: Solution Scenarios +description: Reference common solution scenarios for B2B, B2C, and SaaS applications using ZITADEL --- Learn how to use ZITADEL for different scenarios. diff --git a/apps/docs/content/guides/solution-scenarios/restrict-console.mdx b/apps/docs/content/guides/solution-scenarios/restrict-console.mdx index 265f5e5d1..0c44ef070 100644 --- a/apps/docs/content/guides/solution-scenarios/restrict-console.mdx +++ b/apps/docs/content/guides/solution-scenarios/restrict-console.mdx @@ -1,5 +1,6 @@ --- title: Prevent users from accessing ZITADEL Management Console +description: "Guidelines and strategies for restricting user access to the ZITADEL Management Console to enforce custom application-level user management." sidebar_label: Limit access to management console --- diff --git a/apps/docs/content/guides/solution-scenarios/saas.mdx b/apps/docs/content/guides/solution-scenarios/saas.mdx index 8a8b4a42d..c4b1fc778 100644 --- a/apps/docs/content/guides/solution-scenarios/saas.mdx +++ b/apps/docs/content/guides/solution-scenarios/saas.mdx @@ -1,5 +1,6 @@ --- title: Set up a SaaS Product with Authentication and Authorization using ZITADEL +description: "Multi-tenancy authentication for a SaaS product using ZITADEL." sidebar_label: Software-as-a-Service --- diff --git a/apps/docs/content/guides/start/quickstart.mdx b/apps/docs/content/guides/start/quickstart.mdx index 6e9302e41..8bdc2de8d 100644 --- a/apps/docs/content/guides/start/quickstart.mdx +++ b/apps/docs/content/guides/start/quickstart.mdx @@ -1,6 +1,6 @@ --- title: The ZITADEL Quick Start Guide -description: Learn how to integrate OIDC PKCE authentication in your application using ZITADEL in under 5 minutes. +description: "Get started with ZITADEL by setting up an account and integrating OIDC authentication into your applications" sidebar_label: Quick Start Guide keywords: [ZITADEL, OIDC, PKCE, Authentication, Identity Management] --- diff --git a/apps/docs/content/legal/annex-support-services.mdx b/apps/docs/content/legal/annex-support-services.mdx index b1ea977cc..98856d4fc 100644 --- a/apps/docs/content/legal/annex-support-services.mdx +++ b/apps/docs/content/legal/annex-support-services.mdx @@ -1,5 +1,6 @@ --- title: Annex for ZITADEL Enterprise and Support Services +description: "Annex describing commercial support services for ZITADEL Enterprise licenses and support agreements." sidebar_label: Enterprise Agreement custom_edit_url: null --- diff --git a/apps/docs/content/legal/data-processing-agreement.mdx b/apps/docs/content/legal/data-processing-agreement.mdx index 4d1391c97..e3aca00e9 100644 --- a/apps/docs/content/legal/data-processing-agreement.mdx +++ b/apps/docs/content/legal/data-processing-agreement.mdx @@ -1,5 +1,6 @@ --- title: Data Processing Agreement +description: "ZITADEL's Data Processing Agreement (DPA) regarding the processing of personal data on behalf of customers." custom_edit_url: null --- diff --git a/apps/docs/content/legal/policies/acceptable-use-policy.mdx b/apps/docs/content/legal/policies/acceptable-use-policy.mdx index 0aeb0ef41..0100dbdc6 100644 --- a/apps/docs/content/legal/policies/acceptable-use-policy.mdx +++ b/apps/docs/content/legal/policies/acceptable-use-policy.mdx @@ -1,5 +1,6 @@ --- title: Acceptable Use Policy +description: "Obligations and restrictions for the use of subscription services and website to ensure legal compliance and security" custom_edit_url: null --- diff --git a/apps/docs/content/legal/policies/account-lockout-policy.mdx b/apps/docs/content/legal/policies/account-lockout-policy.mdx index 308cdc306..753b63c40 100644 --- a/apps/docs/content/legal/policies/account-lockout-policy.mdx +++ b/apps/docs/content/legal/policies/account-lockout-policy.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Account Lockout Policy +description: "Procedures and requirements for regaining access to cloud services in cases of lost credentials or misconfiguration" sidebar_label: Account Lockout Policy custom_edit_url: null --- diff --git a/apps/docs/content/legal/policies/brand-trademark-policy.mdx b/apps/docs/content/legal/policies/brand-trademark-policy.mdx index 1e5abc2ee..e0acb60c9 100644 --- a/apps/docs/content/legal/policies/brand-trademark-policy.mdx +++ b/apps/docs/content/legal/policies/brand-trademark-policy.mdx @@ -1,5 +1,6 @@ --- title: Use of brands and trademarks +description: "Exclusive ownership and conditions for the fair use of proprietary brands and trademarks" sidebar_label: Brand and Trademark Policy custom_edit_url: null --- diff --git a/apps/docs/content/legal/policies/feature-development-policy.mdx b/apps/docs/content/legal/policies/feature-development-policy.mdx index a359f2881..c7d3c8809 100644 --- a/apps/docs/content/legal/policies/feature-development-policy.mdx +++ b/apps/docs/content/legal/policies/feature-development-policy.mdx @@ -1,5 +1,6 @@ --- title: Feature Development Policy +description: "Guidelines for feature prioritization and accelerated development requests for products and services" custom_edit_url: null --- diff --git a/apps/docs/content/legal/policies/index.mdx b/apps/docs/content/legal/policies/index.mdx index 41fab7894..191eaa8a7 100644 --- a/apps/docs/content/legal/policies/index.mdx +++ b/apps/docs/content/legal/policies/index.mdx @@ -1,6 +1,6 @@ --- title: "Policies" -description: "Policies and guidelines in addition to our terms of services." +description: "Find all policy documents and guidelines for ZITADEL services, including our privacy policy, acceptable use policy, and other legal frameworks that govern our platform." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/legal/policies/privacy-policy.mdx b/apps/docs/content/legal/policies/privacy-policy.mdx index 4e6756a42..2e4f65cf5 100644 --- a/apps/docs/content/legal/policies/privacy-policy.mdx +++ b/apps/docs/content/legal/policies/privacy-policy.mdx @@ -1,5 +1,6 @@ --- title: Privacy Policy +description: "ZITADEL's privacy policy explaining how personal data is collected, used, and processed." custom_edit_url: null --- diff --git a/apps/docs/content/legal/policies/rate-limit-policy.mdx b/apps/docs/content/legal/policies/rate-limit-policy.mdx index 5eff6e03c..ef9f2c79a 100644 --- a/apps/docs/content/legal/policies/rate-limit-policy.mdx +++ b/apps/docs/content/legal/policies/rate-limit-policy.mdx @@ -1,5 +1,6 @@ --- title: Rate Limit Policy +description: "Guidelines and implementation details for API rate limiting to ensure performance and availability of cloud services" custom_edit_url: null --- diff --git a/apps/docs/content/legal/policies/vulnerability-disclosure-policy.mdx b/apps/docs/content/legal/policies/vulnerability-disclosure-policy.mdx index 103759c4e..c8cbe7598 100644 --- a/apps/docs/content/legal/policies/vulnerability-disclosure-policy.mdx +++ b/apps/docs/content/legal/policies/vulnerability-disclosure-policy.mdx @@ -1,5 +1,6 @@ --- title: Vulnerability Disclosure Policy +description: "Procedures and guidelines for reporting security vulnerabilities to ensure confidential disclosure and resolution" custom_edit_url: null --- diff --git a/apps/docs/content/legal/service-description/cloud-service-description.mdx b/apps/docs/content/legal/service-description/cloud-service-description.mdx index c17adf36b..5bf93148a 100644 --- a/apps/docs/content/legal/service-description/cloud-service-description.mdx +++ b/apps/docs/content/legal/service-description/cloud-service-description.mdx @@ -1,5 +1,6 @@ --- title: Service description for ZITADEL Cloud and ZITADEL Enterprise +description: "Description of services and service levels for ZITADEL Cloud and Enterprise subscriptions." sidebar_label: Service description custom_edit_url: null --- diff --git a/apps/docs/content/legal/service-description/index.mdx b/apps/docs/content/legal/service-description/index.mdx index 9579a1288..4e77f98f9 100644 --- a/apps/docs/content/legal/service-description/index.mdx +++ b/apps/docs/content/legal/service-description/index.mdx @@ -1,6 +1,6 @@ --- title: "Service description" -description: "Description of services and service levels for ZITADEL Cloud and Enterprise subscriptions." +description: "Detailed description of services, service levels (SLA), and support commitments for ZITADEL Cloud and Enterprise subscriptions to ensure transparency and reliability." --- {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA. diff --git a/apps/docs/content/legal/service-description/service-level-description.mdx b/apps/docs/content/legal/service-description/service-level-description.mdx index 86b7acca7..8757bba83 100644 --- a/apps/docs/content/legal/service-description/service-level-description.mdx +++ b/apps/docs/content/legal/service-description/service-level-description.mdx @@ -1,5 +1,6 @@ --- title: Service level description for ZITADEL Cloud +description: "Service level descriptions, uptime definitions, and availability targets for cloud services" sidebar_label: Service Level custom_edit_url: null --- diff --git a/apps/docs/content/legal/service-description/support-services.mdx b/apps/docs/content/legal/service-description/support-services.mdx index 22c472e48..2020cc344 100644 --- a/apps/docs/content/legal/service-description/support-services.mdx +++ b/apps/docs/content/legal/service-description/support-services.mdx @@ -1,5 +1,6 @@ --- title: Support service description for ZITADEL +description: "Support services, service level agreements, and conditions for service subscriptions" sidebar_label: Support service custom_edit_url: null --- diff --git a/apps/docs/content/legal/subprocessors.mdx b/apps/docs/content/legal/subprocessors.mdx index e8b0380a9..602b69710 100644 --- a/apps/docs/content/legal/subprocessors.mdx +++ b/apps/docs/content/legal/subprocessors.mdx @@ -1,5 +1,6 @@ --- title: Third party sub-processors for ZITADEL +description: "List of third-party sub-processors and services used by ZITADEL to provide its identity and authentication services." sidebar_label: Third Party Sub-Processors custom_edit_url: null --- diff --git a/apps/docs/content/legal/terms-of-service.mdx b/apps/docs/content/legal/terms-of-service.mdx index f76017935..609743df8 100644 --- a/apps/docs/content/legal/terms-of-service.mdx +++ b/apps/docs/content/legal/terms-of-service.mdx @@ -1,5 +1,6 @@ --- title: Terms of Service Agreement +description: "Framework agreement and terms of service for ZITADEL's websites and identity management services." custom_edit_url: null --- diff --git a/apps/docs/content/product/release-cycle.mdx b/apps/docs/content/product/release-cycle.mdx index 07262a158..f27c357cf 100644 --- a/apps/docs/content/product/release-cycle.mdx +++ b/apps/docs/content/product/release-cycle.mdx @@ -1,5 +1,6 @@ --- title: Release Cycle +description: "Overview of ZITADEL's release cycle, featuring predictable major versions every quarter and frequent stable updates." sidebar_label: Release Cycle --- diff --git a/apps/docs/content/product/roadmap.mdx b/apps/docs/content/product/roadmap.mdx index 2d9407762..7fec35864 100644 --- a/apps/docs/content/product/roadmap.mdx +++ b/apps/docs/content/product/roadmap.mdx @@ -1,5 +1,6 @@ --- title: Zitadel Release Versions and Roadmap +description: "ZITADEL's roadmap including upcoming features, release timelines, and planned improvements." sidebar_label: Release Versions and Roadmap --- diff --git a/apps/docs/content/sdk-examples/angular.mdx b/apps/docs/content/sdk-examples/angular.mdx index 15537ce7c..8eb067028 100644 --- a/apps/docs/content/sdk-examples/angular.mdx +++ b/apps/docs/content/sdk-examples/angular.mdx @@ -1,5 +1,6 @@ --- title: Angular +description: "Integrate ZITADEL authentication into Angular applications using the OAuth 2.0 PKCE flow." sidebar_label: Angular framework_url: https://angular.dev auth_library: "@edgeflare/ngx-oidc" diff --git a/apps/docs/content/sdk-examples/astro.mdx b/apps/docs/content/sdk-examples/astro.mdx index 82b645827..1aa5b1ed5 100644 --- a/apps/docs/content/sdk-examples/astro.mdx +++ b/apps/docs/content/sdk-examples/astro.mdx @@ -1,5 +1,6 @@ --- title: Astro +description: "Integrate ZITADEL authentication into Astro applications using the OAuth 2.0 PKCE flow." sidebar_label: Astro framework_url: https://astro.build auth_library: "@auth/core" diff --git a/apps/docs/content/sdk-examples/client-libraries/java.mdx b/apps/docs/content/sdk-examples/client-libraries/java.mdx index 641762d01..38caa958c 100644 --- a/apps/docs/content/sdk-examples/client-libraries/java.mdx +++ b/apps/docs/content/sdk-examples/client-libraries/java.mdx @@ -1,5 +1,6 @@ --- title: Java Client +description: "Authenticate with ZITADEL Management API using Java Client library and private key JWT, client credentials or personal access token" sidebar_label: 'Java Client' --- diff --git a/apps/docs/content/sdk-examples/client-libraries/node.mdx b/apps/docs/content/sdk-examples/client-libraries/node.mdx index 2aa60568d..10dcf86d4 100644 --- a/apps/docs/content/sdk-examples/client-libraries/node.mdx +++ b/apps/docs/content/sdk-examples/client-libraries/node.mdx @@ -1,5 +1,6 @@ --- title: Node.js Client +description: "Authenticate with ZITADEL Management API using Node.js Client Library via private key JWT, client credentials or personal access token" sidebar_label: 'Node.js Client' --- diff --git a/apps/docs/content/sdk-examples/client-libraries/php.mdx b/apps/docs/content/sdk-examples/client-libraries/php.mdx index b47e00b06..677a9d493 100644 --- a/apps/docs/content/sdk-examples/client-libraries/php.mdx +++ b/apps/docs/content/sdk-examples/client-libraries/php.mdx @@ -1,5 +1,6 @@ --- title: PHP Client +description: "Integrate ZITADEL Management APIs into PHP applications using supported authentication methods." sidebar_label: 'PHP Client' --- diff --git a/apps/docs/content/sdk-examples/client-libraries/python.mdx b/apps/docs/content/sdk-examples/client-libraries/python.mdx index 50897fb7e..c4d93c651 100644 --- a/apps/docs/content/sdk-examples/client-libraries/python.mdx +++ b/apps/docs/content/sdk-examples/client-libraries/python.mdx @@ -1,5 +1,6 @@ --- title: Python Client +description: "Authenticate with ZITADEL Management API using Python Client's three methods: Private Key JWT, client credentials grant, or Personal access token" sidebar_label: 'Python Client' --- diff --git a/apps/docs/content/sdk-examples/client-libraries/ruby.mdx b/apps/docs/content/sdk-examples/client-libraries/ruby.mdx index f42fe7f6e..fa22b5304 100644 --- a/apps/docs/content/sdk-examples/client-libraries/ruby.mdx +++ b/apps/docs/content/sdk-examples/client-libraries/ruby.mdx @@ -1,5 +1,6 @@ --- title: Ruby Client +description: "Connect to ZITADEL APIs using the Ruby client library with Private Key JWT, Client Credentials, or Personal Access Tokens." sidebar_label: 'Ruby Client' --- diff --git a/apps/docs/content/sdk-examples/django.mdx b/apps/docs/content/sdk-examples/django.mdx index 09ece4081..cd5ca8113 100644 --- a/apps/docs/content/sdk-examples/django.mdx +++ b/apps/docs/content/sdk-examples/django.mdx @@ -1,5 +1,6 @@ --- title: Django +description: "Integrate ZITADEL authentication into Django applications using the OAuth 2.0 PKCE flow." sidebar_label: Django framework_url: https://www.djangoproject.com auth_library: "Authlib" diff --git a/apps/docs/content/sdk-examples/expressjs.mdx b/apps/docs/content/sdk-examples/expressjs.mdx index 2e0db4460..3909e9e2e 100644 --- a/apps/docs/content/sdk-examples/expressjs.mdx +++ b/apps/docs/content/sdk-examples/expressjs.mdx @@ -1,5 +1,6 @@ --- title: Express.js +description: "Integrate ZITADEL authentication into Express.js applications using the OAuth 2.0 PKCE flow." sidebar_label: Express.js framework_url: https://expressjs.com auth_library: "@auth/express" diff --git a/apps/docs/content/sdk-examples/fastapi.mdx b/apps/docs/content/sdk-examples/fastapi.mdx index f9c3c8c16..7caae56d3 100644 --- a/apps/docs/content/sdk-examples/fastapi.mdx +++ b/apps/docs/content/sdk-examples/fastapi.mdx @@ -1,5 +1,6 @@ --- title: FastAPI +description: "Integrate ZITADEL authentication into FastAPI applications using the OAuth 2.0 PKCE flow." sidebar_label: FastAPI framework_url: https://fastapi.tiangolo.com auth_library: "Authlib" diff --git a/apps/docs/content/sdk-examples/fastify.mdx b/apps/docs/content/sdk-examples/fastify.mdx index 940120336..2dcf1986d 100644 --- a/apps/docs/content/sdk-examples/fastify.mdx +++ b/apps/docs/content/sdk-examples/fastify.mdx @@ -1,5 +1,6 @@ --- title: Fastify +description: "Integrate ZITADEL authentication into Fastify applications using the OAuth 2.0 PKCE flow." sidebar_label: Fastify framework_url: https://fastify.dev auth_library: "@auth/core" diff --git a/apps/docs/content/sdk-examples/flask.mdx b/apps/docs/content/sdk-examples/flask.mdx index 2086ff34d..36b7a331a 100644 --- a/apps/docs/content/sdk-examples/flask.mdx +++ b/apps/docs/content/sdk-examples/flask.mdx @@ -1,5 +1,6 @@ --- title: Flask +description: "Integrate ZITADEL authentication into Flask applications using the OAuth 2.0 PKCE flow." sidebar_label: Flask framework_url: https://flask.palletsprojects.com auth_library: "Authlib" diff --git a/apps/docs/content/sdk-examples/flutter.mdx b/apps/docs/content/sdk-examples/flutter.mdx index 391e1ea75..bf0625d7d 100644 --- a/apps/docs/content/sdk-examples/flutter.mdx +++ b/apps/docs/content/sdk-examples/flutter.mdx @@ -1,5 +1,6 @@ --- title: Flutter +description: "Integrate ZITADEL authentication into Flutter applications using the Flutter SDK and OIDC PKCE." sidebar_label: Flutter --- diff --git a/apps/docs/content/sdk-examples/go.mdx b/apps/docs/content/sdk-examples/go.mdx index 131da75cd..d1f9c2706 100644 --- a/apps/docs/content/sdk-examples/go.mdx +++ b/apps/docs/content/sdk-examples/go.mdx @@ -1,5 +1,6 @@ --- title: Go +description: "Integrate ZITADEL authentication into Go applications using the ZITADEL Go SDK." sidebar_label: Go --- diff --git a/apps/docs/content/sdk-examples/hono.mdx b/apps/docs/content/sdk-examples/hono.mdx index d2e68242e..3ffb15581 100644 --- a/apps/docs/content/sdk-examples/hono.mdx +++ b/apps/docs/content/sdk-examples/hono.mdx @@ -1,5 +1,6 @@ --- title: Hono +description: "Implement secure authentication in Hono applications with ZITADEL and Auth.js using the OAuth 2.0 PKCE flow." sidebar_label: Hono framework_url: https://hono.dev auth_library: "@auth/core" diff --git a/apps/docs/content/sdk-examples/introduction.mdx b/apps/docs/content/sdk-examples/introduction.mdx index 3d2de3a3f..f38ac458a 100644 --- a/apps/docs/content/sdk-examples/introduction.mdx +++ b/apps/docs/content/sdk-examples/introduction.mdx @@ -1,5 +1,6 @@ --- -title: Examples and SDKs for Zitadel +title: Examples and SDKs for ZITADEL +description: "Integrate ZITADEL into your application using our SDKs, example repositories, and guides for popular frameworks." sidebar_label: Introduction --- diff --git a/apps/docs/content/sdk-examples/java.mdx b/apps/docs/content/sdk-examples/java.mdx index 2467654c8..3491bddcf 100644 --- a/apps/docs/content/sdk-examples/java.mdx +++ b/apps/docs/content/sdk-examples/java.mdx @@ -1,5 +1,6 @@ --- title: Java Spring Boot +description: "Integrate ZITADEL authentication into Java Spring Boot applications using OIDC and Spring Security." sidebar_label: Java Spring Boot --- diff --git a/apps/docs/content/sdk-examples/laravel.mdx b/apps/docs/content/sdk-examples/laravel.mdx index 0cb51ab96..2e7cbd3dc 100644 --- a/apps/docs/content/sdk-examples/laravel.mdx +++ b/apps/docs/content/sdk-examples/laravel.mdx @@ -1,5 +1,6 @@ --- title: Laravel +description: "Integrate ZITADEL OAuth 2.0 PKCE with Laravel Socialite to provide secure authentication for your web app." sidebar_label: Laravel framework_url: https://laravel.com auth_library: "Laravel Socialite" diff --git a/apps/docs/content/sdk-examples/nestjs.mdx b/apps/docs/content/sdk-examples/nestjs.mdx index 924ec0658..2edaece86 100644 --- a/apps/docs/content/sdk-examples/nestjs.mdx +++ b/apps/docs/content/sdk-examples/nestjs.mdx @@ -1,5 +1,6 @@ --- title: NestJS +description: "Integrate ZITADEL authentication into NestJS applications using the OAuth 2.0 PKCE flow." sidebar_label: NestJS framework_url: https://nestjs.com auth_library: "@auth/core" diff --git a/apps/docs/content/sdk-examples/nextjs.mdx b/apps/docs/content/sdk-examples/nextjs.mdx index f2ac0a6c7..c404a5cfb 100644 --- a/apps/docs/content/sdk-examples/nextjs.mdx +++ b/apps/docs/content/sdk-examples/nextjs.mdx @@ -1,5 +1,6 @@ --- title: Next.js +description: "Integrate ZITADEL authentication into Next.js applications using the OAuth 2.0 PKCE flow." sidebar_label: Next.js framework_url: https://nextjs.org auth_library: next-auth diff --git a/apps/docs/content/sdk-examples/nuxtjs.mdx b/apps/docs/content/sdk-examples/nuxtjs.mdx index 387b26ba3..a1733e1e6 100644 --- a/apps/docs/content/sdk-examples/nuxtjs.mdx +++ b/apps/docs/content/sdk-examples/nuxtjs.mdx @@ -1,5 +1,6 @@ --- title: Nuxt.js +description: "Integrate ZITADEL authentication into Nuxt.js applications using the OAuth 2.0 PKCE flow." sidebar_label: Nuxt.js framework_url: https://nuxt.com auth_library: next-auth diff --git a/apps/docs/content/sdk-examples/qwik.mdx b/apps/docs/content/sdk-examples/qwik.mdx index c7b9ad0c1..02384c9b9 100644 --- a/apps/docs/content/sdk-examples/qwik.mdx +++ b/apps/docs/content/sdk-examples/qwik.mdx @@ -1,5 +1,6 @@ --- title: Qwik +description: "Integrate ZITADEL authentication into Qwik applications using the OAuth 2.0 PKCE flow." sidebar_label: Qwik framework_url: https://qwik.dev auth_library: "@auth/core" diff --git a/apps/docs/content/sdk-examples/react.mdx b/apps/docs/content/sdk-examples/react.mdx index 182264502..2ff707ba4 100644 --- a/apps/docs/content/sdk-examples/react.mdx +++ b/apps/docs/content/sdk-examples/react.mdx @@ -1,5 +1,6 @@ --- title: React +description: "Integrate ZITADEL authentication into React applications using the OAuth 2.0 PKCE flow." sidebar_label: React framework_url: https://react.dev auth_library: oidc-client-ts diff --git a/apps/docs/content/sdk-examples/solidstart.mdx b/apps/docs/content/sdk-examples/solidstart.mdx index 4ec2eb8e1..2be2597a7 100644 --- a/apps/docs/content/sdk-examples/solidstart.mdx +++ b/apps/docs/content/sdk-examples/solidstart.mdx @@ -1,5 +1,6 @@ --- title: SolidStart +description: "Integrate ZITADEL authentication into SolidStart applications using the OAuth 2.0 PKCE flow." sidebar_label: SolidStart framework_url: https://start.solidjs.com auth_library: "@auth/core" diff --git a/apps/docs/content/sdk-examples/spring.mdx b/apps/docs/content/sdk-examples/spring.mdx index 6014bcf62..9a633b43c 100644 --- a/apps/docs/content/sdk-examples/spring.mdx +++ b/apps/docs/content/sdk-examples/spring.mdx @@ -1,5 +1,6 @@ --- title: Spring Boot +description: "Integrate ZITADEL authentication into Spring Boot applications using the OAuth 2.0 PKCE flow." sidebar_label: Spring Boot framework_url: https://spring.io/projects/spring-boot auth_library: "Spring Security" diff --git a/apps/docs/content/sdk-examples/sveltekit.mdx b/apps/docs/content/sdk-examples/sveltekit.mdx index 0812b850e..fa3b4f982 100644 --- a/apps/docs/content/sdk-examples/sveltekit.mdx +++ b/apps/docs/content/sdk-examples/sveltekit.mdx @@ -1,5 +1,6 @@ --- title: SvelteKit +description: "Integrate ZITADEL authentication into SvelteKit applications using the OAuth 2.0 PKCE flow." sidebar_label: SvelteKit framework_url: https://kit.svelte.dev auth_library: "@auth/core" diff --git a/apps/docs/content/sdk-examples/symfony.mdx b/apps/docs/content/sdk-examples/symfony.mdx index 6e5c069d9..fe39b1506 100644 --- a/apps/docs/content/sdk-examples/symfony.mdx +++ b/apps/docs/content/sdk-examples/symfony.mdx @@ -1,5 +1,6 @@ --- title: Symfony +description: "Integrate ZITADEL authentication into Symfony applications using the OAuth 2.0 PKCE flow." sidebar_label: Symfony framework_url: https://symfony.com auth_library: "Symfony Security" diff --git a/apps/docs/content/sdk-examples/vue.mdx b/apps/docs/content/sdk-examples/vue.mdx index 0d550e0cf..a70ab711a 100644 --- a/apps/docs/content/sdk-examples/vue.mdx +++ b/apps/docs/content/sdk-examples/vue.mdx @@ -1,5 +1,6 @@ --- title: Vue.js +description: "Integrate ZITADEL authentication into Vue.js applications using the OAuth 2.0 PKCE flow." sidebar_label: Vue.js framework_url: https://vuejs.org auth_library: oidc-client-ts diff --git a/apps/docs/content/self-hosting/deploy/compose.mdx b/apps/docs/content/self-hosting/deploy/compose.mdx index 1a835ec93..b0f08d62e 100644 --- a/apps/docs/content/self-hosting/deploy/compose.mdx +++ b/apps/docs/content/self-hosting/deploy/compose.mdx @@ -1,5 +1,6 @@ --- title: Set up Zitadel with Docker Compose +description: "Deploy a ZITADEL instance locally using Docker Compose for rapid testing and development." sidebar_label: Docker Compose --- diff --git a/apps/docs/content/self-hosting/deploy/devcontainer.mdx b/apps/docs/content/self-hosting/deploy/devcontainer.mdx index 18c2d1cde..1c370f04d 100644 --- a/apps/docs/content/self-hosting/deploy/devcontainer.mdx +++ b/apps/docs/content/self-hosting/deploy/devcontainer.mdx @@ -1,5 +1,6 @@ --- title: Developing ZITADEL with Dev Containers +description: "Set up a local ZITADEL development environment using dev containers with Docker and VS Code for minimal setup" sidebar_label: Dev Containers --- diff --git a/apps/docs/content/self-hosting/deploy/kubernetes/caching.mdx b/apps/docs/content/self-hosting/deploy/kubernetes/caching.mdx index e6a678941..1f6df20b7 100644 --- a/apps/docs/content/self-hosting/deploy/kubernetes/caching.mdx +++ b/apps/docs/content/self-hosting/deploy/kubernetes/caching.mdx @@ -1,5 +1,6 @@ --- title: Caching +description: "Configure ZITADEL caching with Redis or Valkey on Kubernetes using authentication methods like passwords and TLS connections" sidebar_label: Caching --- diff --git a/apps/docs/content/self-hosting/deploy/kubernetes/configuration.mdx b/apps/docs/content/self-hosting/deploy/kubernetes/configuration.mdx index 8744411a8..c69c11e5d 100644 --- a/apps/docs/content/self-hosting/deploy/kubernetes/configuration.mdx +++ b/apps/docs/content/self-hosting/deploy/kubernetes/configuration.mdx @@ -1,5 +1,6 @@ --- title: Configuration +description: "Configure ZITADEL Helm chart settings for Kubernetes deployments including global, ZITADEL, and scaling options" sidebar_label: Configuration --- diff --git a/apps/docs/content/self-hosting/deploy/kubernetes/database.mdx b/apps/docs/content/self-hosting/deploy/kubernetes/database.mdx index 6205f3973..8fe41dd57 100644 --- a/apps/docs/content/self-hosting/deploy/kubernetes/database.mdx +++ b/apps/docs/content/self-hosting/deploy/kubernetes/database.mdx @@ -1,5 +1,6 @@ --- title: Database +description: "Configure PostgreSQL connections for ZITADEL on Kubernetes with TLS options to secure database traffic during deployment" sidebar_label: Database --- diff --git a/apps/docs/content/self-hosting/deploy/kubernetes/index.mdx b/apps/docs/content/self-hosting/deploy/kubernetes/index.mdx index e7874fdc9..70397f8be 100644 --- a/apps/docs/content/self-hosting/deploy/kubernetes/index.mdx +++ b/apps/docs/content/self-hosting/deploy/kubernetes/index.mdx @@ -1,6 +1,7 @@ --- title: Kubernetes sidebar_label: Overview +description: Deploy ZITADEL on Kubernetes using Helm charts for scalable identity management --- diff --git a/apps/docs/content/self-hosting/deploy/kubernetes/ingress.mdx b/apps/docs/content/self-hosting/deploy/kubernetes/ingress.mdx index 4c6a02ace..309e3ff32 100644 --- a/apps/docs/content/self-hosting/deploy/kubernetes/ingress.mdx +++ b/apps/docs/content/self-hosting/deploy/kubernetes/ingress.mdx @@ -1,5 +1,6 @@ --- title: Ingress +description: "Configure Kubernetes Ingress resources for ZITADEL and Login containers to manage API traffic and UI access" sidebar_label: Ingress --- diff --git a/apps/docs/content/self-hosting/deploy/kubernetes/installation.mdx b/apps/docs/content/self-hosting/deploy/kubernetes/installation.mdx index aa0017a5c..4b45d8046 100644 --- a/apps/docs/content/self-hosting/deploy/kubernetes/installation.mdx +++ b/apps/docs/content/self-hosting/deploy/kubernetes/installation.mdx @@ -1,5 +1,6 @@ --- title: Installation +description: "Deploy ZITADEL on Kubernetes using Helm with a PostgreSQL database and an Ingress controller for external access" sidebar_label: Installation --- diff --git a/apps/docs/content/self-hosting/deploy/kubernetes/observability.mdx b/apps/docs/content/self-hosting/deploy/kubernetes/observability.mdx index b2a533f14..23b132d75 100644 --- a/apps/docs/content/self-hosting/deploy/kubernetes/observability.mdx +++ b/apps/docs/content/self-hosting/deploy/kubernetes/observability.mdx @@ -1,5 +1,6 @@ --- title: Observability +description: "Collect traces, metrics, and logs from ZITADEL and Login containers using OpenTelemetry and Prometheus for observability monitoring" sidebar_label: Observability --- diff --git a/apps/docs/content/self-hosting/deploy/kubernetes/operations.mdx b/apps/docs/content/self-hosting/deploy/kubernetes/operations.mdx index 357bf3f95..c9a82d0b9 100644 --- a/apps/docs/content/self-hosting/deploy/kubernetes/operations.mdx +++ b/apps/docs/content/self-hosting/deploy/kubernetes/operations.mdx @@ -1,5 +1,6 @@ --- title: Operations +description: "Manage and scale ZITADEL on Kubernetes, covering upgrades, manual and automated scaling, and database considerations" sidebar_label: Operations --- diff --git a/apps/docs/content/self-hosting/deploy/kubernetes/uninstalling.mdx b/apps/docs/content/self-hosting/deploy/kubernetes/uninstalling.mdx index b990c0dc5..4b0276fcf 100644 --- a/apps/docs/content/self-hosting/deploy/kubernetes/uninstalling.mdx +++ b/apps/docs/content/self-hosting/deploy/kubernetes/uninstalling.mdx @@ -1,5 +1,6 @@ --- title: Uninstalling +description: "Uninstall ZITADEL from a Kubernetes cluster by removing the Helm release and cleaning up residual resources" sidebar_label: Uninstalling --- diff --git a/apps/docs/content/self-hosting/deploy/linux.mdx b/apps/docs/content/self-hosting/deploy/linux.mdx index a97bbc1d9..0bf7e3355 100644 --- a/apps/docs/content/self-hosting/deploy/linux.mdx +++ b/apps/docs/content/self-hosting/deploy/linux.mdx @@ -1,5 +1,6 @@ --- title: Install Zitadel on Linux +description: "Installing ZITADEL and PostgreSQL on Linux for a self-hosted environment." sidebar_label: Linux --- diff --git a/apps/docs/content/self-hosting/deploy/macos.mdx b/apps/docs/content/self-hosting/deploy/macos.mdx index dbd457b4a..e14465fa0 100644 --- a/apps/docs/content/self-hosting/deploy/macos.mdx +++ b/apps/docs/content/self-hosting/deploy/macos.mdx @@ -1,5 +1,6 @@ --- title: Install ZITADEL on MacOS +description: "Install PostgreSQL, then deploy ZITADEL on MacOS using Homebrew or by downloading from GitHub and running the binary" sidebar_label: MacOS --- diff --git a/apps/docs/content/self-hosting/deploy/overview.mdx b/apps/docs/content/self-hosting/deploy/overview.mdx index 4dfd8287d..2d21ab4ec 100644 --- a/apps/docs/content/self-hosting/deploy/overview.mdx +++ b/apps/docs/content/self-hosting/deploy/overview.mdx @@ -1,5 +1,6 @@ --- title: Deploy ZITADEL +description: "Comprehensive deployment options for ZITADEL on Linux, macOS, Docker Compose, and Kubernetes." sidebar_label: Overview --- @@ -23,7 +24,7 @@ The easiest way to use ZITADEL is to run one of our container releases - **stable** is the current **production** release of ZITADEL. - **latest** is the **last created** release from our pipelines that gets updated in a high frequency. -# Production Setup +## Production Setup After you have successfully created your first test environment using one of the deployment guides in this section, you might want to configure ZITADEL for production and embed it into your system landscape. diff --git a/apps/docs/content/self-hosting/deploy/troubleshooting/troubleshooting.mdx b/apps/docs/content/self-hosting/deploy/troubleshooting/troubleshooting.mdx index c4dc03886..cecf388c2 100644 --- a/apps/docs/content/self-hosting/deploy/troubleshooting/troubleshooting.mdx +++ b/apps/docs/content/self-hosting/deploy/troubleshooting/troubleshooting.mdx @@ -1,5 +1,6 @@ --- title: Troubleshoot ZITADEL +description: "Resolve common ZITADEL self-hosting issues, including instance not found and upstream header errors during deployment troubleshooting" --- import InstanceNotFound from "../../../self-hosting/deploy/troubleshooting/_instance_not_found.mdx"; diff --git a/apps/docs/content/self-hosting/manage/cache.mdx b/apps/docs/content/self-hosting/manage/cache.mdx index d4fd5a76b..f76e75cf5 100644 --- a/apps/docs/content/self-hosting/manage/cache.mdx +++ b/apps/docs/content/self-hosting/manage/cache.mdx @@ -1,5 +1,6 @@ --- title: Caches +description: "Configure cache connectors for frequently needed objects to speed up internal business logic and improve performance with ZITADEL caching" sidebar_label: Caches [Beta] --- diff --git a/apps/docs/content/self-hosting/manage/cli/mirror.mdx b/apps/docs/content/self-hosting/manage/cli/mirror.mdx index 01d7c2939..0d08a9019 100644 --- a/apps/docs/content/self-hosting/manage/cli/mirror.mdx +++ b/apps/docs/content/self-hosting/manage/cli/mirror.mdx @@ -1,5 +1,6 @@ --- title: Mirror data from cockroach to postgres +description: "Migrate data from CockroachDB to PostgreSQL using ZITADEL mirror commands for database-to-database migrations and replication" sidebar_label: Mirror command --- diff --git a/apps/docs/content/self-hosting/manage/cli/overview.mdx b/apps/docs/content/self-hosting/manage/cli/overview.mdx index c81d5324b..ccabcabdf 100644 --- a/apps/docs/content/self-hosting/manage/cli/overview.mdx +++ b/apps/docs/content/self-hosting/manage/cli/overview.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Command Line Interface +description: "The ZITADEL command line interface to download, initialize, setup, and start ZITADEL" sidebar_label: Overview --- diff --git a/apps/docs/content/self-hosting/manage/configure/configure.mdx b/apps/docs/content/self-hosting/manage/configure/configure.mdx index 98378949f..01fb9286d 100644 --- a/apps/docs/content/self-hosting/manage/configure/configure.mdx +++ b/apps/docs/content/self-hosting/manage/configure/configure.mdx @@ -1,5 +1,6 @@ --- title: Configuration Options in ZITADEL +description: "Detailed guide to configuring ZITADEL using runtime files, database initialization settings, and environment variables." sidebar_label: Configuration --- diff --git a/apps/docs/content/self-hosting/manage/configure/index.mdx b/apps/docs/content/self-hosting/manage/configure/index.mdx index 9aeab4b94..2ab14badf 100644 --- a/apps/docs/content/self-hosting/manage/configure/index.mdx +++ b/apps/docs/content/self-hosting/manage/configure/index.mdx @@ -1,5 +1,6 @@ --- title: Configure ZITADEL +description: Configure ZITADEL runtime settings using YAML files and environment variables for system-wide customization --- Detailed configuration options for ZITADEL. diff --git a/apps/docs/content/self-hosting/manage/custom-domain.mdx b/apps/docs/content/self-hosting/manage/custom-domain.mdx index f9004da05..16526a7da 100644 --- a/apps/docs/content/self-hosting/manage/custom-domain.mdx +++ b/apps/docs/content/self-hosting/manage/custom-domain.mdx @@ -1,6 +1,7 @@ --- title: External ZITADEL Access -sidebar_label: Instance Not Found +description: "Configure custom domains and solve 'Instance not found' errors by ensuring correct Host header routing for ZITADEL instances." +sidebar_label: External Access --- ## Why do I get an "Instance not found" error? diff --git a/apps/docs/content/self-hosting/manage/database/index.mdx b/apps/docs/content/self-hosting/manage/database/index.mdx index 5a6ea459c..09404110d 100644 --- a/apps/docs/content/self-hosting/manage/database/index.mdx +++ b/apps/docs/content/self-hosting/manage/database/index.mdx @@ -1,10 +1,11 @@ --- title: Database +description: Configure and manage the ZITADEL database using PostgreSQL for persistent storage and audit logs --- import Postgres from './_postgres.mdx' -# Database Configuration +## Database Configuration diff --git a/apps/docs/content/self-hosting/manage/http2.mdx b/apps/docs/content/self-hosting/manage/http2.mdx index d5f45f520..cc87f1a5f 100644 --- a/apps/docs/content/self-hosting/manage/http2.mdx +++ b/apps/docs/content/self-hosting/manage/http2.mdx @@ -1,5 +1,6 @@ --- title: HTTP/2 Support in ZITADEL +description: "Configure HTTP/2 support for ZITADEL with reverse proxies and service meshes using gRPC and h2c protocols" sidebar_label: HTTP/2 Support --- diff --git a/apps/docs/content/self-hosting/manage/login-client.mdx b/apps/docs/content/self-hosting/manage/login-client.mdx index f390ef83b..e4b2d53f2 100644 --- a/apps/docs/content/self-hosting/manage/login-client.mdx +++ b/apps/docs/content/self-hosting/manage/login-client.mdx @@ -1,5 +1,6 @@ --- title: Connect your Self-Hosted Login UI to Zitadel +description: "Create a Personal Access Token for login client user with IAM_LOGIN_CLIENT role to connect self-hosted Login UI to ZITADEL API" sidebar_label: Create a Login Client --- @@ -19,7 +20,7 @@ In the following URLs, replace the base URL and the user ID according to your en 3. Save the PAT to a file, for example `/path/on/your/host/login-client.pat` 4. Make sure the user has the `Instance Login Client` role (internally called `IAM_LOGIN_CLIENT`), for example at http://localhost:8080/ui/console/instance/members -# Configure the Login UI +## Configure the Login UI Make sure your Login UI has the environment variable `ZITADEL_SERVICE_USER_TOKEN` set with your PAT. If you run the Login UI with Docker, you can also mount the file into the container and reference it by passing the environment variable `ZITADEL_SERVICE_USER_TOKEN_FILE`. @@ -29,7 +30,7 @@ For example: docker run -p 3000:3000 -v /path/on/your/host/login-client.pat:/path/in/container/login-client.pat:ro -e ZITADEL_SERVICE_USER_TOKEN_FILE=/path/in/container/login-client.pat ghcr.io/zitadel/zitadel-login:latest ``` -# Enable the Login UI for all users +## Enable the Login UI for all users Before doing this, make sure you have a working PAT for an instance Owner user. @@ -40,7 +41,7 @@ Create a service account PAT like you created the [login client PAT above](#crea Enable the `Login V2` feature flag, for example at the bottom of http://localhost:8080/ui/console/instance?id=features. Enter the base URI of your Login UI, for example `http://localhost:3000/ui/v2/login`. -# Test +## Test That's it! Click your users avatar in the top right corner of the management console and select `Log in With Another Account`. diff --git a/apps/docs/content/self-hosting/manage/metrics/overview.mdx b/apps/docs/content/self-hosting/manage/metrics/overview.mdx index bc7331101..61cdd5f22 100644 --- a/apps/docs/content/self-hosting/manage/metrics/overview.mdx +++ b/apps/docs/content/self-hosting/manage/metrics/overview.mdx @@ -1,9 +1,9 @@ --- title: Metrics -description: Overview of ZITADEL metrics, exposure endpoint, and compatibility with monitoring systems. +description: "Monitor ZITADEL operational performance using Prometheus-compatible metrics exposed via the /debug/metrics endpoint." --- -# Metrics +## Metrics ZITADEL exposes operational and performance metrics to support monitoring, alerting, and capacity planning. diff --git a/apps/docs/content/self-hosting/manage/metrics/prometheus.mdx b/apps/docs/content/self-hosting/manage/metrics/prometheus.mdx index 093427f49..ffe0fe8f9 100644 --- a/apps/docs/content/self-hosting/manage/metrics/prometheus.mdx +++ b/apps/docs/content/self-hosting/manage/metrics/prometheus.mdx @@ -1,9 +1,9 @@ --- title: Prometheus -description: Configure Prometheus to scrape ZITADEL metrics from /debug/metrics on Kubernetes and Docker. +description: "Scrape and visualize ZITADEL metrics with Prometheus using Kubernetes autodiscovery or ServiceMonitor." --- -# Prometheus +## Prometheus This page shows platform-agnostic ways to scrape ZITADEL metrics using: diff --git a/apps/docs/content/self-hosting/manage/production.mdx b/apps/docs/content/self-hosting/manage/production.mdx index 3ec924b0e..5411e5772 100644 --- a/apps/docs/content/self-hosting/manage/production.mdx +++ b/apps/docs/content/self-hosting/manage/production.mdx @@ -1,6 +1,7 @@ --- title: ZITADEL Production Setup -sidebar_lable: Production Setup +description: "Configure self-hosted ZITADEL for production, including high availability, networking, monitoring, and logging best practices." +sidebar_label: Production Setup --- As soon as you successfully deployed ZITADEL as a proof of concept using one of our [deployment guides](/self-hosting/deploy/overview), diff --git a/apps/docs/content/self-hosting/manage/productionchecklist.mdx b/apps/docs/content/self-hosting/manage/productionchecklist.mdx index 3850efac0..17f889072 100644 --- a/apps/docs/content/self-hosting/manage/productionchecklist.mdx +++ b/apps/docs/content/self-hosting/manage/productionchecklist.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Production Checklist +description: "Comprehensive checklist for deploying ZITADEL in production, covering infrastructure, security, and operational readiness." sidebar_label: Production Checklist --- diff --git a/apps/docs/content/self-hosting/manage/reverseproxy/caddy/index.mdx b/apps/docs/content/self-hosting/manage/reverseproxy/caddy/index.mdx index 71575fe12..a0ec90087 100644 --- a/apps/docs/content/self-hosting/manage/reverseproxy/caddy/index.mdx +++ b/apps/docs/content/self-hosting/manage/reverseproxy/caddy/index.mdx @@ -1,6 +1,7 @@ --- title: Configure Zitadel with Caddy sidebar_label: Caddy +description: Configure ZITADEL with Caddy reverse proxy including TLS configuration and Docker setup --- import ProxyGuideOverview from '../_proxy_guide_overview.mdx'; diff --git a/apps/docs/content/self-hosting/manage/reverseproxy/cloudflare_tunnel/index.mdx b/apps/docs/content/self-hosting/manage/reverseproxy/cloudflare_tunnel/index.mdx index 360a403d5..3e38bae07 100644 --- a/apps/docs/content/self-hosting/manage/reverseproxy/cloudflare_tunnel/index.mdx +++ b/apps/docs/content/self-hosting/manage/reverseproxy/cloudflare_tunnel/index.mdx @@ -1,6 +1,7 @@ --- title: Configure Zitadel with Cloudflare Tunnel sidebar_label: Cloudflare Tunnel +description: Configure ZITADEL with Cloudflare Tunnel and address known HTTP/2 limitations --- diff --git a/apps/docs/content/self-hosting/manage/reverseproxy/httpd/index.mdx b/apps/docs/content/self-hosting/manage/reverseproxy/httpd/index.mdx index 4223539d8..91b2c8120 100644 --- a/apps/docs/content/self-hosting/manage/reverseproxy/httpd/index.mdx +++ b/apps/docs/content/self-hosting/manage/reverseproxy/httpd/index.mdx @@ -1,6 +1,7 @@ --- title: Configure Zitadel with Apache httpd sidebar_label: Apache httpd +description: Configure ZITADEL with Apache httpd reverse proxy including TLS configuration and Docker setup --- import ProxyGuideOverview from '../_proxy_guide_overview.mdx'; diff --git a/apps/docs/content/self-hosting/manage/reverseproxy/nginx/index.mdx b/apps/docs/content/self-hosting/manage/reverseproxy/nginx/index.mdx index a37f3d0d5..985a9f1f0 100644 --- a/apps/docs/content/self-hosting/manage/reverseproxy/nginx/index.mdx +++ b/apps/docs/content/self-hosting/manage/reverseproxy/nginx/index.mdx @@ -1,6 +1,7 @@ --- title: Configure Zitadel with NGINX sidebar_label: NGINX +description: Configure ZITADEL with NGINX reverse proxy including TLS configuration and Docker setup --- import ProxyGuideOverview from '../_proxy_guide_overview.mdx'; diff --git a/apps/docs/content/self-hosting/manage/reverseproxy/reverse_proxy.mdx b/apps/docs/content/self-hosting/manage/reverseproxy/reverse_proxy.mdx index 5d4f110ff..aa9e8944e 100644 --- a/apps/docs/content/self-hosting/manage/reverseproxy/reverse_proxy.mdx +++ b/apps/docs/content/self-hosting/manage/reverseproxy/reverse_proxy.mdx @@ -1,5 +1,6 @@ --- title: Reverse Proxy Configuration +description: "Setup and configure reverse proxies like Traefik, NGINX, and Caddy to manage external traffic for self-hosted ZITADEL." --- Check out one of the following guides to configure your favorite reverse proxy: diff --git a/apps/docs/content/self-hosting/manage/reverseproxy/traefik/index.mdx b/apps/docs/content/self-hosting/manage/reverseproxy/traefik/index.mdx index fdc061a80..0a8a8d46b 100644 --- a/apps/docs/content/self-hosting/manage/reverseproxy/traefik/index.mdx +++ b/apps/docs/content/self-hosting/manage/reverseproxy/traefik/index.mdx @@ -1,6 +1,7 @@ --- title: Configure Zitadel with Traefik sidebar_label: Traefik +description: Configure ZITADEL with Traefik reverse proxy including TLS configuration and Docker setup --- import ProxyGuideOverview from '../_proxy_guide_overview.mdx'; diff --git a/apps/docs/content/self-hosting/manage/service_ping.mdx b/apps/docs/content/self-hosting/manage/service_ping.mdx index 1b2b40a14..2770632c2 100644 --- a/apps/docs/content/self-hosting/manage/service_ping.mdx +++ b/apps/docs/content/self-hosting/manage/service_ping.mdx @@ -1,5 +1,6 @@ --- title: Service Ping +description: "Configure Service Ping to send anonymized analytics and usage data from ZITADEL systems periodically to improve ZITADEL insights" sidebar_label: Service Ping --- diff --git a/apps/docs/content/self-hosting/manage/tls_modes.mdx b/apps/docs/content/self-hosting/manage/tls_modes.mdx index 19144b54d..e488c0244 100644 --- a/apps/docs/content/self-hosting/manage/tls_modes.mdx +++ b/apps/docs/content/self-hosting/manage/tls_modes.mdx @@ -1,5 +1,6 @@ --- title: TLS Modes +description: "Configure TLS modes for ZITADEL, choosing from disabled, external, or enabled to secure connections according to your infrastructure needs" --- To run ZITADEL on any kind of infrastructure, you can configure on how to handle TLS connections. diff --git a/apps/docs/content/self-hosting/manage/updating_scaling.mdx b/apps/docs/content/self-hosting/manage/updating_scaling.mdx index 0e68c1d72..fa5fd385b 100644 --- a/apps/docs/content/self-hosting/manage/updating_scaling.mdx +++ b/apps/docs/content/self-hosting/manage/updating_scaling.mdx @@ -1,5 +1,6 @@ --- title: Update and Scale ZITADEL +description: "Guidelines for updating and scaling ZITADEL instances, utilizing separate initialization and runtime phases for high availability." sidebar_label: Update and Scale --- diff --git a/apps/docs/content/self-hosting/manage/usage_control.mdx b/apps/docs/content/self-hosting/manage/usage_control.mdx index a7d3657c8..95243dd32 100644 --- a/apps/docs/content/self-hosting/manage/usage_control.mdx +++ b/apps/docs/content/self-hosting/manage/usage_control.mdx @@ -1,5 +1,6 @@ --- title: Usage Control +description: "Manage and limit resource usage in self-hosted ZITADEL instances by setting quotas for requests and action execution." sidebar_label: Usage Control --- diff --git a/apps/docs/content/support/advisory/a10000.mdx b/apps/docs/content/support/advisory/a10000.mdx index d23cad6c6..db99c647d 100644 --- a/apps/docs/content/support/advisory/a10000.mdx +++ b/apps/docs/content/support/advisory/a10000.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10000 +description: "A-10000: ZITADEL's default login behavior changed to auto-authenticate with one active session in v2.32.0 affecting account selection prompts" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10001.mdx b/apps/docs/content/support/advisory/a10001.mdx index 889596838..90ca95014 100644 --- a/apps/docs/content/support/advisory/a10001.mdx +++ b/apps/docs/content/support/advisory/a10001.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10001 +description: "A-10001: Allow Register setting in ZITADEL v2.35.0 now only disables local registration, not external IDP registration by default" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10002.mdx b/apps/docs/content/support/advisory/a10002.mdx index f94008b45..039b82612 100644 --- a/apps/docs/content/support/advisory/a10002.mdx +++ b/apps/docs/content/support/advisory/a10002.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10002 +description: "A-10002: ZITADEL management console UI loses dynamic theming capability in version 2.40.0 due to MDC component changes" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10003.mdx b/apps/docs/content/support/advisory/a10003.mdx index aee502a56..5635f9145 100644 --- a/apps/docs/content/support/advisory/a10003.mdx +++ b/apps/docs/content/support/advisory/a10003.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10003 +description: "A-10003: Default organization settings now apply to Login-UI when no org context is provided in ZITADEL v2.38.0" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10004.mdx b/apps/docs/content/support/advisory/a10004.mdx index 4745bd543..e7c0b9adb 100644 --- a/apps/docs/content/support/advisory/a10004.mdx +++ b/apps/docs/content/support/advisory/a10004.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10004 +description: "A-10004: Sequences in ZITADEL now increment per aggregate ID instead of globally from v2.39.0 affecting event ordering and uniqueness" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10005.mdx b/apps/docs/content/support/advisory/a10005.mdx index bf4b32132..ec7c1ceb0 100644 --- a/apps/docs/content/support/advisory/a10005.mdx +++ b/apps/docs/content/support/advisory/a10005.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10005 +description: "A-10005: Renaming eventstore.events table causes downtime during setup in ZITADEL v2.39.0 due to storage optimizations for events migration" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10006.mdx b/apps/docs/content/support/advisory/a10006.mdx index 376750e7c..441a61aaa 100644 --- a/apps/docs/content/support/advisory/a10006.mdx +++ b/apps/docs/content/support/advisory/a10006.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10006 +description: "A-10006: CockroachDB users of ZITADEL require VIEWACTIVITY grant for correct event ordering in versions 2.39.0 and later" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10007.mdx b/apps/docs/content/support/advisory/a10007.mdx index 30ac5bcb4..4292836e2 100644 --- a/apps/docs/content/support/advisory/a10007.mdx +++ b/apps/docs/content/support/advisory/a10007.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10007 +description: "A-10007: Upcoming ZITADEL versions apply RBAC to system users with new SYSTEM_OWNER role affecting custom permission mappings" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10008.mdx b/apps/docs/content/support/advisory/a10008.mdx index 7885eb50d..146c96b6a 100644 --- a/apps/docs/content/support/advisory/a10008.mdx +++ b/apps/docs/content/support/advisory/a10008.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10008 +description: "A-10008: ZITADEL versions 2.42 > 2.42.12, 2.43 >= 2.43.6, and 2.44.0 enable prefilling of database projections during setup by default" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10009.mdx b/apps/docs/content/support/advisory/a10009.mdx index b1d6cce1c..db43749cc 100644 --- a/apps/docs/content/support/advisory/a10009.mdx +++ b/apps/docs/content/support/advisory/a10009.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10009 +description: "A-10009: ZITADEL now requires CockroachDB with enabledurablelockingforserializable flag for distributed locking on FOR UPDATE statements in v2.53.0" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10010.mdx b/apps/docs/content/support/advisory/a10010.mdx index c2fd95902..8f66b4c1e 100644 --- a/apps/docs/content/support/advisory/a10010.mdx +++ b/apps/docs/content/support/advisory/a10010.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10010 +description: "A-10010: The creation of user tokens now generates 'user.token.v2.added' events in ZITADEL v2.53.0 instead of 'user.token.added' for audit log consistency" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10011.mdx b/apps/docs/content/support/advisory/a10011.mdx index bf829497a..bce707919 100644 --- a/apps/docs/content/support/advisory/a10011.mdx +++ b/apps/docs/content/support/advisory/a10011.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10011 +description: "A-10011: Automatic identity provider creation and linking now decoupled from manual account settings in ZITADEL v2.59.0" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10012.mdx b/apps/docs/content/support/advisory/a10012.mdx index 60532d9db..fb1923189 100644 --- a/apps/docs/content/support/advisory/a10012.mdx +++ b/apps/docs/content/support/advisory/a10012.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10012 +description: "A-10012: Increased transaction duration for projections in ZITADEL v2.63.0 resolves deadlock issues with outdated data due to timeouts" --- ## Date and Version diff --git a/apps/docs/content/support/advisory/a10013.mdx b/apps/docs/content/support/advisory/a10013.mdx index f78f5fe1d..5770fb6b0 100644 --- a/apps/docs/content/support/advisory/a10013.mdx +++ b/apps/docs/content/support/advisory/a10013.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10013 +description: "A-10013: ZITADEL's stable release channel discontinued as of 2024-12-09 affecting all versions prior to specific version tags" --- ## Date diff --git a/apps/docs/content/support/advisory/a10014.mdx b/apps/docs/content/support/advisory/a10014.mdx index 74811b163..39dca888c 100644 --- a/apps/docs/content/support/advisory/a10014.mdx +++ b/apps/docs/content/support/advisory/a10014.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10014 +description: "A-10014: ZITADEL v2.66.6 corrects existing project grant owners, breaking ListAllProjectGrants with x-ZITADEL-orgid header set" --- ## Date diff --git a/apps/docs/content/support/advisory/a10015.mdx b/apps/docs/content/support/advisory/a10015.mdx index 182605c47..f15a4f8d2 100644 --- a/apps/docs/content/support/advisory/a10015.mdx +++ b/apps/docs/content/support/advisory/a10015.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10015 +description: "A-10015: ZITADEL drops CockroachDB support in favor of PostgreSQL, affecting deployments using CockroachDB as database from v3.0.0 onwards" --- ## Date diff --git a/apps/docs/content/support/advisory/a10016.mdx b/apps/docs/content/support/advisory/a10016.mdx index c6f31d0de..504c19274 100644 --- a/apps/docs/content/support/advisory/a10016.mdx +++ b/apps/docs/content/support/advisory/a10016.mdx @@ -1,5 +1,6 @@ --- title: Technical Advisory 10016 +description: "A-10016: Precision bug fix affects compare operations in projections due to changes in eventstore position handling in ZITADEL v2.65.x-v3.2.1" --- ## Date diff --git a/apps/docs/content/support/technical_advisory.mdx b/apps/docs/content/support/technical_advisory.mdx index 4b0157340..d7514eaa8 100644 --- a/apps/docs/content/support/technical_advisory.mdx +++ b/apps/docs/content/support/technical_advisory.mdx @@ -1,5 +1,6 @@ --- title: ZITADEL Technical Advisories +description: "ZITADEL security and technical advisories, including important updates, vulnerability disclosures, and required configuration changes." sidebar_label: Technical Advisories --- diff --git a/apps/docs/content/support/troubleshooting.mdx b/apps/docs/content/support/troubleshooting.mdx index 4381b551d..bf9ad1434 100644 --- a/apps/docs/content/support/troubleshooting.mdx +++ b/apps/docs/content/support/troubleshooting.mdx @@ -1,5 +1,6 @@ --- title: Troubleshoot ZITADEL +description: "Common troubleshooting steps for ZITADEL, including error messages, login issues, and community support resources." sidebar_label: Troubleshoot --- diff --git a/apps/docs/lib/sidebar-data.ts b/apps/docs/lib/sidebar-data.ts index 32f92fc07..8d310a060 100644 --- a/apps/docs/lib/sidebar-data.ts +++ b/apps/docs/lib/sidebar-data.ts @@ -39,7 +39,7 @@ export const guidesSidebar: readonly SidebarItem[] = [ title: "Key Concepts", slug: "concepts", description: - "This part of our documentation contains ZITADEL specific or general concepts required to understand the system or our guides.", + "Learn about ZITADEL's core architecture and terminology. This section covers identity management concepts, multi-tenancy, and technical structures essential for understanding our platform.", }, items: [ "concepts/structure/instance", @@ -74,7 +74,7 @@ export const guidesSidebar: readonly SidebarItem[] = [ title: "Example Applications", slug: "/examples/introduction", description: - "Practical examples showing how to integrate ZITADEL authentication and secure APIs across different application types and frameworks.", + "Discover practical quickstart guides and example applications for ZITADEL. We provide step-by-step instructions for popular frameworks like React, Angular, Vue, Next.js, and more.", }, items: [ { @@ -85,7 +85,7 @@ export const guidesSidebar: readonly SidebarItem[] = [ title: "Frontend (SPA) Quickstart Guides", slug: "/examples/introduction/frontend", description: - "Quickstart guides for integrating ZITADEL authentication into frontend single-page applications.", + "Step-by-step instructions for integrating ZITADEL authentication into your frontend single-page applications. Includes guides for React, Angular, Vue, and vanilla JS.", }, items: [ { @@ -106,7 +106,7 @@ export const guidesSidebar: readonly SidebarItem[] = [ title: "Mobile & Native Quickstart Guides", slug: "/examples/introduction/mobile", description: - "Quickstart guides for integrating ZITADEL authentication into Mobile & Native applications.", + "Quickstart guides for integrating ZITADEL authentication into mobile and native applications. Learn how to secure your mobile apps with our Flutter and .NET guides.", }, items: [ "examples/login/flutter", @@ -120,7 +120,7 @@ export const guidesSidebar: readonly SidebarItem[] = [ title: "Full-Stack / SSR Quickstart Guides", slug: "/examples/introduction/fullstack", description: - "Quickstart guides for integrating ZITADEL authentication into Full-Stack / SSR applications.", + "Integrate ZITADEL with your full-stack and server-side rendered (SSR) applications. Follow our guides for Next.js, B2B scenarios, and other modern web frameworks.", }, items: [ "examples/login/nextjs", @@ -135,7 +135,7 @@ export const guidesSidebar: readonly SidebarItem[] = [ title: "Web App (Server-Side) Quickstart Guides", slug: "/examples/introduction/webapp", description: - "Quickstart guides for integrating ZITADEL authentication into Web App (Server-Side) applications.", + "Step-by-step guides for integrating ZITADEL into traditional server-side web applications. Learn how to secure Java Spring, PHP Symfony, Django, and Go apps.", }, items: [ "examples/login/symfony", @@ -152,7 +152,7 @@ export const guidesSidebar: readonly SidebarItem[] = [ title: "APIs / Backend Quickstart Guides", slug: "/examples/introduction/backend", description: - "Quickstart guides for integrating ZITADEL authentication into APIs / Backend Services.", + "Learn how to secure your APIs and backend services using ZITADEL. Includes examples for Node.js, Python, Go, Java, and NestJS to implement robust authentication.", }, items: [ "examples/secure-api/go", @@ -244,7 +244,7 @@ export const guidesSidebar: readonly SidebarItem[] = [ title: "Authenticate users with OpenID Connect (OIDC)", slug: "guides/integrate/login/oidc", description: - "This guide explains how to utilize ZITADEL for user authentication within your applications using OpenID Connect (OIDC). Here, we offer comprehensive guidance on seamlessly integrating ZITADEL's authentication features, ensuring both security and user experience excellence. Throughout this documentation, we'll cover the setup process for ZITADEL authentication, including the recommended OIDC flows tailored to different application types. Additionally, we'll provide clear instructions on securely signing out or logging out users from your application, ensuring data security and user privacy. With our guidance, you'll be equipped to leverage ZITADEL's authentication capabilities effectively, enhancing your application's security posture while delivering a seamless login experience for your users.", + "Comprehensive guide to user authentication in ZITADEL using OpenID Connect (OIDC), including recommended flows and session management.", }, items: [ "guides/integrate/login/oidc/oauth-recommended-flows", @@ -444,7 +444,7 @@ export const guidesSidebar: readonly SidebarItem[] = [ title: "Integrate ZITADEL with your Favorite Services", slug: "/guides/integrate/services", description: - "With the guides in this section you will learn how to integrate ZITADEL with your services.", + "Step-by-step guides for integrating ZITADEL with popular services and tools including Google Workspace, AWS, Atlassian, Cloudflare, GitLab, and many other software solutions.", }, items: [ "guides/integrate/services/google-workspace", @@ -518,7 +518,7 @@ export const guidesSidebar: readonly SidebarItem[] = [ title: "Build your own Login UI", slug: "/guides/integrate/login-ui", description: - "In the following guides you will learn how to create your own login UI with our APIs. The different scenarios like username/password, external identity provider, etc. will be shown.", + "Create a completely customized login experience using the ZITADEL Session and OIDC APIs. Learn how to handle username/password, MFA, passkeys, and external identity providers.", }, collapsed: true, items: [ @@ -1092,7 +1092,7 @@ export const legalSidebar: readonly SidebarItem[] = [ title: "Service description", slug: "/legal/service-description", description: - "Description of services and service levels for ZITADEL Cloud and Enterprise subscriptions.", + "Detailed description of services, service levels (SLA), and support commitments for ZITADEL Cloud and Enterprise subscriptions to ensure transparency and reliability.", }, items: [ { @@ -1115,7 +1115,7 @@ export const legalSidebar: readonly SidebarItem[] = [ title: "Policies", slug: "/legal/policies", description: - "Policies and guidelines in addition to our terms of services.", + "Find all policy documents and guidelines for ZITADEL services, including our privacy policy, acceptable use policy, and other legal frameworks that govern our platform.", }, items: [ { diff --git a/apps/docs/scripts/generate-api-reference.mts b/apps/docs/scripts/generate-api-reference.mts index 71a561af5..aea6d17e3 100644 --- a/apps/docs/scripts/generate-api-reference.mts +++ b/apps/docs/scripts/generate-api-reference.mts @@ -72,6 +72,7 @@ async function generateVersionApiDocs(version: string) { const title = uniqueService.split('-').map(s => s.charAt(0).toUpperCase() + s.slice(1)).join(' '); const indexContent = `--- title: ${title} API +description: Explore the ZITADEL ${title} API reference documentation. Learn how to manage resources, handle authentication, and integrate ${title} services into your application. --- API Reference for ${title} @@ -203,6 +204,89 @@ async function fixAllGeneratedLinks() { return match; }); + // Add description to frontmatter if missing or corrupted and it's an API reference page + if (file.includes('reference/api')) { + const titleMatch = newContent.match(/^title:\s*(.*)$/m); + if (titleMatch) { + let title = titleMatch[1].replace(/['"]/g, '').trim(); + // Handle multiline titles + if (title === '|' || title === '|-' || title === '>') { + const lines = newContent.slice(titleMatch.index).split('\n'); + if (lines.length > 1) { + title = lines[1].trim(); + } + } + + // Try to find the operation summary in _openapi contents + const summaryMatch = newContent.match(/contents:\s*-\s*content:\s*(?:[|>]-?\s*)?([\s\S]+?)(?=\n\s*---|\n\s*(_|\w)+:|$)/); + let description = ''; + if (summaryMatch) { + description = summaryMatch[1] + .split('\n') + .map(line => line.trim()) + .filter(line => line.length > 0 && !line.startsWith('- ') && !line.startsWith('---')) + .join(' '); + + if (description.length > 200) { + description = description.slice(0, 197) + '...'; + } + } + + if (!description || description.length < 50) { + description = `Explore the ${title} operation in the ZITADEL API. Learn about request parameters, response schemas, and integration details for this endpoint.`; + } + + // Clean up title for description use + const cleanTitle = title.replace(/\n\s+/g, ' ').trim(); + if (!description.includes(cleanTitle)) { + description = `${cleanTitle}: ${description}`; + } + + // Final sanitization for YAML double-quoted string + description = description + .replace(/\\/g, '\\\\') // Escape backslashes first to avoid double-processing + .replace(/\n/g, ' ') + .replace(/"/g, "'") // Use single quotes internally + .replace(/\s+/g, ' ') + .trim(); + + const newDescLine = `description: "${description}"`; + + // Clean existing descriptions to avoid duplicates or corrupted ones + const oldContent = newContent; + + // Split frontmatter and body + const parts = newContent.split('---'); + if (parts.length >= 3) { + let frontmatter = parts[1]; + // Remove any existing description keys and their potential multiline values + // This regex matches "description:" and then everything until it sees a new key (word followed by colon) + // or the end of the frontmatter section. + frontmatter = frontmatter.replace(/description:\s*[\s\S]*?(?=\n\w+:|$)/g, ''); + + // Also explicitly fix the "iam.member.read" type corruption by looking for lines that start with quotes + // but have no colon, which follow a description line. + // Actually the regex above should have caught it if it matched until the next key. + + // Clean up any double newlines and trim + frontmatter = frontmatter.split('\n').filter(line => line.trim().length > 0).join('\n'); + + parts[1] = `\n${newDescLine}\n${frontmatter}\n`; + newContent = parts.join('---'); + } + + if (newContent !== oldContent) { + modified = true; + } + } + } + + // Fix previously corrupted frontmatter (title followed immediately by description) + if (newContent.match(/^title: \|-?\ndescription: /m)) { + newContent = newContent.replace(/^(title: \|-?)\ndescription: (.*)\n/m, "description: $2\n$1\n"); + modified = true; + } + if (modified) { writeFileSync(fullPath, newContent); } diff --git a/internal/api/assets/generator/asset_generator.go b/internal/api/assets/generator/asset_generator.go index efd4687c0..18ddc053e 100644 --- a/internal/api/assets/generator/asset_generator.go +++ b/internal/api/assets/generator/asset_generator.go @@ -253,6 +253,7 @@ func RegisterRoutes(router *mux.Router, s {{.Name}}) { const docsTmpl = `--- title: zitadel/assets +description: "Learn how to upload and manage instance, organization, or user assets such as logos and avatars using ZITADEL's AssetsService API endpoints. Full reference and examples included." --- {/*