fix: Separate Example Applications and SDKs/Integrations more clearly (#11569)

# Which Problems Are Solved The distinction between Example Applications and SDKs has not been clear. In the SDKs section a lot of Example applications where listed. Also In the SDKs it was not really clear what the SDKs actually are. Also some examples and skds are outdated and not well maintained anymore. # How the Problems Are Solved - Moved all example app guides to the Example Applications Section - Restructured SDKs Nav --> SDKs & Integrations: Frontend & Mobile, Backend & API, Management API Clients - Removed unnecessary / outdated guides - Remove ids in framework.json for frameworks which shouldn't be rendered in console ## Todos: - Update SDKs Introduction page - Add links to common oidc libs for most used frameworks --------- Co-authored-by: Mridang Agarwalla <[email protected]>
2026-10-19 22:14:25 +00:00 · 2026-03-11 14:57:15 +01:00
parent d5f35fbd54
commit 574e23e834
33 changed files with 364 additions and 1696 deletions
@@ -1,7 +1,7 @@
 ---
-title: ZITADEL with Go
+title: Secure Go API Application with ZITADEL
 description: "Secure Go APIs using OAuth 2.0 Token Introspection with ZITADEL and role-based authorization."
-sidebar_label: Go
+sidebar_label: Go API
 ---

 This integration guide shows you how to integrate **ZITADEL** into your Go API. It demonstrates how to secure your API using
@@ -1,8 +1,9 @@
 ---
-title: ZITADEL with Java Spring Boot
+title: Secure Java Spring Boot API Application with ZITADEL
 description: "Secure Java Spring Boot APIs using OAuth 2.0 Token Introspection with ZITADEL."
 sidebar_label: Java Spring Boot
 ---
+import { GithubCodeBlock } from '@/components/github-code-block';

 This integration guide shows you how to integrate **ZITADEL** into your Java Spring Boot API. It demonstrates how to secure your API using
 OAuth 2 Token Introspection.
@@ -44,9 +45,7 @@ into Spring Security `authiorities`, which can be used later on to determine the

 So in your application, create a `support/zitadel` package and in there the `CustomAuthorityOpaqueTokenIntrospector.java`:

-```java reference
-https://github.com/zitadel/zitadel-java/blob/main/api/src/main/java/demo/app/support/zitadel/CustomAuthorityOpaqueTokenIntrospector.java
-```
+<GithubCodeBlock url="https://github.com/zitadel/zitadel-java/blob/main/api/src/main/java/demo/app/support/zitadel/CustomAuthorityOpaqueTokenIntrospector.java"></GithubCodeBlock>

 ### Application server settings

@@ -56,15 +55,11 @@ In a new `config` package, create the `WebSecurityConfig.java`.
 This class will take care of the authorization by require the calls on `/api/tasks` to be authorized. Any other endpoint will be public by default.
 It will also use the just created CustomAuthorityOpaqueTokenIntrospector for the introspection call:

-```java reference
-https://github.com/zitadel/zitadel-java/blob/main/api/src/main/java/demo/app/config/WebSecurityConfig.java
-```
+<GithubCodeBlock url="https://github.com/zitadel/zitadel-java/blob/main/api/src/main/java/demo/app/config/WebSecurityConfig.java"></GithubCodeBlock>

 For the authorization (and the server in general) to work, the application needs some settings, so please provide the following to your `application.yml` (resources folder):

-```yaml reference
-https://github.com/zitadel/zitadel-java/blob/main/api/src/main/resources/application.yml
-```
+<GithubCodeBlock url="https://github.com/zitadel/zitadel-java/blob/main/api/src/main/resources/application.yml"></GithubCodeBlock>

 Note that the `introspection-uri`, `client-id` and `client-secret` are only placeholders. You can either change them in here using the values provided by ZITADEL
 or pass them later on as arguments when starting the application.
@@ -80,9 +75,7 @@ If authorization is required, the token must not be expired and the API has to b

 For tests we will use a Personal Access Token or the [Java Spring web example](../login/java-spring).

-```java reference
-https://github.com/zitadel/zitadel-java/blob/main/api/src/main/java/demo/app/api/ExampleController.java
-```
+<GithubCodeBlock url="https://github.com/zitadel/zitadel-java/blob/main/api/src/main/java/demo/app/api/ExampleController.java"></GithubCodeBlock>

 ## Test API

@@ -1,11 +1,14 @@
 ---
-title: ZITADEL with Node.js
+title: Secure Nest.js API Application with ZITADEL
 description: "Secure Node.js APIs in NestJS by validating access tokens with ZITADEL's introspection endpoint."
 sidebar_label: NestJS
 ---

 ## ZITADEL with Node.js (NestJS)

+<Callout>Community Contribution This example was created by a member of the ZITADEL community. It’s a great resource for seeing how others are building, but please note it is maintained by the community rather than the ZITADEL core team.</Callout>
+
+
 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.

 ## Overview
@@ -1,5 +1,5 @@
 ---
-title: ZITADEL with Pylon
+title: Secure Pylon API Application with ZITADEL
 description: "Integrate ZITADEL with Pylon services by validating tokens and checking permissions for secure API endpoints"
 sidebar_label: Pylon
 ---
@@ -1,13 +1,14 @@
 ---
-title: ZITADEL with Django Python
+title: Secure Django (Python) API Application with ZITADEL
 description: "Integrate ZITADEL with Django Python to validate tokens and check permissions for secure API access using OIDC protocol standards"
-sidebar_label: Django
+sidebar_label: Django API
 ---

 import AppJWT from '../imports/_app_jwt.mdx';
 import ServiceAccountJWT from '../imports/_serviceaccount_jwt.mdx';
 import ServiceAccountRole from '../imports/_serviceaccount_role.mdx';
 import SetupPython from '../imports/_setup_python.mdx';
+import { GithubCodeBlock } from '@/components/github-code-block';

 This integration guide demonstrates the recommended way to incorporate ZITADEL into your Django Python application.
 It explains how to check the token validity in the API and how to check for permissions.
@@ -15,7 +16,7 @@ It explains how to check the token validity in the API and how to check for perm
 By the end of this guide, your application will have three different endpoints that are public, private (valid token) and private-scoped (valid token with a specific role).

 <Callout>
-This documentation references our [example](https://github.com/zitadel/example-django-python-oauth) on GitHub.
+This documentation references our [example](https://github.com/zitadel/example-python-django-oauth) on GitHub.
 </Callout>

 ## ZITADEL setup
@@ -62,9 +63,7 @@ For this example we need the following dependencies:

 For the dependencies we need a requirements.txt-file with the following content:

-```python reference
-https://github.com/zitadel/example-python-django-oauth/blob/main/requirements.txt
-```
+<GithubCodeBlock url="https://github.com/zitadel/example-python-django-oauth/blob/main/requirements.txt"></GithubCodeBlock>

 Then install all dependencies with:
 ```bash
@@ -82,9 +81,7 @@ django-admin startproject myapi .

 There is info needed for the introspection calls, which we put into the settings.py:

-```python reference
-https://github.com/zitadel/example-python-django-oauth/blob/main/myapi/settings.py#L125-L133
-```
+<GithubCodeBlock url="https://github.com/zitadel/example-python-django-oauth/blob/main/myapi/settings.py#L125-L133"></GithubCodeBlock>

 and create a ".env"-file in the root folder with the settings as an example:
 ```bash
@@ -106,25 +103,16 @@ API_PRIVATE_KEY_FILE_PATH = '/tmp/example/250719519163548112.json'
 To validate the tokens, we need a validator which can be called in the event of API-calls.

 validator.py:
-
-```python reference
-https://github.com/zitadel/example-python-django-oauth/blob/main/myapi/validator.py
-```
+<GithubCodeBlock url="https://github.com/zitadel/example-python-django-oauth/blob/main/myapi/validator.py"></GithubCodeBlock>

 ### Requests and URLs

 We define 3 different endpoints which differ in terms of requirements.
 views.py:
-
-```python reference
-https://github.com/zitadel/example-python-django-oauth/blob/main/myapi/views.py
-```
+<GithubCodeBlock url="https://github.com/zitadel/example-python-django-oauth/blob/main/myapi/views.py"></GithubCodeBlock>

 To handle endpoints the urls have to be added to the urls.py:
-
-```python reference
-https://github.com/zitadel/example-python-django-oauth/blob/main/myapi/urls.py
-```
+<GithubCodeBlock url="https://github.com/zitadel/example-python-django-oauth/blob/main/myapi/urls.py"></GithubCodeBlock>

 ### DB

@@ -1,7 +1,7 @@
 ---
-title: ZITADEL with Python
+title: Secure Flask (Python) API Application with ZITADEL
 description: "Secure Python Flask APIs with ZITADEL token validation and role-based access control."
-sidebar_label: Python
+sidebar_label: Flask API
 ---

 This example shows you how to secure a Python3 Flask API with both authentication and authorization using ZITADEL.