mirror of
https://github.com/zitadel/zitadel.git
synced 2026-08-19 01:14:48 -05:00
docs: add description frontmatter to content pages for SEO (#11654)
This commit is contained in:
@@ -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 (
|
||||
<DocsPage toc={page.data.toc} full={page.data.full}>
|
||||
<DocsTitle>{page.data.title}</DocsTitle>
|
||||
<DocsDescription>{page.data.description}</DocsDescription>
|
||||
<DocsBody>
|
||||
<MDX
|
||||
components={getMDXComponents({
|
||||
@@ -66,9 +64,14 @@ export async function generateMetadata(
|
||||
}
|
||||
}
|
||||
|
||||
let description = page.data.description;
|
||||
if (!description) {
|
||||
description = `Explore ZITADEL documentation for ${page.data.title}. Learn how to integrate, manage, and secure your applications with our comprehensive identity and access management solutions.`;
|
||||
}
|
||||
|
||||
return {
|
||||
title: page.data.title,
|
||||
description: page.data.description,
|
||||
description: description.length > 200 ? description.substring(0, 197) + '...' : description,
|
||||
alternates: {
|
||||
canonical: canonicalUrl,
|
||||
},
|
||||
|
||||
@@ -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: [
|
||||
{
|
||||
|
||||
@@ -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';
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Features
|
||||
description: Explore core ZITADEL features including identity brokering, audit trails, and self-service
|
||||
---
|
||||
|
||||
<Cards >
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Knowledge
|
||||
description: Explore technical concepts and knowledge base articles for ZITADEL identity management
|
||||
---
|
||||
|
||||
<Cards >
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Structure
|
||||
description: Explore the hierarchical structure of ZITADEL instances, organizations, and resource ownership
|
||||
---
|
||||
|
||||
<Cards >
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Instances
|
||||
description: "Overview of ZITADEL Instances—the virtual tenants providing full data isolation and independent settings."
|
||||
sidebar_label: Instances
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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**
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: ZITADEL with Angular
|
||||
description: "Integrate ZITADEL into Angular applications using OIDC and PKCE for user authentication."
|
||||
sidebar_label: Angular
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
---
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: ZITADEL with Go
|
||||
description: "Integrate ZITADEL for user login and profile retrieval in Go web applications."
|
||||
sidebar_label: Go
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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';
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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)
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user