andwati/zitadel
1
0
Fork 0
mirror of https://github.com/andwati/zitadel.git synced 2026-11-14 09:55:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: added docs for the new dotnet example (#11541)

Browse Source
This commit is contained in:
Mridang Agarwalla
2026-02-23 07:55:18 +00:00
committed by GitHub
parent 71fab2e574
commit 6150a61216
6 changed files with 137 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/content/guides/start/quickstart.mdx
+39
View File
@@ -83,6 +83,12 @@ ZITADEL automatically configures the best security settings for your selected fr
postLogoutRedirectUrl="http://localhost:3000/api/auth/logout/callback">
</AppConfig>
</Tab>
<Tab value="ASP.NET Core">
<AppConfig
redirectUrl="http://localhost:3000/auth/callback"
postLogoutRedirectUrl="http://localhost:3000/auth/logout/callback">
</AppConfig>
</Tab>
<Tab value="Django">
<AppConfig
redirectUrl="http://localhost:3000/auth/callback"
@@ -210,6 +216,9 @@ ZITADEL automatically configures the best security settings for your selected fr
<Tab value="Astro">
<AppValues valueCount="three" clientSecret={true} ></AppValues>
</Tab>
<Tab value="ASP.NET Core">
<AppValues valueCount="three" clientSecret={true}></AppValues>
</Tab>
<Tab value="Django">
<AppValues valueCount="two" clientSecret={false}></AppValues>
</Tab>
@@ -292,6 +301,9 @@ ZITADEL handles the complexity of the OIDC handshake so your app stays secure wi
- [Node.js](https://nodejs.org/)
- [npm](https://www.npmjs.com/)
</Tab>
<Tab value="ASP.NET Core">
- [.NET SDK 8 or later](https://dotnet.microsoft.com/download)
</Tab>
<Tab value="Django">
- [Python](https://www.python.org/)
- [Poetry](https://python-poetry.org/)
@@ -383,6 +395,12 @@ ZITADEL handles the complexity of the OIDC handshake so your app stays secure wi
cd example-auth-astro
```
</Tab>
<Tab value="ASP.NET Core">
```bash
git clone https://github.com/zitadel/example-auth-dotnet.git
cd example-auth-dotnet
```
</Tab>
<Tab value="Django">
```bash
git clone https://github.com/zitadel/example-auth-django.git
@@ -534,6 +552,19 @@ ZITADEL handles the complexity of the OIDC handshake so your app stays secure wi
NEXTAUTH_URL="http://localhost:3000"
```
</Tab>
<Tab value="ASP.NET Core">
1. Copy+paste the .env.example to .env
2. Update the ZITADEL_CLIENT_ID, ZITADEL_CLIENT_SECRET and ZITADEL_DOMAIN with the client id and issuer you collected in Step 5.
```bash
PORT=3000
SESSION_DURATION=3600
ZITADEL_DOMAIN="https://your-zitadel-domain"
ZITADEL_CLIENT_ID="your-zitadel-application-client-id"
ZITADEL_CLIENT_SECRET="your-randomly-generated-client-secret"
ZITADEL_POST_LOGOUT_URL="http://localhost:3000/auth/logout/callback"
```
</Tab>
<Tab value="Django">
1. Copy+paste the .env.example to .env
2. Update the ZITADEL_CLIENT_ID and ZITADEL_DOMAIN with the client id and issuer you collected in Step 5.
@@ -854,6 +885,14 @@ ZITADEL handles the complexity of the OIDC handshake so your app stays secure wi
![Astro Example App](../../../public/img/guides/quickstart/astro_example_app.png)
</Tab>
<Tab value="ASP.NET Core">
```bash
make start
```
Your app will be live at `http://localhost:3000`.
</Tab>
<Tab value="Django">
```bash
make start
apps/docs/content/sdk-examples/dotnet.mdx
+78
View File
@@ -0,0 +1,78 @@
---
title: ASP.NET Core
sidebar_label: ASP.NET Core
framework_url: https://learn.microsoft.com/aspnet/core/
auth_library: "Microsoft.AspNetCore.Authentication.OpenIdConnect"
auth_library_url: https://learn.microsoft.com/aspnet/core/security/authentication/openid-connect
example_repo: https://github.com/zitadel/example-auth-dotnet
auth_flow: pkce
status: stable
---
## Overview
[ASP.NET Core](https://learn.microsoft.com/aspnet/core/) is a production-ready framework for building web applications. This example integrates **Zitadel** with the built-in **OpenID Connect handler** using the **Authorization Code Flow + PKCE** to authenticate users securely and manage sessions.
#### Auth library
This example uses **[Microsoft.AspNetCore.Authentication.OpenIdConnect](https://learn.microsoft.com/aspnet/core/security/authentication/openid-connect)**. The middleware handles the PKCE dance, exchanges authorization codes for tokens, keeps tokens available on the request, and plugs into the standard ASP.NET Core authentication/authorization pipeline.
---
## What this example demonstrates
- Public landing page with “Sign in with Zitadel”.
- PKCE login handled by the ASP.NET Core OIDC middleware.
- Route protection via the auth/authorization middleware; profile page renders OIDC claims.
- Cookie-based session management with configurable idle timeout.
- Federated logout that clears the local session and redirects through Zitadel’s RP-initiated logout.
---
## Getting started
### Prerequisites
- .NET SDK 8 or later
### Account setup
Create a Web application in Zitadel configured for Authorization Code + PKCE, then set:
> **Redirect URIs:** `http://localhost:3000/auth/callback`
> **Post Logout Redirect URIs:** `http://localhost:3000/auth/logout/callback`
These values must match the sample configuration.
### Run the example
1. Clone the repository:
```bash
git clone https://github.com/zitadel/example-auth-dotnet.git
cd example-auth-dotnet
```
2. Copy `.env.example` to `.env` and fill in your values:
```dotenv
PORT=3000
SESSION_DURATION=3600
ZITADEL_DOMAIN="https://your-zitadel-domain"
ZITADEL_CLIENT_ID="your-zitadel-application-client-id"
ZITADEL_CLIENT_SECRET="your-randomly-generated-client-secret"
ZITADEL_POST_LOGOUT_URL="http://localhost:3000/auth/logout/callback"
```
3. Start the dev server (restores dependencies automatically):
```bash
make start
```
The app will be available at `http://localhost:3000`.
---
## Learn more and resources
* [PKCE concept](https://oauth.net/2/pkce/)
* [ASP.NET Core OIDC handler](https://learn.microsoft.com/aspnet/core/security/authentication/openid-connect)
* [Zitadel OIDC guide](https://zitadel.com/docs/guides/integrate/login/oidc/login-users)
* [Federated logout](https://zitadel.com/docs/guides/integrate/login/oidc/logout)
* [Example repository](https://github.com/zitadel/example-auth-dotnet)