docs: introduce versioned docs and migrate to fuma (#11166)

## 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]>
2026-10-18 05:52:51 +00:00 · 2026-01-29 08:38:36 -08:00
parent 7b6395c348
commit d8ea041c56
2826 changed files with 78739 additions and 23571 deletions
@@ -0,0 +1,137 @@
+---
+title: External Authentication Flow
+---
+
+This flow is executed if the user logs in using an [identity provider](/guides/integrate/identity-providers/introduction).
+
+The flow is represented by the following Ids in the API: `FLOW_TYPE_EXTERNAL_AUTHENTICATION` and `1`
+
+## Post Authentication
+
+A user has authenticated externally. ZITADEL retrieved and mapped the external information.
+
+The trigger is represented by the following Ids in the API: `TRIGGER_TYPE_POST_AUTHENTICATION` or `1`.
+
+### Parameters of Post Authentication Action
+
+- `ctx`
+The first parameter contains the following fields
+  - `accessToken` *string*
+    The access token returned by the identity provider. This can be an opaque token or a JWT
+  - `refreshToken` *string*
+    The refresh token returned by the identity provider if there is one. This is most likely to be an opaque token.
+  - `claimsJSON()` [*idTokenClaims*](../openidoauth/claims)
+    Returns all claims of the id token
+  - `getClaim(key)` *Any*
+    Returns the requested [id token claim](../openidoauth/claims)
+  - `idToken` *string*
+    The id token provided by the identity provider.
+  - `v1`
+    - `externalUser` [*externalUser*](./objects#external-user)
+    - `authError` *string*
+      This is a verification errors string representation. If the verification succeeds, this is "none"
+    - `authRequest` [*auth request*](/apis/actions/objects#auth-request)
+    - `httpRequest` [*http request*](/apis/actions/objects#http-request)
+    - `providerInfo` *Any*
+      Returns the response of the provider. In case the provider is a Generic OAuth Provider, the information is accessible through:
+      - `rawInfo`  *Any*
+    - `org`
+      - `getMetadata()` [*metadataResult*](./objects#metadata-result)
+- `api`
+  The second parameter contains the following fields
+  - `v1`
+    - `user`
+      - `appendMetadata(string, Any)`
+        The first parameter represents the key and the second a value which will be stored
+  - `setFirstName(string)`
+    Sets the first name
+  - `setLastName(string)`
+    Sets the last name
+  - `setNickName(string)`
+    Sets the nickname
+  - `setDisplayName(string)`
+    Sets the display name
+  - `setPreferredLanguage(string)`
+    Sets the preferred language. Please use the format defined in [RFC 5646](https://www.rfc-editor.org/rfc/rfc5646)
+  - `setPreferredUsername(string)`
+    Sets the preferred username
+  - `setEmail(string)`
+    Sets the email address of the user
+  - `setEmailVerified(boolean)`
+    Sets the email address verified or unverified
+  - `setPhone(string)`
+    Sets the phone number of the user
+  - `setPhoneVerified(boolean)`
+    Sets the phone number verified or unverified
+  - `metadata`
+    Array of [*metadata*](./objects#metadata-with-value-as-bytes). This function is deprecated, please use `api.v1.user.appendMetadata`
+
+## Pre Creation
+
+A user selected **Register** on the overview page after external authentication. ZITADEL did not create the user yet.
+
+The trigger is represented by the following Ids in the API: `TRIGGER_TYPE_PRE_CREATION` or `2`.
+
+### Parameters of Pre Creation
+
+- `ctx`
+  The first parameter contains the following fields
+  - `v1`
+    - `user` [*human*](./objects#human-user)
+    - `authRequest` [*auth request*](/apis/actions/objects#auth-request)
+    - `httpRequest` [*http request*](/apis/actions/objects#http-request)
+    - `org`
+      - `getMetadata()` [*metadataResult*](./objects#metadata-result)
+- `api`
+  The second parameter contains the following fields
+  - `metadata`
+    Array of [*metadata*](./objects#metadata-with-value-as-bytes). This function is deprecated, please use `api.v1.user.appendMetadata`
+  - `setFirstName(string)`
+    Sets the first name
+  - `setLastName(string)`
+    Sets the last name
+  - `setNickName(string)`
+    Sets the nick name
+  - `setDisplayName(string)`
+    Sets the display name
+  - `setPreferredLanguage(string)`
+    Sets the preferred language, the string has to be a valid language tag as defined in [RFC 5646](https://www.rfc-editor.org/rfc/rfc5646)
+  - `setGender(int)`
+    Sets the gender.
+    <ul><li>0: unspecified</li><li>1: female</li><li>2: male</li><li>3: diverse</li></ul>
+  - `setUsername(string)`
+    Sets the username
+  - `setEmail(string)`
+    Sets the email
+  - `setEmailVerified(bool)`
+    If true the email set is verified without user interaction
+  - `setPhone(string)`
+    Sets the phone number
+  - `setPhoneVerified(bool)`
+    If true the phone number set is verified without user interaction
+  - `v1`
+    - `user`
+      - `appendMetadata(string, Any)`
+        The first parameter represents the key and the second a value which will be stored
+
+## Post Creation
+
+A user selected **Register** on the overview page after external authentication and ZITADEL successfully created the user.
+
+The trigger is represented by the following Ids in the API: `TRIGGER_TYPE_POST_CREATION` or `3`.
+
+### Parameters of Post Creation
+
+- `ctx`
+  The first parameter contains the following fields
+  - `v1`
+    - `getUser()` [*user*](./objects#user)
+    - `authRequest` [*auth request*](/apis/actions/objects#auth-request)
+    - `httpRequest` [*http request*](/apis/actions/objects#http-request)
+    - `org`
+      - `getMetadata()` [*metadataResult*](./objects#metadata-result)
+- `api`
+  The second parameter contains the following fields
+  - `userGrants` Array of [*userGrant*](./objects#user-grant)'s
+  - `v1`
+    - `appendUserGrant(`[`userGrant`](./objects#user-grant)`)`