mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-11 16:45:13 +00:00
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]>
This commit is contained in:
Florian Forster
co-authored by
Federico Coppede
Federico Coppede
parent
7b6395c348
commit
d8ea041c56
@@ -112,7 +112,7 @@ service AppService {
|
||||
|
||||
// Create Application
|
||||
//
|
||||
// Deprecated: use [application service v2 CreateApplication](apis/resources/application_service_v2/application-service-create-application.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 CreateApplication](/docs/reference/api/application/zitadel.application.v2.ApplicationService.CreateApplication) instead.
|
||||
//
|
||||
// Create an application. The application can be OIDC, API or SAML type, based on the input.
|
||||
//
|
||||
@@ -143,7 +143,7 @@ service AppService {
|
||||
|
||||
// Update Application
|
||||
//
|
||||
// Deprecated: use [application service v2 UpdateApplication](apis/resources/application_service_v2/zitadel-app-v-2-application-service-update-application.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 UpdateApplication](/docs/reference/api/application/zitadel.application.v2.ApplicationService.UpdateApplication) instead.
|
||||
//
|
||||
// Changes the configuration of an OIDC, API or SAML type application, as well as
|
||||
// the application name, based on the input provided.
|
||||
@@ -175,7 +175,7 @@ service AppService {
|
||||
|
||||
// Get Application
|
||||
//
|
||||
// Deprecated: use [application service v2 GetApplication](apis/resources/application_service_v2/application-service-get-application.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 GetApplication](/docs/reference/api/application/zitadel.application.v2.ApplicationService.GetApplication) instead.
|
||||
//
|
||||
// Retrieves the application matching the provided ID.
|
||||
//
|
||||
@@ -205,7 +205,7 @@ service AppService {
|
||||
|
||||
// Delete Application
|
||||
//
|
||||
// Deprecated: use [application service v2 DeleteApplication](apis/resources/application_service_v2/application-service-delete-application.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 DeleteApplication](/docs/reference/api/application/zitadel.application.v2.ApplicationService.DeleteApplication) instead.
|
||||
//
|
||||
// Deletes the application belonging to the input project and matching the provided
|
||||
// application ID.
|
||||
@@ -236,7 +236,7 @@ service AppService {
|
||||
|
||||
// Deactivate Application
|
||||
//
|
||||
// Deprecated: use [application service v2 DeactivateApplication](apis/resources/application_service_v2/application-service-deactivate-application.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 DeactivateApplication](/docs/reference/api/application/zitadel.application.v2.ApplicationService.DeactivateApplication) instead.
|
||||
//
|
||||
// Deactivates the application belonging to the input project and matching the provided
|
||||
// application ID.
|
||||
@@ -268,7 +268,7 @@ service AppService {
|
||||
|
||||
// Reactivate Application
|
||||
//
|
||||
// Deprecated: use [application service v2 ReactivateApplication](apis/resources/application_service_v2/application-service-reactivate-application.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 ReactivateApplication](/docs/reference/api/application/zitadel.application.v2.ApplicationService.ReactivateApplication) instead.
|
||||
//
|
||||
// Reactivates the application belonging to the input project and matching the provided
|
||||
// application ID.
|
||||
@@ -301,7 +301,7 @@ service AppService {
|
||||
|
||||
// Regenerate Client Secret
|
||||
//
|
||||
// Deprecated: use [application service v2 GenerateClientSecret](apis/resources/application_service_v2/application-service-generate-client-secret.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 GenerateClientSecret](/docs/reference/api/application/zitadel.application.v2.ApplicationService.GenerateClientSecret) instead.
|
||||
//
|
||||
// Regenerates the client secret of an API or OIDC application that belongs to the input project.
|
||||
//
|
||||
@@ -332,7 +332,7 @@ service AppService {
|
||||
|
||||
// List Applications
|
||||
//
|
||||
// Deprecated: use [application service v2 ListApplications](apis/resources/application_service_v2/application-service-list-applications.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 ListApplications](/docs/reference/api/application/zitadel.application.v2.ApplicationService.ListApplications) instead.
|
||||
//
|
||||
// Returns a list of applications matching the input parameters that belong to the provided
|
||||
// project.
|
||||
@@ -368,7 +368,7 @@ service AppService {
|
||||
|
||||
// Create Application Key
|
||||
//
|
||||
// Deprecated: use [application service v2 CreateApplicationKey](apis/resources/application_service_v2/application-service-create-application-key.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 CreateApplicationKey](/docs/reference/api/application/zitadel.application.v2.ApplicationService.CreateApplicationKey) instead.
|
||||
//
|
||||
// Create a new application key, which is used to authorize an API application.
|
||||
//
|
||||
@@ -402,7 +402,7 @@ service AppService {
|
||||
|
||||
// Delete Application Key
|
||||
//
|
||||
// Deprecated: use [application service v2 DeleteApplicationKey](apis/resources/application_service_v2/application-service-delete-application-key.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 DeleteApplicationKey](/docs/reference/api/application/zitadel.application.v2.ApplicationService.DeleteApplicationKey) instead.
|
||||
//
|
||||
// Deletes an application key matching the provided ID.
|
||||
//
|
||||
@@ -436,7 +436,7 @@ service AppService {
|
||||
|
||||
// Get Application Key
|
||||
//
|
||||
// Deprecated: use [application service v2 GetApplicationKey](apis/resources/application_service_v2/application-service-get-application-key.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 GetApplicationKey](/docs/reference/api/application/zitadel.application.v2.ApplicationService.GetApplicationKey) instead.
|
||||
//
|
||||
// Retrieves the application key matching the provided ID.
|
||||
//
|
||||
@@ -468,7 +468,7 @@ service AppService {
|
||||
|
||||
// List Application Keys
|
||||
//
|
||||
// Deprecated: use [application service v2 ListApplicationKeys](apis/resources/application_service_v2/application-service-list-application-keys.api.mdx) instead.
|
||||
// Deprecated: use [application service v2 ListApplicationKeys](/docs/reference/api/application/zitadel.application.v2.ApplicationService.ListApplicationKeys) instead.
|
||||
//
|
||||
// Returns a list of application keys matching the input parameters.
|
||||
//
|
||||
|
||||
@@ -861,7 +861,7 @@ service AuthService {
|
||||
|
||||
// List My Authorizations / User Grants
|
||||
//
|
||||
// Deprecated: [List authorizations](apis/resources/authorization_service_v2/zitadel-authorization-v-2-authorization-service-list-authorizations.api.mdx) and pass the user ID filter with your users ID to search for your authorizations on granted and owned projects.
|
||||
// Deprecated: [List authorizations](/docs/reference/api/authorization/zitadel.authorization.v2.AuthorizationService.ListAuthorizations) and pass the user ID filter with your users ID to search for your authorizations on granted and owned projects.
|
||||
//
|
||||
// Returns a list of the authorizations/user grants the authenticated user has. User grants consist of an organization, a project and 1-n roles.
|
||||
rpc ListMyUserGrants(ListMyUserGrantsRequest) returns (ListMyUserGrantsResponse) {
|
||||
@@ -914,7 +914,7 @@ service AuthService {
|
||||
|
||||
// List My Project Roles
|
||||
//
|
||||
// Deprecated: [List authorizations](apis/resources/authorization_service_v2/zitadel-authorization-v-2-authorization-service-list-authorizations.api.mdx) and pass the user ID filter with your users ID and the project ID filter to search for your authorizations on a granted and an owned project.
|
||||
// Deprecated: [List authorizations](/docs/reference/api/authorization/zitadel.authorization.v2.AuthorizationService.ListAuthorizations) and pass the user ID filter with your users ID and the project ID filter to search for your authorizations on a granted and an owned project.
|
||||
//
|
||||
// Returns a list of roles for the authenticated user and for the requesting project.
|
||||
rpc ListMyProjectPermissions(ListMyProjectPermissionsRequest) returns (ListMyProjectPermissionsResponse) {
|
||||
|
||||
@@ -119,7 +119,7 @@ service OrganizationService {
|
||||
// Required permission:
|
||||
// - `org.create`
|
||||
//
|
||||
// Deprecated: Use [AddOrganization](/apis/resources/org_service_v2/organization-service-add-organization.api.mdx) instead to create an organization.
|
||||
// Deprecated: Use [AddOrganization](/docs/reference/api/org/zitadel.org.v2.OrganizationService.AddOrganization) instead to create an organization.
|
||||
rpc CreateOrganization(CreateOrganizationRequest) returns (CreateOrganizationResponse) {
|
||||
option (google.api.http) = {
|
||||
post: "/v2beta/organizations"
|
||||
@@ -201,7 +201,7 @@ service OrganizationService {
|
||||
// Required permission:
|
||||
// - `org.read`
|
||||
//
|
||||
// Deprecated: Use [ListOrganizations](/apis/resources/org_service_v2/organization-service-list-organizations.api.mdx) instead to list organizations.
|
||||
// Deprecated: Use [ListOrganizations](/docs/reference/api/org/zitadel.org.v2.OrganizationService.ListOrganizations) instead to list organizations.
|
||||
rpc ListOrganizations(ListOrganizationsRequest) returns (ListOrganizationsResponse) {
|
||||
option (google.api.http) = {
|
||||
post: "/v2beta/organizations/search";
|
||||
|
||||
@@ -352,18 +352,18 @@ message PrivacyPolicy {
|
||||
zitadel.v1.ObjectDetails details = 1;
|
||||
string tos_link = 2 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "\"https://zitadel.com/docs/legal/terms-of-service\"";
|
||||
example: "\"https://zitadel.com/docs/manage/legal/terms-of-service\"";
|
||||
}
|
||||
];
|
||||
string privacy_link = 3 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "\"https://zitadel.com/docs/legal/privacy-policy\"";
|
||||
example: "\"https://zitadel.com/docs/manage/legal/policies/privacy-policy\"";
|
||||
}
|
||||
];
|
||||
bool is_default = 4;
|
||||
string help_link = 5 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "\"https://zitadel.com/docs/manuals/introduction\"";
|
||||
example: "\"https://zitadel.com/docs/manage/console-overview\"";
|
||||
}
|
||||
];
|
||||
string support_email = 6 [
|
||||
|
||||
@@ -277,7 +277,7 @@ message SetPassword {
|
||||
}
|
||||
];
|
||||
// Encoded hash of a password in Modular Crypt Format:
|
||||
// https://zitadel.com/docs/concepts/architecture/secrets#hashed-secrets.
|
||||
// https://zitadel.com/docs/learn/architecture/secrets#hashed-secrets.
|
||||
string hash = 2 [
|
||||
(validate.rules).string = {min_len: 1, max_len: 200},
|
||||
(google.api.field_behavior) = REQUIRED,
|
||||
|
||||
@@ -12,21 +12,21 @@ message LegalAndSupportSettings {
|
||||
// Link to the Terms of Service. Can be a relative or absolute URL.
|
||||
string tos_link = 1 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "\"https://zitadel.com/docs/legal/terms-of-service\"";
|
||||
example: "\"https://zitadel.com/docs/manage/legal/terms-of-service\"";
|
||||
}
|
||||
];
|
||||
|
||||
// Link to the Privacy Policy. Can be a relative or absolute URL.
|
||||
string privacy_policy_link = 2 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "\"https://zitadel.com/docs/legal/privacy-policy\"";
|
||||
example: "\"https://zitadel.com/docs/manage/legal/policies/privacy-policy\"";
|
||||
}
|
||||
];
|
||||
|
||||
// Link to a help page. Can be a relative or absolute URL.
|
||||
string help_link = 3 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "\"https://zitadel.com/docs/manuals/introduction\"";
|
||||
example: "\"https://zitadel.com/docs/manage/console-overview\"";
|
||||
}
|
||||
];
|
||||
|
||||
|
||||
@@ -11,17 +11,17 @@ import "validate/validate.proto";
|
||||
message LegalAndSupportSettings {
|
||||
string tos_link = 1 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "\"https://zitadel.com/docs/legal/terms-of-service\"";
|
||||
example: "\"https://zitadel.com/docs/manage/legal/terms-of-service\"";
|
||||
}
|
||||
];
|
||||
string privacy_policy_link = 2 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "\"https://zitadel.com/docs/legal/privacy-policy\"";
|
||||
example: "\"https://zitadel.com/docs/manage/legal/policies/privacy-policy\"";
|
||||
}
|
||||
];
|
||||
string help_link = 3 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "\"https://zitadel.com/docs/manuals/introduction\"";
|
||||
example: "\"https://zitadel.com/docs/manage/console-overview\"";
|
||||
}
|
||||
];
|
||||
string support_email = 4 [
|
||||
|
||||
@@ -27,7 +27,7 @@ message HashedPassword {
|
||||
(google.api.field_behavior) = REQUIRED,
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "\"$2a$12$lJ08fqVr8bFJilRVnDT9QeULI7YW.nT3iwUv6dyg0aCrfm3UY8XR2\"";
|
||||
description: "\"Encoded hash of a password in Modular Crypt Format: https://zitadel.com/docs/concepts/architecture/secrets#hashed-secrets\"";
|
||||
description: "\"Encoded hash of a password in Modular Crypt Format: https://zitadel.com/docs/learn/architecture/secrets#hashed-secrets\"";
|
||||
min_length: 1,
|
||||
max_length: 200;
|
||||
}
|
||||
|
||||
@@ -170,7 +170,7 @@ service UserService {
|
||||
|
||||
// Create a new human user
|
||||
//
|
||||
// Deprecated: Use [CreateUser](apis/resources/user_service_v2/user-service-create-user.api.mdx) to create a new user of type human instead.
|
||||
// Deprecated: Use [CreateUser](/docs/reference/api/user/zitadel.user.v2.UserService.CreateUser) to create a new user of type human instead.
|
||||
//
|
||||
// Create/import a new user with the type human. The newly created user will get a verification email if either the email address is not marked as verified and you did not request the verification to be returned.
|
||||
rpc AddHumanUser (AddHumanUserRequest) returns (AddHumanUserResponse) {
|
||||
@@ -271,7 +271,7 @@ service UserService {
|
||||
|
||||
// Change the user email
|
||||
//
|
||||
// Deprecated: [Update the users email field](apis/resources/user_service_v2/user-service-update-user.api.mdx).
|
||||
// Deprecated: [Update the users email field](/docs/reference/api/user/zitadel.user.v2.UserService.UpdateUser).
|
||||
//
|
||||
// Change the email address of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by email..
|
||||
rpc SetEmail (SetEmailRequest) returns (SetEmailResponse) {
|
||||
@@ -394,7 +394,7 @@ service UserService {
|
||||
|
||||
// Set the user phone
|
||||
//
|
||||
// Deprecated: [Update the users phone field](apis/resources/user_service_v2/user-service-update-user.api.mdx).
|
||||
// Deprecated: [Update the users phone field](/docs/reference/api/user/zitadel.user.v2.UserService.UpdateUser).
|
||||
//
|
||||
// Set the phone number of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by sms..
|
||||
rpc SetPhone(SetPhoneRequest) returns (SetPhoneResponse) {
|
||||
@@ -428,7 +428,7 @@ service UserService {
|
||||
|
||||
// Delete the user phone
|
||||
//
|
||||
// Deprecated: [Update the users phone field](apis/resources/user_service_v2/user-service-update-user.api.mdx) to remove the phone number.
|
||||
// Deprecated: [Update the users phone field](/docs/reference/api/user/zitadel.user.v2.UserService.UpdateUser) to remove the phone number.
|
||||
//
|
||||
// Delete the phone number of a user.
|
||||
rpc RemovePhone(RemovePhoneRequest) returns (RemovePhoneResponse) {
|
||||
@@ -576,7 +576,7 @@ service UserService {
|
||||
|
||||
// Update Human User
|
||||
//
|
||||
// Deprecated: Use [UpdateUser](apis/resources/user_service_v2/user-service-update-user.api.mdx) to update a user of type human instead.
|
||||
// Deprecated: Use [UpdateUser](/docs/reference/api/user/zitadel.user.v2.UserService.UpdateUser) to update a user of type human instead.
|
||||
//
|
||||
// Update all information from a user.
|
||||
rpc UpdateHumanUser(UpdateHumanUserRequest) returns (UpdateHumanUserResponse) {
|
||||
@@ -1427,7 +1427,7 @@ service UserService {
|
||||
|
||||
// Change password
|
||||
//
|
||||
// Deprecated: [Update the users password](apis/resources/user_service_v2/user-service-update-user.api.mdx) instead.
|
||||
// Deprecated: [Update the users password](/docs/reference/api/user/zitadel.user.v2.UserService.UpdateUser) instead.
|
||||
//
|
||||
// Change the password of a user with either a verification code or the current password..
|
||||
rpc SetPassword (SetPasswordRequest) returns (SetPasswordResponse) {
|
||||
@@ -1816,7 +1816,7 @@ service UserService {
|
||||
|
||||
// Resend an invite code for a user
|
||||
//
|
||||
// Deprecated: Use [CreateInviteCode](apis/resources/user_service_v2/user-service-create-invite-code.api.mdx) instead.
|
||||
// Deprecated: Use [CreateInviteCode](/docs/reference/api/user/zitadel.user.v2.UserService.CreateInviteCode) instead.
|
||||
//
|
||||
// Resend an invite code for a user to initialize their first authentication method (password, passkeys, IdP) depending on the organization's available methods.
|
||||
// A resend is only possible if a code has been created previously and sent to the user. If there is no code or it was directly returned, an error will be returned.
|
||||
@@ -1912,7 +1912,7 @@ service UserService {
|
||||
}
|
||||
// Set User Metadata
|
||||
//
|
||||
// Sets a list of key value pairs. Existing metadata entries with matching keys are overwritten. Existing metadata entries without matching keys are untouched. To remove metadata entries, use [DeleteUserMetadata](apis/resources/user_service_v2/user-service-delete-user-metadata.api.mdx). For HTTP requests, make sure the bytes array value is base64 encoded.
|
||||
// Sets a list of key value pairs. Existing metadata entries with matching keys are overwritten. Existing metadata entries without matching keys are untouched. To remove metadata entries, use [DeleteUserMetadata](/docs/reference/api/user/zitadel.user.v2.UserService.DeleteUserMetadata). For HTTP requests, make sure the bytes array value is base64 encoded.
|
||||
//
|
||||
// Required permission:
|
||||
// - `user.write`
|
||||
@@ -2072,8 +2072,8 @@ message CreateUserRequest{
|
||||
// For example, if a user already has an account in an external identity provider or another Zitadel instance, an IDP link allows the user to authenticate as usual.
|
||||
// Sessions, second factors, hardware keys registered externally are still available for authentication.
|
||||
// Use the following endpoints to manage identity provider links:
|
||||
// - [AddIDPLink](apis/resources/user_service_v2/user-service-add-idp-link.api.mdx)
|
||||
// - [RemoveIDPLink](apis/resources/user_service_v2/user-service-remove-idp-link.api.mdx)
|
||||
// - [AddIDPLink](/docs/reference/api/user/zitadel.user.v2.UserService.AddIDPLink)
|
||||
// - [RemoveIDPLink](/docs/reference/api/user/zitadel.user.v2.UserService.RemoveIDPLink)
|
||||
repeated IDPLink idp_links = 7;
|
||||
// An Implementation of RFC 6238 is used, with HMAC-SHA-1 and time-step of 30 seconds.
|
||||
// Currently no other options are supported, and if anything different is used the validation will fail.
|
||||
@@ -2159,9 +2159,9 @@ message CreateUserRequest{
|
||||
// Read more about your options for controlling this behaviour in the email and phone field documentations.
|
||||
Human human = 4;
|
||||
// Users of type machine are users that are meant to be used by a machine.
|
||||
// In order to authenticate, [add a secret](apis/resources/user_service_v2/user-service-add-secret.api.mdx), [a key](apis/resources/user_service_v2/user-service-add-key.api.mdx) or [a personal access token](apis/resources/user_service_v2/user-service-add-personal-access-token.api.mdx) to the user.
|
||||
// In order to authenticate, [add a secret](/docs/reference/api/user/zitadel.user.v2.UserService.AddSecret), [a key](/docs/reference/api/user/zitadel.user.v2.UserService.AddKey) or [a personal access token](/docs/reference/api/user/zitadel.user.v2.UserService.AddPersonalAccessToken) to the user.
|
||||
// Tokens generated for new users of type machine will be of an opaque Bearer type.
|
||||
// You can change the users token type to JWT by using the [management v1 service method UpdateMachine](apis/resources/mgmt/management-service-update-machine.api.mdx).
|
||||
// You can change the users token type to JWT by using the management v1 service method UpdateMachine.
|
||||
Machine machine = 5;
|
||||
}
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
|
||||
|
||||
@@ -27,7 +27,7 @@ message HashedPassword {
|
||||
(google.api.field_behavior) = REQUIRED,
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "\"$2a$12$lJ08fqVr8bFJilRVnDT9QeULI7YW.nT3iwUv6dyg0aCrfm3UY8XR2\"";
|
||||
description: "\"Encoded hash of a password in Modular Crypt Format: https://zitadel.com/docs/concepts/architecture/secrets#hashed-secrets\"";
|
||||
description: "\"Encoded hash of a password in Modular Crypt Format: https://zitadel.com/docs/learn/architecture/secrets#hashed-secrets\"";
|
||||
min_length: 1,
|
||||
max_length: 200;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user