mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 13:52:51 +00:00
d8ea041c56
## 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]>
215 lines
6.1 KiB
Plaintext
215 lines
6.1 KiB
Plaintext
---
|
|
title: Objects
|
|
---
|
|
|
|
## External User
|
|
|
|
- `externalId` *string*
|
|
User id from the identity provider
|
|
- `externalIdpId` *string*
|
|
Id of the identity provider
|
|
- `human`
|
|
- `firstName` *string*
|
|
- `lastName` *string*
|
|
- `nickName` *string*
|
|
- `displayName` *string*
|
|
- `preferredLanguage` *string*
|
|
In [RFC 5646](https://www.rfc-editor.org/rfc/rfc5646) format
|
|
- `email` *string*
|
|
- `isEmailVerified` *boolean*
|
|
- `phone` *string*
|
|
- `isPhoneVerified` *boolean*
|
|
|
|
## metadata with value as bytes
|
|
|
|
- `key` *string*
|
|
- `value` Array of *byte*
|
|
|
|
## metadata result
|
|
|
|
- `count` *number*
|
|
- `sequence` *number*
|
|
- `timestamp` *Date*
|
|
- `metadata` Array of [*metadata*](#metadata)
|
|
|
|
## metadata
|
|
|
|
- `creationDate` *Date*
|
|
- `changeDate` *Date*
|
|
- `resourceOwner` *string*
|
|
- `sequence` *number*
|
|
- `key` *string*
|
|
- `value` `Any`
|
|
|
|
## user grant
|
|
|
|
- `projectID` *string*
|
|
Required. Id of the project to be granted
|
|
- `projectGrantID` *string*
|
|
Optional. If the grant is for a project grant, include projectGrantID
|
|
- `roles` Array of *string*
|
|
Containing the roles
|
|
|
|
## user
|
|
|
|
- `id` *string*
|
|
- `creationDate` *Date*
|
|
- `changeDate` *Date*
|
|
- `resourceOwner` *string*
|
|
- `sequence` *number*
|
|
Unsigned 64 bit integer
|
|
- `state` *number*
|
|
<ul><li>0: unspecified</li><li>1: active</li><li>2: inactive</li><li>3: deleted</li><li>4: locked</li><li>5: suspended</li><li>6: initial</li></ul>
|
|
- `username` *string*
|
|
- `loginNames` Array of *string*
|
|
- `preferredLoginName` *string*
|
|
- `human`
|
|
Set if the user is human
|
|
- `firstName` *string*
|
|
- `lastName` *string*
|
|
- `nickName` *string*
|
|
- `displayName` *string*
|
|
- `avatarKey` *string*
|
|
- `preferredLanguage` *string*
|
|
In [RFC 5646](https://www.rfc-editor.org/rfc/rfc5646) format
|
|
- `gender` *number*
|
|
<ul><li>0: unspecified</li><li>1: female</li><li>2: male</li><li>3: diverse</li></ul>
|
|
- `email` *string*
|
|
- `isEmailVerified` *boolean*
|
|
- `phone` *string*
|
|
- `isPhoneVerified` *boolean*
|
|
- `machine`
|
|
Set if the user is a machine
|
|
- `name` *string*
|
|
- `description` *string*
|
|
|
|
## human user
|
|
|
|
- `id` *string*
|
|
- `creationDate` *Date*
|
|
- `changeDate` *Date*
|
|
- `resourceOwner` *string*
|
|
- `sequence` *number*
|
|
- `state` *number*
|
|
<ul><li>0: unspecified</li><li>1: active</li><li>2: inactive</li><li>3: deleted</li><li>4: locked</li><li>5: suspended</li><li>6: initial</li></ul>
|
|
- `username` *string*
|
|
- `loginNames` Array of *string*
|
|
- `preferredLoginName` *string*
|
|
- `profile`
|
|
- `firstName` *string*
|
|
- `lastName` *string*
|
|
- `nickName` *string*
|
|
- `displayName` *string*
|
|
- `preferredLanguage` *string*
|
|
In [RFC 5646](https://www.rfc-editor.org/rfc/rfc5646) format
|
|
- `email`
|
|
- `email` *string*
|
|
- `isEmailVerified` *boolean*
|
|
- `phone`
|
|
- `phone` *string*
|
|
- `isPhoneVerified` *boolean*
|
|
|
|
## Auth Request
|
|
|
|
This object contains context information about the request to the [authorization endpoint](/apis/openidoauth/endpoints#authorization-endpoint).
|
|
|
|
- `id` *string*
|
|
- `agentId` *string*
|
|
- `creationDate` *Date*
|
|
- `changeDate` *Date*
|
|
- `browserInfo` *browserInfo*
|
|
- `userAgent` *string*
|
|
- `acceptLanguage` *string*
|
|
- `remoteIp` *string*
|
|
- `applicationId` *string*
|
|
- `callbackUri` *string*
|
|
- `transferState` *string*
|
|
- `prompt` Array of *Number*
|
|
<ul><li>0: not specified</li><li>1: none</li><li>2: login</li><li>3: consent</li><li>4: select_account</li><li>5: create</li></ul>
|
|
- `uiLocales` Array of *string*
|
|
- `loginHint` *string*
|
|
- `maxAuthAge` *Number*
|
|
Duration in nanoseconds
|
|
- `instanceId` *string*
|
|
- `request`
|
|
- `oidc`
|
|
- `scopes` Array of *string*
|
|
- `userId` *string*
|
|
- `userName` *string*
|
|
- `loginName` *string*
|
|
- `displayName` *string*
|
|
- `resourceOwner` *string*
|
|
- `requestedOrgId` *string*
|
|
- `requestedOrgName` *string*
|
|
- `requestedPrimaryDomain` *string*
|
|
- `requestedOrgDomain` *bool*
|
|
- `applicationResourceOwner` *string*
|
|
- `privateLabelingSetting` *Number*
|
|
<ul><li>0: Unspecified</li><li>1: Enforce project's policy</li><li>2: Allow user's organization login policy</li></ul>
|
|
- `selectedIdpConfigId` *string*
|
|
- `linkingUsers` Array of [*ExternalUser*](#external-user)
|
|
- `passwordVerified` *bool*
|
|
- `mfasVerified` Array of *Number*
|
|
<ul><li>0: OTP</li><li>1: U2F</li><li>2: U2F User verification</li></ul>
|
|
- `audience` Array of *string*
|
|
- `authTime` *Date*
|
|
|
|
## HTTP Request
|
|
|
|
This object is based on the Golang struct [http.Request](https://pkg.go.dev/net/http#Request), some attributes are removed as not all provided information is usable in this context.
|
|
|
|
- `method` *string*
|
|
- `url` *string*
|
|
- `proto` *string*
|
|
- `contentLength` *number*
|
|
- `host` *string*
|
|
- `form` Map *string* of Array of *string*
|
|
- `postForm` Map *string* of Array of *string*
|
|
- `remoteAddr` *string*
|
|
- `headers` Map *string* of Array of *string*
|
|
|
|
## Claims
|
|
|
|
This object represents [the claims](../openidoauth/claims) which will be written into the oidc token.
|
|
|
|
- `sub` *string*
|
|
- `name` *string*
|
|
- `email` *string*
|
|
- `locale` *string*
|
|
- `given_name` *string*
|
|
- `family_name` *string*
|
|
- `preferred_username` *string*
|
|
- `email_verified` *bool*
|
|
- `updated_at` *Number*
|
|
|
|
Additionally there could additional fields depending on the configuration of your [project](../../guides/manage/console/projects-overview#role-settings) and your [application](../../guides/manage/console/applications-overview#token-settings)
|
|
|
|
## user grant list
|
|
|
|
This object represents a list of user grant stored in ZITADEL.
|
|
|
|
- `count` *Number*
|
|
- `sequence` *Number*
|
|
- `timestamp` *Date*
|
|
- `grants` Array of
|
|
- `id` *string*
|
|
- `projectGrantId` *string*
|
|
The id of the [project grant](/guides/solution-scenarios/saas#project-grant)
|
|
- `state` *Number*
|
|
<ul><li>0: unspecified</li><li>1: active</li><li>2: inactive</li><li>3: removed</li></ul>
|
|
- `creationDate` *Date*
|
|
- `changeDate` *Date*
|
|
- `sequence` *Number*
|
|
- `userId` *string*
|
|
- `roles` Array of *string*
|
|
- `userResourceOwner` *string*
|
|
The id of the organization of the user
|
|
- `userGrantResourceOwner` *string*
|
|
The id of the organization, where the user was granted
|
|
- `userGrantResourceOwnerName` *string*
|
|
The name of the organization, where the user was granted
|
|
- `projectId` *string*
|
|
- `projectName` *string*
|
|
- `getOrgMetadata()` [*metadataResult*](#metadata-result)
|
|
Get the metadata of the organization where the user was granted
|