docs: add description frontmatter to content pages for SEO (#11654)

2026-11-12 00:55:12 +00:00 · 2026-02-21 07:44:42 -08:00
parent afeeee87c3
commit 2c260a1f10
304 changed files with 421 additions and 46 deletions
@@ -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.
@@ -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.
@@ -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.
@@ -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).
@@ -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.
@@ -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.
@@ -1,5 +1,6 @@
 ---
 title: Objects
+description: "Documentation for the objects and data structures available within the ZITADEL Actions JavaScript environment."
 ---

 ## External User
@@ -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';
@@ -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."
 ---

 {/*
@@ -1,6 +1,7 @@
 ---
 title: Benchmarks
 sidebar_label: Benchmarks
+description: Analyze ZITADEL performance benchmarks to understand resource requirements for specific workloads
 ---


@@ -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
 ---

@@ -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.
@@ -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
 ---

@@ -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
 ---

@@ -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
 ---

@@ -1,5 +1,6 @@
 ---
 title: ZITADEL OIDC Authentication Request Playground
+description: "The OIDC playground for testing and constructing authentication requests."
 sidebar_label: OIDC Playground
 ---

@@ -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
 ---

@@ -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
 ---

@@ -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
 ---

@@ -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
 ---

@@ -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
@@ -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
@@ -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
 ---

@@ -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';