mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-04 05:12:16 +00:00
## Todos for release - [x] Configure Env in docs project on vercel - [x] Configure Root Path in the docs project on vercel - [ ] Remove old CSP https://github.com/zitadel/website/pull/1592 ## What we did This pull request migrates the project documentation from the old `docs/` directory to the new `apps/docs/` directory, introduces a new documentation system built with Next.js and Fumadocs, and updates all relevant references, configuration files, and documentation to reflect this change. It also adds new configuration and ignore files for the new documentation app, updates CI and linting to exclude the new docs from certain checks, and revises the contributing guidelines accordingly. **Documentation System Migration and New Docs App** * Migrated all documentation from `docs/` to `apps/docs/`, and updated all references in `README.md`, `CONTRIBUTING.md`, and other files to point to the new location. [[1]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L585-L640) [[2]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L660-R607) [[3]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L740-R687) [[4]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L2-R3) [[5]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L30-R30) * Added a new Next.js/Fumadocs-based documentation app under `apps/docs/`, including core app files, layouts, routing, search API, and a comprehensive `README.md` with development and contribution instructions. [[1]](diffhunk://#diff-5a1b07344a2c1b4d3f37b23ff1388b62cd9f57dea3c1cd23d8a0412b7602b132R1-R74) [[2]](diffhunk://#diff-462b9ad1eabbb7d1c29bb9c36e4931eb180fd7190900e6d2babf8f4d66ad1c28R1-R39) [[3]](diffhunk://#diff-e16ae25660ded787b10ac35dea96d5ecaacf895dae0afc8a9bd4382dc79a8c87R1-R7) [apps/docs/app/[[...slug]]/layout.tsxR1-R81](diffhunk://#diff-59e08acde4e805b7aeccef1dcf98f1d71dfc550777e6b9402085cee0e9fa4e0aR1-R81), [apps/docs/app/[[...slug]]/page.tsxR1-R79](diffhunk://#diff-e5df3f80d0fa01e12d63d81f29c57a9d14e846c78fd3beabb2ef768e38fd9580R1-R79), [[4]](diffhunk://#diff-389b34918e040cacaa87cd7201ffa462cc2b0b716736f537e3d3c660ac69353bR1-R7) [[5]](diffhunk://#diff-d3b03416d1c457b19f1c27b26f2db741412df841b875c26ccadc36e4522247f4R1-R29) [[6]](diffhunk://#diff-c8fb8339570a5305809be7c618e14705fd86390dc278e6ce8ba224a7bc8b0c3cR1-R25) **Configuration and Tooling Updates** * Updated `.github/workflows/codeql.yml`, `.golangci.yaml`, and `.github/dependabot.yml` to properly handle the new docs app: excluded `apps/docs` from certain checks, added npm dependency updates for the docs app, and excluded generated content. [[1]](diffhunk://#diff-12783128521e452af0cfac94b99b8d250413c516ec71fe6d97dbea666ff7ba27L8-R14) [[2]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R5-R6) [[3]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R126-R129) [[4]](diffhunk://#diff-dd4fbda47e51f1e35defb9275a9cd9c212ecde0b870cba89ddaaae65c5f3cd28R89-R106) * Updated `.devcontainer/devcontainer.json` to use the latest Go 1.25.3 version for consistency. **Licensing and Miscellaneous** * Added `apps/docs/` to the list of licensed directories in `LICENSING.md`. These changes ensure the documentation is now maintained in a modern, scalable system and all project tooling is updated to support the new structure. --------- Co-authored-by: Federico Coppede <[email protected]>
111 lines
4.3 KiB
Plaintext
111 lines
4.3 KiB
Plaintext
---
|
|
title: How to Handle Session Validation
|
|
sidebar_label: Session Validation
|
|
---
|
|
|
|
Sessions represent the state of a user session in ZITADEL. They can be aggregated and updated over time to reflect
|
|
the changes.
|
|
|
|
For example, a session could be started by checking a username and ZITADEL will return a new session
|
|
with some information about the user like their id and loginName as well as details about the session itself.
|
|
Later on, if the user's password was checked successfully, ZITADEL will update the session and provide the date and time
|
|
when the password was verified.
|
|
|
|
## Verification
|
|
|
|
Since sessions just represent the current state, it's the responsibility of the client to check whether that state is
|
|
sufficient. This also gives you some opportunities, e.g. if you have different requirements for different use cases.
|
|
|
|
Let's jump into the example from above and assume you have a simple login UI, which just requires the user to verify
|
|
their [username and password](./username-password#create-session-with-user-check).
|
|
|
|
If a user successfully authenticated using username and password, a session could look like:
|
|
|
|
```json
|
|
{
|
|
"session": {
|
|
"id": "218480890961985793",
|
|
"creationDate": "2023-06-14T05:32:38.977954Z",
|
|
"changeDate": "2023-06-14T05:42:11.631901Z",
|
|
"sequence": "582",
|
|
"factors": {
|
|
"user": {
|
|
"verifiedAt": "2023-06-14T05:32:38.972712Z",
|
|
"id": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
|
|
"loginName": "[email protected]",
|
|
"displayName": "Minnie Mouse"
|
|
},
|
|
"password": {
|
|
"verifiedAt": "2023-06-14T05:42:11.619484Z"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Your application would then need to check whether these `factors` are enough, esp. if the `verifiedAt` of both are within
|
|
an acceptable time range.
|
|
|
|
To get the current state of the session, you can call the [GetSession endpoint](/reference/api/session/zitadel.session.v2.SessionService.GetSession),
|
|
resp. you can get several by [searching sessions](/reference/api/session/zitadel.session.v2.SessionService.ListSessions).
|
|
|
|
## Expiration
|
|
|
|
The session API allows you to expire sessions. Like previous with the factor's `verfifiedAt`, you can check the
|
|
`expirationDate` and decide if you want to accept the session or not.
|
|
|
|
```json
|
|
{
|
|
"session": {
|
|
"id": "218480890961985793",
|
|
"creationDate": "2023-06-14T05:32:38.977954Z",
|
|
"changeDate": "2023-06-14T05:42:11.631901Z",
|
|
"sequence": "582",
|
|
"factors": {
|
|
"user": {
|
|
"verifiedAt": "2023-06-14T05:32:38.972712Z",
|
|
"id": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
|
|
"loginName": "[email protected]",
|
|
"displayName": "Minnie Mouse"
|
|
},
|
|
"password": {
|
|
"verifiedAt": "2023-06-14T05:42:11.619484Z"
|
|
}
|
|
},
|
|
"expirationDate": "2023-06-14T10:42:11.619484Z"
|
|
}
|
|
}
|
|
```
|
|
|
|
You may have some cases where you even want to make sure the session does not expire within few seconds or other cases,
|
|
where you might use some information of an expired session like the user's `loginName` to automatically create a new
|
|
session in your Login UI and let the user only provide their password.
|
|
|
|
<Callout>
|
|
Note that ZITADEL will reject any expired sessions automatically and that they cannot be updated anymore.
|
|
</Callout>
|
|
|
|
### Set a lifetime
|
|
|
|
In order to expire a session, a `lifetime` duration can be set when creating or updating a session.
|
|
Note that each time a session is updated with a `lifetime` attribute set, the `expirationDate` will newly be calculated
|
|
from this point in time. This give you the opportunity to change the expiration, based on the successful `factors` of
|
|
the session.
|
|
|
|
```json
|
|
{
|
|
"lifetime": "18000.000000000s"
|
|
}
|
|
```
|
|
|
|
<Callout>
|
|
Note that if the `lifetime` was not set, the session will never expire.
|
|
</Callout>
|
|
|
|
## Token Introspection
|
|
|
|
If you're relying on OAuth Token Introspection in your API, Session Tokens can't be used directly, since they
|
|
do not include all the necessary information for that. You'll need to exchange it first into an access token.
|
|
You can do so by guiding your user through the Login UI, where a session token will be required to finalize the
|
|
auth request. Check out the guide on [support for OIDC](./oidc-standard).
|