From aa9518ac020c2ac3e560715bf70789c61bcc03c5 Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Thu, 23 Feb 2023 12:08:06 +0100 Subject: [PATCH] docs: improve api docs (#5158) * integrate docs into nav * generator for local use, production needs to be set by env * fix typo * local dev * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: add header params * rewrite docs links and improve ci * tweak build command * fix path * Update docs/docusaurus.config.js Co-authored-by: Max Peintner * fix docker * docs: add header params * docs: Add tags to management api. add some descriptions * docs: more descriptions * docs: more descriptions * docs: required fields * docs: example request * docs: example request * docs: example request * docs: example request * docs: example request * docs: user metadata requests * docs: user requests * docs: user requests * docs: user requests * docs: user requests * docs: change nav add first methods to authentication api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: api sidenav * chore: use buf without docker * fix deploy * fix ci * fix vercel * docs: admin * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: security * docs: security * docs: admin api * docs: change to env vars * docs: auth api * docs: remove assets, deprecated requests, menu * reworked page with PaloAltoNetworks/docusaurus-openapi-docs * works with the resolutions * fix broken build by adding assets again * add tags to menu * chore: improve build speed * no-minify * test ssr * ssr 20 * use lazy * increase mem * use default mem * change names * docs: remove assets, deprecated requests, menu * docs: management api * docs: management api * docs: management api * docs: sidebar * not the best word smithing but it is ;-) * more typos * merge main * fix some error * trial * update grpc gateway * trigger vercel build * docs: deprecated requests * docs: deprecated requests --------- Co-authored-by: Fabienne Co-authored-by: Max Peintner --- .dockerignore | 3 +- .gitignore | 8 +- build/grpc/Dockerfile | 2 +- docs/.gitignore | 1 + docs/Dockerfile | 13 + docs/README.md | 35 +- docs/babel.config.js | 1 + docs/buf.gen.yaml | 8 + docs/docker-compose.yml | 11 - docs/docs/apis/assets/assets.md | 2 +- docs/docs/apis/introduction.mdx | 62 +- docs/docs/apis/proto/action.md | 154 - docs/docs/apis/proto/admin.md | 5375 ---------- docs/docs/apis/proto/app.md | 201 - docs/docs/apis/proto/auth.md | 1691 --- docs/docs/apis/proto/auth_n_key.md | 41 - docs/docs/apis/proto/change.md | 44 - docs/docs/apis/proto/event.md | 79 - docs/docs/apis/proto/idp.md | 315 - docs/docs/apis/proto/instance.md | 172 - docs/docs/apis/proto/management.md | 9455 ----------------- docs/docs/apis/proto/member.md | 93 - docs/docs/apis/proto/message.md | 37 - docs/docs/apis/proto/metadata.md | 49 - docs/docs/apis/proto/object.md | 95 - docs/docs/apis/proto/options.md | 25 - docs/docs/apis/proto/org.md | 154 - docs/docs/apis/proto/policy.md | 208 - docs/docs/apis/proto/project.md | 247 - docs/docs/apis/proto/settings.md | 166 - docs/docs/apis/proto/system.md | 888 -- docs/docs/apis/proto/text.md | 637 -- docs/docs/apis/proto/user.md | 744 -- docs/docs/apis/proto/v1.md | 335 - docs/docs/apis/statuscodes.mdx | 2 +- docs/docs/concepts/structure/instance.mdx | 2 +- .../integrate/access-zitadel-system-api.md | 2 +- docs/docs/guides/integrate/event-api.md | 6 +- .../guides/manage/user/reg-create-user.md | 10 +- docs/docs/guides/solution-scenarios/b2c.mdx | 2 +- docs/docs/self-hosting/manage/quotas.md | 2 +- docs/docusaurus.config.js | 68 +- docs/nginx.conf | 56 + docs/package.json | 40 +- docs/sidebars.js | 122 +- docs/src/css/custom.css | 63 + docs/yarn.lock | 3819 +++++-- go.sum | 1 + proto/zitadel/action.proto | 2 +- proto/zitadel/admin.proto | 1965 +++- proto/zitadel/app.proto | 18 +- proto/zitadel/auth.proto | 623 +- proto/zitadel/change.proto | 14 +- proto/zitadel/event.proto | 51 +- proto/zitadel/idp.proto | 10 +- proto/zitadel/instance.proto | 2 +- proto/zitadel/management.proto | 2553 ++++- proto/zitadel/member.proto | 6 +- proto/zitadel/metadata.proto | 6 +- proto/zitadel/object.proto | 12 +- proto/zitadel/org.proto | 16 +- proto/zitadel/policy.proto | 149 +- proto/zitadel/project.proto | 4 +- proto/zitadel/settings.proto | 39 +- proto/zitadel/system.proto | 10 +- proto/zitadel/text.proto | 19 +- proto/zitadel/user.proto | 64 +- proto/zitadel/v1.proto | 4 +- 68 files changed, 7570 insertions(+), 23543 deletions(-) create mode 100644 docs/Dockerfile create mode 100644 docs/buf.gen.yaml delete mode 100644 docs/docker-compose.yml mode change 100755 => 100644 docs/docs/apis/assets/assets.md delete mode 100644 docs/docs/apis/proto/action.md delete mode 100644 docs/docs/apis/proto/admin.md delete mode 100644 docs/docs/apis/proto/app.md delete mode 100644 docs/docs/apis/proto/auth.md delete mode 100644 docs/docs/apis/proto/auth_n_key.md delete mode 100644 docs/docs/apis/proto/change.md delete mode 100644 docs/docs/apis/proto/event.md delete mode 100644 docs/docs/apis/proto/idp.md delete mode 100644 docs/docs/apis/proto/instance.md delete mode 100644 docs/docs/apis/proto/management.md delete mode 100644 docs/docs/apis/proto/member.md delete mode 100644 docs/docs/apis/proto/message.md delete mode 100644 docs/docs/apis/proto/metadata.md delete mode 100644 docs/docs/apis/proto/object.md delete mode 100644 docs/docs/apis/proto/options.md delete mode 100644 docs/docs/apis/proto/org.md delete mode 100644 docs/docs/apis/proto/policy.md delete mode 100644 docs/docs/apis/proto/project.md delete mode 100644 docs/docs/apis/proto/settings.md delete mode 100644 docs/docs/apis/proto/system.md delete mode 100644 docs/docs/apis/proto/text.md delete mode 100644 docs/docs/apis/proto/user.md delete mode 100644 docs/docs/apis/proto/v1.md create mode 100644 docs/nginx.conf diff --git a/.dockerignore b/.dockerignore index 3783768c7..5d4e0f6ce 100644 --- a/.dockerignore +++ b/.dockerignore @@ -5,8 +5,7 @@ .dockerignore **/Dockerfile /k8s/ -/docs/ -/console/node_modules/ +/node_modules/ /console/src/app/proto/generated/ /console/tmp/ .releaserc.js diff --git a/.gitignore b/.gitignore index 333eb0f8f..75d5b034f 100644 --- a/.gitignore +++ b/.gitignore @@ -44,11 +44,9 @@ cmd/zitadel/zitadel /zitadelctl /zitadel -# buildfolders and generated js +# buildfolders and generated files tmp/ console/src/app/proto/generated/ - -#generated filed **.pb.go **.proto.mock.go **.pb.*.go @@ -57,6 +55,10 @@ openapi/**/*.json /internal/api/assets/authz.go /internal/api/assets/router.go /internal/api/ui/console/static/* +docs/docs/apis/auth +docs/docs/apis/admin +docs/docs/apis/mgmt +docs/docs/apis/system # local build/local/*.env diff --git a/build/grpc/Dockerfile b/build/grpc/Dockerfile index 12716096b..aa1727ef8 100644 --- a/build/grpc/Dockerfile +++ b/build/grpc/Dockerfile @@ -19,7 +19,7 @@ FROM ${BUILDARCH}-base ARG PROTOC_VERSION=3.18.0 ARG PROTOC_ZIP=protoc-${PROTOC_VERSION}-linux-${PROTOC_ARCH}.zip ARG GRPC_WEB_VERSION=1.3.0 -ARG GATEWAY_VERSION=2.6.0 +ARG GATEWAY_VERSION=2.15.1 ARG VALIDATOR_VERSION=0.6.2 # no arm specific version available and x86 works fine at the moment: ARG GRPC_WEB=protoc-gen-grpc-web-${GRPC_WEB_VERSION}-linux-x86_64 diff --git a/docs/.gitignore b/docs/.gitignore index 924a46bb6..aa3225470 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -7,6 +7,7 @@ # Generated files .docusaurus .cache-loader +.artifacts # Misc .DS_Store diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 index 000000000..c7d70a964 --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,13 @@ +## Angular lint workspace and production build +FROM node:18 as builder +WORKDIR /docs +COPY docs/package.json docs/yarn.lock ./ +RUN yarn install --frozen-lockfile +COPY docs . +COPY proto /proto +RUN yarn build + +## Final image for serving +FROM nginx as final +COPY docs/nginx.conf /etc/nginx/nginx.conf +COPY --from=builder /docs/build /usr/share/nginx/html diff --git a/docs/README.md b/docs/README.md index d500f2c0c..b3a1dfdd2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,4 @@ -[![Netlify Status](https://api.netlify.com/api/v1/badges/b82a23f7-d8c7-4025-af18-a46586e89ed0/deploy-status)](https://app.netlify.com/sites/zitadel-docs/deploys) - -# Website +# ZITADEL-Docs This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. @@ -10,34 +8,25 @@ To add a new site to the already existing structure simply save the `md` file in ## Installation -```console +``` yarn install ``` ## Local Development -```console +``` yarn start ``` -As an alternative you can use this docker compose command: +## Container Image -```console -docker compose up +If you just want to start docusaurus locally without installing node you can fallback to our container image. +Execute the following commands from the repository root to build and start a local version of ZITADEL + +```shell +docker build -f docs/Dockerfile . -t zitadel-docs ``` -These commands start a local development server. -Most changes are reflected live without having to restart the server. - -## Build - -```console -yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -## Deployment - -Each PR will be automatically built with a preview link from cloudflare pages. -Visit the checks / comments on the PR for the link. +```shell +docker run -p 8080:8080 zitadel-docs +``` \ No newline at end of file diff --git a/docs/babel.config.js b/docs/babel.config.js index bfd75dbdf..3e44aa2ae 100644 --- a/docs/babel.config.js +++ b/docs/babel.config.js @@ -1,3 +1,4 @@ module.exports = { presets: [require.resolve("@docusaurus/core/lib/babel/preset")], + compact: true }; diff --git a/docs/buf.gen.yaml b/docs/buf.gen.yaml new file mode 100644 index 000000000..46d49e75c --- /dev/null +++ b/docs/buf.gen.yaml @@ -0,0 +1,8 @@ +# buf.gen.yaml +version: v1 +managed: + enabled: true +plugins: + - plugin: buf.build/grpc-ecosystem/openapiv2 + out: .artifacts/openapi + opt: allow_delete_body diff --git a/docs/docker-compose.yml b/docs/docker-compose.yml deleted file mode 100644 index 36beb1ebd..000000000 --- a/docs/docker-compose.yml +++ /dev/null @@ -1,11 +0,0 @@ -version: '3' - -services: - docusaurus: - image: node:lts-alpine3.15 - working_dir: /app - volumes: - - ./:/app - ports: - - 3000:3000 - command: sh -c "yarn install && yarn start --host 0.0.0.0" \ No newline at end of file diff --git a/docs/docs/apis/assets/assets.md b/docs/docs/apis/assets/assets.md old mode 100755 new mode 100644 index 28bec4fa1..4a9b5cfb9 --- a/docs/docs/apis/assets/assets.md +++ b/docs/docs/apis/assets/assets.md @@ -256,4 +256,4 @@ GET: /users/me/avatar - + \ No newline at end of file diff --git a/docs/docs/apis/introduction.mdx b/docs/docs/apis/introduction.mdx index c94709583..66c767b6f 100644 --- a/docs/docs/apis/introduction.mdx +++ b/docs/docs/apis/introduction.mdx @@ -15,7 +15,7 @@ The last API (assets) is only a REST API because ZITADEL uses multipart form dat ### Proto -All of our APIs are generated by proto definitions. You can find all the proto definitions in the [Proto API Definitions](proto/auth). +All of our APIs are generated by proto definitions. You can find all the proto definitions in the [Proto API Definitions](https://github.com/zitadel/zitadel/tree/main/proto/zitadel). > More about [Protocol Buffer](https://developers.google.com/protocol-buffers) @@ -39,21 +39,18 @@ The authentication API (aka Auth API) is used for all operations on the currentl ### GRPC Endpoint: -{your_domain}/zitadel.auth.v1.AuthService/ +$ZITADEL_DOMAIN/zitadel.auth.v1.AuthService/ Definition: -[Auth Proto](/apis/proto/auth) +[Auth Proto](https://github.com/zitadel/zitadel/blob/main/proto/zitadel/auth.proto) ### REST Endpoint: -{your_domain}/auth/v1/ +$ZITADEL_DOMAIN/auth/v1/ -Swagger Editor: -[editor.swagger.io](https://editor.swagger.io/?url=https://zitadel.cloud/openapi/v2/swagger/auth.swagger.json) - -Definition: -[Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/auth.swagger.json) +API Reference: +[OpenAPI Docs](/apis/auth) @@ -75,21 +72,18 @@ To identify the current organization you can send a header `x-zitadel-orgid` or ### GRPC Endpoint: -{your_domain}/zitadel.management.v1.ManagementService/ +$ZITADEL_DOMAIN/zitadel.management.v1.ManagementService/ Definition: -[Management Proto](/apis/proto/management) +[Management Proto](https://github.com/zitadel/zitadel/blob/main/proto/zitadel/management.proto) ### REST Endpoint: -{your_domain}/management/v1/ +$ZITADEL_DOMAIN/management/v1/ -Swagger Editor: -[editor.swagger.io](https://editor.swagger.io/?url=https://zitadel.cloud/openapi/v2/swagger/management.swagger.json) - -Definition: -[Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/management.swagger.json) +API Reference: +[OpenAPI Docs](/apis/mgmt) @@ -109,21 +103,18 @@ This API is intended to configure and manage one ZITADEL instance itself. ### GRPC Endpoint: -{your_domain}/zitadel.admin.v1.AdminService/ +$ZITADEL_DOMAIN/zitadel.admin.v1.AdminService/ Definition: -[Admin Proto](/apis/proto/admin) +[Admin Proto](https://github.com/zitadel/zitadel/blob/main/proto/zitadel/admin.proto) ### REST Endpoint: -{your_domain}/admin/v1/ +$ZITADEL_DOMAIN/admin/v1/ -Swagger Editor: -[editor.swagger.io](https://editor.swagger.io/?url=https://zitadel.cloud/openapi/v2/swagger/admin.swagger.json) - -Definition: -[Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/admin.swagger.json) +API Reference: +[OpenAPI Docs](/apis/admin) @@ -145,21 +136,18 @@ Checkout the guide how to [access the ZITADEL System API](/guides/integrate/acce ### GRPC Endpoint: -{your_domain}/zitadel.system.v1.SystemService/ +$ZITADEL_DOMAIN/zitadel.system.v1.SystemService/ Definition: -[System Proto](/apis/proto/system) +[System Proto](https://github.com/zitadel/zitadel/blob/main/proto/zitadel/system.proto) ### REST Endpoint: -{your_domain}/system/v1/ +$ZITADEL_DOMAIN/system/v1/ -Swagger Editor: -[editor.swagger.io](https://editor.swagger.io/?url=https://zitadel.cloud/openapi/v2/swagger/system.swagger.json) - -Definition: -[Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/system.swagger.json) +API Reference: +[OpenAPI Docs](/apis/system) @@ -179,7 +167,7 @@ The Assets API allows you to up- and download all kinds of assets. This can be f ### REST Endpoint: -{your_domain}/assets/v1/ +$ZITADEL_DOMAIN/assets/v1/ Definition: [Assets](./assets/assets.md) @@ -211,12 +199,12 @@ In the table below you can see the URI of those calls. | Service | URI | | :------ | :-------------------------------------------------- | -| REST | {your_domain}/auth/v1/users/me | -| GRPC | {your_domain}/zitadel.auth.v1.AuthService/GetMyUser | +| REST | $ZITADEL_DOMAIN/auth/v1/users/me | +| GRPC | $ZITADEL_DOMAIN/zitadel.auth.v1.AuthService/GetMyUser | ## Domains -ZITADEL hosts everything under a single domain: `{instance}.zitadel.cloud` or your custom domain `{your_domain}` +ZITADEL hosts everything under a single domain: `{instance}.zitadel.cloud` or your custom domain `$ZITADEL_DOMAIN` :::note Changes from ZITADEL V1: diff --git a/docs/docs/apis/proto/action.md b/docs/docs/apis/proto/action.md deleted file mode 100644 index 1b2385a5a..000000000 --- a/docs/docs/apis/proto/action.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: zitadel/action.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### Action - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| state | ActionState | - | | -| name | string | - | | -| script | string | - | | -| timeout | google.protobuf.Duration | - | | -| allowed_to_fail | bool | - | | - - - - -### ActionIDQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.max_len: 200
| - - - - -### ActionNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### ActionStateQuery -ActionStateQuery is always equals - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| state | ActionState | - | enum.defined_only: true
| - - - - -### Flow - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | FlowType | id of the flow type | | -| details | zitadel.v1.ObjectDetails | - | | -| state | FlowState | - | | -| trigger_actions | repeated TriggerAction | - | | - - - - -### FlowType - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | identifier of the type | | -| name | zitadel.v1.LocalizedMessage | key and name of the type | | - - - - -### TriggerAction - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| trigger_type | TriggerType | id of the trigger type | | -| actions | repeated Action | - | | - - - - -### TriggerType - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | identifier of the type | | -| name | zitadel.v1.LocalizedMessage | key and name of the type | | - - - - - - -## Enums - - -### ActionFieldName {#actionfieldname} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| ACTION_FIELD_NAME_UNSPECIFIED | 0 | - | -| ACTION_FIELD_NAME_NAME | 1 | - | -| ACTION_FIELD_NAME_ID | 2 | - | -| ACTION_FIELD_NAME_STATE | 3 | - | - - - - -### ActionState {#actionstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| ACTION_STATE_UNSPECIFIED | 0 | - | -| ACTION_STATE_INACTIVE | 1 | - | -| ACTION_STATE_ACTIVE | 2 | - | - - - - -### FlowState {#flowstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| FLOW_STATE_UNSPECIFIED | 0 | - | -| FLOW_STATE_INACTIVE | 1 | - | -| FLOW_STATE_ACTIVE | 2 | - | - - - - diff --git a/docs/docs/apis/proto/admin.md b/docs/docs/apis/proto/admin.md deleted file mode 100644 index 797bf1036..000000000 --- a/docs/docs/apis/proto/admin.md +++ /dev/null @@ -1,5375 +0,0 @@ ---- -title: zitadel/admin.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - -## AdminService {#zitadeladminv1adminservice} - - -### Healthz - -> **rpc** Healthz([HealthzRequest](#healthzrequest)) -[HealthzResponse](#healthzresponse) - -Indicates if ZITADEL is running. -It respondes as soon as ZITADEL started - - - - GET: /healthz - - -### GetSupportedLanguages - -> **rpc** GetSupportedLanguages([GetSupportedLanguagesRequest](#getsupportedlanguagesrequest)) -[GetSupportedLanguagesResponse](#getsupportedlanguagesresponse) - -Returns the default languages - - - - GET: /languages - - -### SetDefaultLanguage - -> **rpc** SetDefaultLanguage([SetDefaultLanguageRequest](#setdefaultlanguagerequest)) -[SetDefaultLanguageResponse](#setdefaultlanguageresponse) - -Set the default language - - - - PUT: /languages/default/{language} - - -### GetDefaultLanguage - -> **rpc** GetDefaultLanguage([GetDefaultLanguageRequest](#getdefaultlanguagerequest)) -[GetDefaultLanguageResponse](#getdefaultlanguageresponse) - -Set the default language - - - - GET: /languages/default - - -### GetMyInstance - -> **rpc** GetMyInstance([GetMyInstanceRequest](#getmyinstancerequest)) -[GetMyInstanceResponse](#getmyinstanceresponse) - -Returns the details of the instance - - - - GET: /instances/me - - -### ListInstanceDomains - -> **rpc** ListInstanceDomains([ListInstanceDomainsRequest](#listinstancedomainsrequest)) -[ListInstanceDomainsResponse](#listinstancedomainsresponse) - -Returns the domains of the instance - - - - POST: /domains/_search - - -### ListSecretGenerators - -> **rpc** ListSecretGenerators([ListSecretGeneratorsRequest](#listsecretgeneratorsrequest)) -[ListSecretGeneratorsResponse](#listsecretgeneratorsresponse) - -Set the default language - - - - POST: /secretgenerators/_search - - -### GetSecretGenerator - -> **rpc** GetSecretGenerator([GetSecretGeneratorRequest](#getsecretgeneratorrequest)) -[GetSecretGeneratorResponse](#getsecretgeneratorresponse) - -Get Secret Generator by type (e.g PasswordResetCode) - - - - GET: /secretgenerators/{generator_type} - - -### UpdateSecretGenerator - -> **rpc** UpdateSecretGenerator([UpdateSecretGeneratorRequest](#updatesecretgeneratorrequest)) -[UpdateSecretGeneratorResponse](#updatesecretgeneratorresponse) - -Update secret generator configuration - - - - PUT: /secretgenerators/{generator_type} - - -### GetSMTPConfig - -> **rpc** GetSMTPConfig([GetSMTPConfigRequest](#getsmtpconfigrequest)) -[GetSMTPConfigResponse](#getsmtpconfigresponse) - -Get system smtp configuration - - - - GET: /smtp - - -### AddSMTPConfig - -> **rpc** AddSMTPConfig([AddSMTPConfigRequest](#addsmtpconfigrequest)) -[AddSMTPConfigResponse](#addsmtpconfigresponse) - -Add system smtp configuration - - - - POST: /smtp - - -### UpdateSMTPConfig - -> **rpc** UpdateSMTPConfig([UpdateSMTPConfigRequest](#updatesmtpconfigrequest)) -[UpdateSMTPConfigResponse](#updatesmtpconfigresponse) - -Update system smtp configuration - - - - PUT: /smtp - - -### UpdateSMTPConfigPassword - -> **rpc** UpdateSMTPConfigPassword([UpdateSMTPConfigPasswordRequest](#updatesmtpconfigpasswordrequest)) -[UpdateSMTPConfigPasswordResponse](#updatesmtpconfigpasswordresponse) - -Update system smtp configuration password for host - - - - PUT: /smtp/password - - -### RemoveSMTPConfig - -> **rpc** RemoveSMTPConfig([RemoveSMTPConfigRequest](#removesmtpconfigrequest)) -[RemoveSMTPConfigResponse](#removesmtpconfigresponse) - -Remove system smtp configuration - - - - DELETE: /smtp - - -### ListSMSProviders - -> **rpc** ListSMSProviders([ListSMSProvidersRequest](#listsmsprovidersrequest)) -[ListSMSProvidersResponse](#listsmsprovidersresponse) - -list sms provider configurations - - - - POST: /sms/_search - - -### GetSMSProvider - -> **rpc** GetSMSProvider([GetSMSProviderRequest](#getsmsproviderrequest)) -[GetSMSProviderResponse](#getsmsproviderresponse) - -Get sms provider - - - - GET: /sms/{id} - - -### AddSMSProviderTwilio - -> **rpc** AddSMSProviderTwilio([AddSMSProviderTwilioRequest](#addsmsprovidertwiliorequest)) -[AddSMSProviderTwilioResponse](#addsmsprovidertwilioresponse) - -Add twilio sms provider - - - - POST: /sms/twilio - - -### UpdateSMSProviderTwilio - -> **rpc** UpdateSMSProviderTwilio([UpdateSMSProviderTwilioRequest](#updatesmsprovidertwiliorequest)) -[UpdateSMSProviderTwilioResponse](#updatesmsprovidertwilioresponse) - -Update twilio sms provider - - - - PUT: /sms/twilio/{id} - - -### UpdateSMSProviderTwilioToken - -> **rpc** UpdateSMSProviderTwilioToken([UpdateSMSProviderTwilioTokenRequest](#updatesmsprovidertwiliotokenrequest)) -[UpdateSMSProviderTwilioTokenResponse](#updatesmsprovidertwiliotokenresponse) - -Update twilio sms provider token - - - - PUT: /sms/twilio/{id}/token - - -### ActivateSMSProvider - -> **rpc** ActivateSMSProvider([ActivateSMSProviderRequest](#activatesmsproviderrequest)) -[ActivateSMSProviderResponse](#activatesmsproviderresponse) - -Activate sms provider - - - - POST: /sms/{id}/_activate - - -### DeactivateSMSProvider - -> **rpc** DeactivateSMSProvider([DeactivateSMSProviderRequest](#deactivatesmsproviderrequest)) -[DeactivateSMSProviderResponse](#deactivatesmsproviderresponse) - -Deactivate sms provider - - - - POST: /sms/{id}/_deactivate - - -### RemoveSMSProvider - -> **rpc** RemoveSMSProvider([RemoveSMSProviderRequest](#removesmsproviderrequest)) -[RemoveSMSProviderResponse](#removesmsproviderresponse) - -Remove sms provider token - - - - DELETE: /sms/{id} - - -### GetOIDCSettings - -> **rpc** GetOIDCSettings([GetOIDCSettingsRequest](#getoidcsettingsrequest)) -[GetOIDCSettingsResponse](#getoidcsettingsresponse) - -Get OIDC settings (e.g token lifetimes, etc.) - - - - GET: /settings/oidc - - -### AddOIDCSettings - -> **rpc** AddOIDCSettings([AddOIDCSettingsRequest](#addoidcsettingsrequest)) -[AddOIDCSettingsResponse](#addoidcsettingsresponse) - -Add oidc settings (e.g token lifetimes, etc) - - - - POST: /settings/oidc - - -### UpdateOIDCSettings - -> **rpc** UpdateOIDCSettings([UpdateOIDCSettingsRequest](#updateoidcsettingsrequest)) -[UpdateOIDCSettingsResponse](#updateoidcsettingsresponse) - -Update oidc settings (e.g token lifetimes, etc) - - - - PUT: /settings/oidc - - -### GetFileSystemNotificationProvider - -> **rpc** GetFileSystemNotificationProvider([GetFileSystemNotificationProviderRequest](#getfilesystemnotificationproviderrequest)) -[GetFileSystemNotificationProviderResponse](#getfilesystemnotificationproviderresponse) - -Get file system notification provider - - - - GET: /notification/provider/file - - -### GetLogNotificationProvider - -> **rpc** GetLogNotificationProvider([GetLogNotificationProviderRequest](#getlognotificationproviderrequest)) -[GetLogNotificationProviderResponse](#getlognotificationproviderresponse) - -Get log notification provider - - - - GET: /notification/provider/log - - -### GetSecurityPolicy - -> **rpc** GetSecurityPolicy([GetSecurityPolicyRequest](#getsecuritypolicyrequest)) -[GetSecurityPolicyResponse](#getsecuritypolicyresponse) - -Get the security policy - - - - GET: /policies/security - - -### SetSecurityPolicy - -> **rpc** SetSecurityPolicy([SetSecurityPolicyRequest](#setsecuritypolicyrequest)) -[SetSecurityPolicyResponse](#setsecuritypolicyresponse) - -set the security policy - - - - PUT: /policies/security - - -### GetOrgByID - -> **rpc** GetOrgByID([GetOrgByIDRequest](#getorgbyidrequest)) -[GetOrgByIDResponse](#getorgbyidresponse) - -Returns an organisation by id - - - - GET: /orgs/{id} - - -### IsOrgUnique - -> **rpc** IsOrgUnique([IsOrgUniqueRequest](#isorguniquerequest)) -[IsOrgUniqueResponse](#isorguniqueresponse) - -Checks whether an organisation exists by the given parameters - - - - GET: /orgs/_is_unique - - -### SetDefaultOrg - -> **rpc** SetDefaultOrg([SetDefaultOrgRequest](#setdefaultorgrequest)) -[SetDefaultOrgResponse](#setdefaultorgresponse) - -Set the default org - - - - PUT: /orgs/default/{org_id} - - -### GetDefaultOrg - -> **rpc** GetDefaultOrg([GetDefaultOrgRequest](#getdefaultorgrequest)) -[GetDefaultOrgResponse](#getdefaultorgresponse) - -Set the default org - - - - GET: /orgs/default - - -### ListOrgs - -> **rpc** ListOrgs([ListOrgsRequest](#listorgsrequest)) -[ListOrgsResponse](#listorgsresponse) - -Returns all organisations matching the request -all queries need to match (AND) - - - - POST: /orgs/_search - - -### SetUpOrg - -> **rpc** SetUpOrg([SetUpOrgRequest](#setuporgrequest)) -[SetUpOrgResponse](#setuporgresponse) - -Creates a new org and user -and adds the user to the orgs members as ORG_OWNER - - - - POST: /orgs/_setup - - -### RemoveOrg - -> **rpc** RemoveOrg([RemoveOrgRequest](#removeorgrequest)) -[RemoveOrgResponse](#removeorgresponse) - -Sets the state of the organisation and all its resource (Users, Projects, Grants to and from the org) to removed -Users of this organisation will not be able login - - - - DELETE: /orgs/{org_id} - - -### GetIDPByID - -> **rpc** GetIDPByID([GetIDPByIDRequest](#getidpbyidrequest)) -[GetIDPByIDResponse](#getidpbyidresponse) - -Returns a identity provider configuration of the IAM instance - - - - GET: /idps/{id} - - -### ListIDPs - -> **rpc** ListIDPs([ListIDPsRequest](#listidpsrequest)) -[ListIDPsResponse](#listidpsresponse) - -Returns all identity provider configurations of the IAM instance - - - - POST: /idps/_search - - -### AddOIDCIDP - -> **rpc** AddOIDCIDP([AddOIDCIDPRequest](#addoidcidprequest)) -[AddOIDCIDPResponse](#addoidcidpresponse) - -Adds a new oidc identity provider configuration the IAM instance - - - - POST: /idps/oidc - - -### AddJWTIDP - -> **rpc** AddJWTIDP([AddJWTIDPRequest](#addjwtidprequest)) -[AddJWTIDPResponse](#addjwtidpresponse) - -Adds a new jwt identity provider configuration the IAM instance - - - - POST: /idps/jwt - - -### UpdateIDP - -> **rpc** UpdateIDP([UpdateIDPRequest](#updateidprequest)) -[UpdateIDPResponse](#updateidpresponse) - -Updates the specified idp -all fields are updated. If no value is provided the field will be empty afterwards. - - - - PUT: /idps/{idp_id} - - -### DeactivateIDP - -> **rpc** DeactivateIDP([DeactivateIDPRequest](#deactivateidprequest)) -[DeactivateIDPResponse](#deactivateidpresponse) - -Sets the state of the idp to IDP_STATE_INACTIVE -the state MUST be IDP_STATE_ACTIVE for this call - - - - POST: /idps/{idp_id}/_deactivate - - -### ReactivateIDP - -> **rpc** ReactivateIDP([ReactivateIDPRequest](#reactivateidprequest)) -[ReactivateIDPResponse](#reactivateidpresponse) - -Sets the state of the idp to IDP_STATE_ACTIVE -the state MUST be IDP_STATE_INACTIVE for this call - - - - POST: /idps/{idp_id}/_reactivate - - -### RemoveIDP - -> **rpc** RemoveIDP([RemoveIDPRequest](#removeidprequest)) -[RemoveIDPResponse](#removeidpresponse) - -RemoveIDP deletes the IDP permanetly - - - - DELETE: /idps/{idp_id} - - -### UpdateIDPOIDCConfig - -> **rpc** UpdateIDPOIDCConfig([UpdateIDPOIDCConfigRequest](#updateidpoidcconfigrequest)) -[UpdateIDPOIDCConfigResponse](#updateidpoidcconfigresponse) - -Updates the oidc configuration of the specified idp -all fields are updated. If no value is provided the field will be empty afterwards. - - - - PUT: /idps/{idp_id}/oidc_config - - -### UpdateIDPJWTConfig - -> **rpc** UpdateIDPJWTConfig([UpdateIDPJWTConfigRequest](#updateidpjwtconfigrequest)) -[UpdateIDPJWTConfigResponse](#updateidpjwtconfigresponse) - -Updates the jwt configuration of the specified idp -all fields are updated. If no value is provided the field will be empty afterwards. - - - - PUT: /idps/{idp_id}/jwt_config - - -### ListProviders - -> **rpc** ListProviders([ListProvidersRequest](#listprovidersrequest)) -[ListProvidersResponse](#listprovidersresponse) - -Returns all identity providers, which match the query -Limit should always be set, there is a default limit set by the service - - - - POST: /idps/templates/_search - - -### GetProviderByID - -> **rpc** GetProviderByID([GetProviderByIDRequest](#getproviderbyidrequest)) -[GetProviderByIDResponse](#getproviderbyidresponse) - -Returns an identity provider of the instance - - - - GET: /idps/templates/{id} - - -### AddGoogleProvider - -> **rpc** AddGoogleProvider([AddGoogleProviderRequest](#addgoogleproviderrequest)) -[AddGoogleProviderResponse](#addgoogleproviderresponse) - -Add a new Google identity provider on the instance - - - - POST: /idps/google - - -### UpdateGoogleProvider - -> **rpc** UpdateGoogleProvider([UpdateGoogleProviderRequest](#updategoogleproviderrequest)) -[UpdateGoogleProviderResponse](#updategoogleproviderresponse) - -Change an existing Google identity provider on the instance - - - - PUT: /idps/google/{id} - - -### AddLDAPProvider - -> **rpc** AddLDAPProvider([AddLDAPProviderRequest](#addldapproviderrequest)) -[AddLDAPProviderResponse](#addldapproviderresponse) - -Add a new LDAP identity provider on the instance - - - - POST: /idps/ldap - - -### UpdateLDAPProvider - -> **rpc** UpdateLDAPProvider([UpdateLDAPProviderRequest](#updateldapproviderrequest)) -[UpdateLDAPProviderResponse](#updateldapproviderresponse) - -Change an existing LDAP identity provider on the instance - - - - PUT: /idps/ldap/{id} - - -### DeleteProvider - -> **rpc** DeleteProvider([DeleteProviderRequest](#deleteproviderrequest)) -[DeleteProviderResponse](#deleteproviderresponse) - -Remove an identity provider -Will remove all linked providers of this configuration on the users - - - - DELETE: /idps/templates/{id} - - -### GetOrgIAMPolicy - -> **rpc** GetOrgIAMPolicy([GetOrgIAMPolicyRequest](#getorgiampolicyrequest)) -[GetOrgIAMPolicyResponse](#getorgiampolicyresponse) - -deprecated: please use DomainPolicy instead -Returns the Org IAM policy defined by the administrators of ZITADEL - - - - GET: /policies/orgiam - - -### UpdateOrgIAMPolicy - -> **rpc** UpdateOrgIAMPolicy([UpdateOrgIAMPolicyRequest](#updateorgiampolicyrequest)) -[UpdateOrgIAMPolicyResponse](#updateorgiampolicyresponse) - -deprecated: please use DomainPolicy instead -Updates the default OrgIAM policy. -it impacts all organisations without a customised policy - - - - PUT: /policies/orgiam - - -### GetCustomOrgIAMPolicy - -> **rpc** GetCustomOrgIAMPolicy([GetCustomOrgIAMPolicyRequest](#getcustomorgiampolicyrequest)) -[GetCustomOrgIAMPolicyResponse](#getcustomorgiampolicyresponse) - -deprecated: please use DomainPolicy instead -Returns the customised policy or the default if not customised - - - - GET: /orgs/{org_id}/policies/orgiam - - -### AddCustomOrgIAMPolicy - -> **rpc** AddCustomOrgIAMPolicy([AddCustomOrgIAMPolicyRequest](#addcustomorgiampolicyrequest)) -[AddCustomOrgIAMPolicyResponse](#addcustomorgiampolicyresponse) - -deprecated: please use DomainPolicy instead -Defines a custom OrgIAM policy as specified - - - - POST: /orgs/{org_id}/policies/orgiam - - -### UpdateCustomOrgIAMPolicy - -> **rpc** UpdateCustomOrgIAMPolicy([UpdateCustomOrgIAMPolicyRequest](#updatecustomorgiampolicyrequest)) -[UpdateCustomOrgIAMPolicyResponse](#updatecustomorgiampolicyresponse) - -deprecated: please use DomainPolicy instead -Updates a custom OrgIAM policy as specified - - - - PUT: /orgs/{org_id}/policies/orgiam - - -### ResetCustomOrgIAMPolicyToDefault - -> **rpc** ResetCustomOrgIAMPolicyToDefault([ResetCustomOrgIAMPolicyToDefaultRequest](#resetcustomorgiampolicytodefaultrequest)) -[ResetCustomOrgIAMPolicyToDefaultResponse](#resetcustomorgiampolicytodefaultresponse) - -deprecated: please use DomainPolicy instead -Resets the org iam policy of the organisation to default -ZITADEL will fallback to the default policy defined by the ZITADEL administrators - - - - DELETE: /orgs/{org_id}/policies/orgiam - - -### GetDomainPolicy - -> **rpc** GetDomainPolicy([GetDomainPolicyRequest](#getdomainpolicyrequest)) -[GetDomainPolicyResponse](#getdomainpolicyresponse) - -Returns the Domain policy defined by the administrators of ZITADEL - - - - GET: /policies/domain - - -### UpdateDomainPolicy - -> **rpc** UpdateDomainPolicy([UpdateDomainPolicyRequest](#updatedomainpolicyrequest)) -[UpdateDomainPolicyResponse](#updatedomainpolicyresponse) - -Updates the default Domain policy. -it impacts all organisations without a customised policy - - - - PUT: /policies/domain - - -### GetCustomDomainPolicy - -> **rpc** GetCustomDomainPolicy([GetCustomDomainPolicyRequest](#getcustomdomainpolicyrequest)) -[GetCustomDomainPolicyResponse](#getcustomdomainpolicyresponse) - -Returns the customised policy or the default if not customised - - - - GET: /orgs/{org_id}/policies/domain - - -### AddCustomDomainPolicy - -> **rpc** AddCustomDomainPolicy([AddCustomDomainPolicyRequest](#addcustomdomainpolicyrequest)) -[AddCustomDomainPolicyResponse](#addcustomdomainpolicyresponse) - -Defines a custom Domain policy as specified - - - - POST: /orgs/{org_id}/policies/domain - - -### UpdateCustomDomainPolicy - -> **rpc** UpdateCustomDomainPolicy([UpdateCustomDomainPolicyRequest](#updatecustomdomainpolicyrequest)) -[UpdateCustomDomainPolicyResponse](#updatecustomdomainpolicyresponse) - -Updates a custom Domain policy as specified - - - - PUT: /orgs/{org_id}/policies/domain - - -### ResetCustomDomainPolicyToDefault - -> **rpc** ResetCustomDomainPolicyToDefault([ResetCustomDomainPolicyToDefaultRequest](#resetcustomdomainpolicytodefaultrequest)) -[ResetCustomDomainPolicyToDefaultResponse](#resetcustomdomainpolicytodefaultresponse) - -Resets the org iam policy of the organisation to default -ZITADEL will fallback to the default policy defined by the ZITADEL administrators - - - - DELETE: /orgs/{org_id}/policies/domain - - -### GetLabelPolicy - -> **rpc** GetLabelPolicy([GetLabelPolicyRequest](#getlabelpolicyrequest)) -[GetLabelPolicyResponse](#getlabelpolicyresponse) - -Returns the label policy defined by the administrators of ZITADEL - - - - GET: /policies/label - - -### GetPreviewLabelPolicy - -> **rpc** GetPreviewLabelPolicy([GetPreviewLabelPolicyRequest](#getpreviewlabelpolicyrequest)) -[GetPreviewLabelPolicyResponse](#getpreviewlabelpolicyresponse) - -Returns the preview label policy defined by the administrators of ZITADEL - - - - GET: /policies/label/_preview - - -### UpdateLabelPolicy - -> **rpc** UpdateLabelPolicy([UpdateLabelPolicyRequest](#updatelabelpolicyrequest)) -[UpdateLabelPolicyResponse](#updatelabelpolicyresponse) - -Updates the default label policy of ZITADEL -it impacts all organisations without a customised policy - - - - PUT: /policies/label - - -### ActivateLabelPolicy - -> **rpc** ActivateLabelPolicy([ActivateLabelPolicyRequest](#activatelabelpolicyrequest)) -[ActivateLabelPolicyResponse](#activatelabelpolicyresponse) - -Activates all changes of the label policy - - - - POST: /policies/label/_activate - - -### RemoveLabelPolicyLogo - -> **rpc** RemoveLabelPolicyLogo([RemoveLabelPolicyLogoRequest](#removelabelpolicylogorequest)) -[RemoveLabelPolicyLogoResponse](#removelabelpolicylogoresponse) - -Removes the logo of the label policy - - - - DELETE: /policies/label/logo - - -### RemoveLabelPolicyLogoDark - -> **rpc** RemoveLabelPolicyLogoDark([RemoveLabelPolicyLogoDarkRequest](#removelabelpolicylogodarkrequest)) -[RemoveLabelPolicyLogoDarkResponse](#removelabelpolicylogodarkresponse) - -Removes the logo dark of the label policy - - - - DELETE: /policies/label/logo_dark - - -### RemoveLabelPolicyIcon - -> **rpc** RemoveLabelPolicyIcon([RemoveLabelPolicyIconRequest](#removelabelpolicyiconrequest)) -[RemoveLabelPolicyIconResponse](#removelabelpolicyiconresponse) - -Removes the icon of the label policy - - - - DELETE: /policies/label/icon - - -### RemoveLabelPolicyIconDark - -> **rpc** RemoveLabelPolicyIconDark([RemoveLabelPolicyIconDarkRequest](#removelabelpolicyicondarkrequest)) -[RemoveLabelPolicyIconDarkResponse](#removelabelpolicyicondarkresponse) - -Removes the logo dark of the label policy - - - - DELETE: /policies/label/icon_dark - - -### RemoveLabelPolicyFont - -> **rpc** RemoveLabelPolicyFont([RemoveLabelPolicyFontRequest](#removelabelpolicyfontrequest)) -[RemoveLabelPolicyFontResponse](#removelabelpolicyfontresponse) - -Removes the font of the label policy - - - - DELETE: /policies/label/font - - -### GetLoginPolicy - -> **rpc** GetLoginPolicy([GetLoginPolicyRequest](#getloginpolicyrequest)) -[GetLoginPolicyResponse](#getloginpolicyresponse) - -Returns the login policy defined by the administrators of ZITADEL - - - - GET: /policies/login - - -### UpdateLoginPolicy - -> **rpc** UpdateLoginPolicy([UpdateLoginPolicyRequest](#updateloginpolicyrequest)) -[UpdateLoginPolicyResponse](#updateloginpolicyresponse) - -Updates the default login policy of ZITADEL -it impacts all organisations without a customised policy - - - - PUT: /policies/login - - -### ListLoginPolicyIDPs - -> **rpc** ListLoginPolicyIDPs([ListLoginPolicyIDPsRequest](#listloginpolicyidpsrequest)) -[ListLoginPolicyIDPsResponse](#listloginpolicyidpsresponse) - -Returns the idps linked to the default login policy, -defined by the administrators of ZITADEL - - - - POST: /policies/login/idps/_search - - -### AddIDPToLoginPolicy - -> **rpc** AddIDPToLoginPolicy([AddIDPToLoginPolicyRequest](#addidptologinpolicyrequest)) -[AddIDPToLoginPolicyResponse](#addidptologinpolicyresponse) - -Adds the povided idp to the default login policy. -It impacts all organisations without a customised policy - - - - POST: /policies/login/idps - - -### RemoveIDPFromLoginPolicy - -> **rpc** RemoveIDPFromLoginPolicy([RemoveIDPFromLoginPolicyRequest](#removeidpfromloginpolicyrequest)) -[RemoveIDPFromLoginPolicyResponse](#removeidpfromloginpolicyresponse) - -Removes the povided idp from the default login policy. -It impacts all organisations without a customised policy - - - - DELETE: /policies/login/idps/{idp_id} - - -### ListLoginPolicySecondFactors - -> **rpc** ListLoginPolicySecondFactors([ListLoginPolicySecondFactorsRequest](#listloginpolicysecondfactorsrequest)) -[ListLoginPolicySecondFactorsResponse](#listloginpolicysecondfactorsresponse) - -Returns the available second factors defined by the administrators of ZITADEL - - - - POST: /policies/login/second_factors/_search - - -### AddSecondFactorToLoginPolicy - -> **rpc** AddSecondFactorToLoginPolicy([AddSecondFactorToLoginPolicyRequest](#addsecondfactortologinpolicyrequest)) -[AddSecondFactorToLoginPolicyResponse](#addsecondfactortologinpolicyresponse) - -Adds a second factor to the default login policy. -It impacts all organisations without a customised policy - - - - POST: /policies/login/second_factors - - -### RemoveSecondFactorFromLoginPolicy - -> **rpc** RemoveSecondFactorFromLoginPolicy([RemoveSecondFactorFromLoginPolicyRequest](#removesecondfactorfromloginpolicyrequest)) -[RemoveSecondFactorFromLoginPolicyResponse](#removesecondfactorfromloginpolicyresponse) - -Removes a second factor from the default login policy. -It impacts all organisations without a customised policy - - - - DELETE: /policies/login/second_factors/{type} - - -### ListLoginPolicyMultiFactors - -> **rpc** ListLoginPolicyMultiFactors([ListLoginPolicyMultiFactorsRequest](#listloginpolicymultifactorsrequest)) -[ListLoginPolicyMultiFactorsResponse](#listloginpolicymultifactorsresponse) - -Returns the available multi factors defined by the administrators of ZITADEL - - - - POST: /policies/login/multi_factors/_search - - -### AddMultiFactorToLoginPolicy - -> **rpc** AddMultiFactorToLoginPolicy([AddMultiFactorToLoginPolicyRequest](#addmultifactortologinpolicyrequest)) -[AddMultiFactorToLoginPolicyResponse](#addmultifactortologinpolicyresponse) - -Adds a multi factor to the default login policy. -It impacts all organisations without a customised policy - - - - POST: /policies/login/multi_factors - - -### RemoveMultiFactorFromLoginPolicy - -> **rpc** RemoveMultiFactorFromLoginPolicy([RemoveMultiFactorFromLoginPolicyRequest](#removemultifactorfromloginpolicyrequest)) -[RemoveMultiFactorFromLoginPolicyResponse](#removemultifactorfromloginpolicyresponse) - -Removes a multi factor from the default login policy. -It impacts all organisations without a customised policy - - - - DELETE: /policies/login/multi_factors/{type} - - -### GetPasswordComplexityPolicy - -> **rpc** GetPasswordComplexityPolicy([GetPasswordComplexityPolicyRequest](#getpasswordcomplexitypolicyrequest)) -[GetPasswordComplexityPolicyResponse](#getpasswordcomplexitypolicyresponse) - -Returns the password complexity policy defined by the administrators of ZITADEL - - - - GET: /policies/password/complexity - - -### UpdatePasswordComplexityPolicy - -> **rpc** UpdatePasswordComplexityPolicy([UpdatePasswordComplexityPolicyRequest](#updatepasswordcomplexitypolicyrequest)) -[UpdatePasswordComplexityPolicyResponse](#updatepasswordcomplexitypolicyresponse) - -Updates the default password complexity policy of ZITADEL -it impacts all organisations without a customised policy - - - - PUT: /policies/password/complexity - - -### GetPasswordAgePolicy - -> **rpc** GetPasswordAgePolicy([GetPasswordAgePolicyRequest](#getpasswordagepolicyrequest)) -[GetPasswordAgePolicyResponse](#getpasswordagepolicyresponse) - -Returns the password age policy defined by the administrators of ZITADEL - - - - GET: /policies/password/age - - -### UpdatePasswordAgePolicy - -> **rpc** UpdatePasswordAgePolicy([UpdatePasswordAgePolicyRequest](#updatepasswordagepolicyrequest)) -[UpdatePasswordAgePolicyResponse](#updatepasswordagepolicyresponse) - -Updates the default password age policy of ZITADEL -it impacts all organisations without a customised policy - - - - PUT: /policies/password/age - - -### GetLockoutPolicy - -> **rpc** GetLockoutPolicy([GetLockoutPolicyRequest](#getlockoutpolicyrequest)) -[GetLockoutPolicyResponse](#getlockoutpolicyresponse) - -Returns the lockout policy defined by the administrators of ZITADEL - - - - GET: /policies/lockout - - -### UpdateLockoutPolicy - -> **rpc** UpdateLockoutPolicy([UpdateLockoutPolicyRequest](#updatelockoutpolicyrequest)) -[UpdateLockoutPolicyResponse](#updatelockoutpolicyresponse) - -Updates the default lockout policy of ZITADEL -it impacts all organisations without a customised policy - - - - PUT: /policies/password/lockout - - -### GetPrivacyPolicy - -> **rpc** GetPrivacyPolicy([GetPrivacyPolicyRequest](#getprivacypolicyrequest)) -[GetPrivacyPolicyResponse](#getprivacypolicyresponse) - -Returns the privacy policy defined by the administrators of ZITADEL - - - - GET: /policies/privacy - - -### UpdatePrivacyPolicy - -> **rpc** UpdatePrivacyPolicy([UpdatePrivacyPolicyRequest](#updateprivacypolicyrequest)) -[UpdatePrivacyPolicyResponse](#updateprivacypolicyresponse) - -Updates the default privacy policy of ZITADEL -it impacts all organisations without a customised policy -Variable {{.Lang}} can be set to have different links based on the language - - - - PUT: /policies/privacy - - -### AddNotificationPolicy - -> **rpc** AddNotificationPolicy([AddNotificationPolicyRequest](#addnotificationpolicyrequest)) -[AddNotificationPolicyResponse](#addnotificationpolicyresponse) - -Add a default notification policy for ZITADEL -it impacts all organisations without a customised policy - - - - POST: /policies/notification - - -### GetNotificationPolicy - -> **rpc** GetNotificationPolicy([GetNotificationPolicyRequest](#getnotificationpolicyrequest)) -[GetNotificationPolicyResponse](#getnotificationpolicyresponse) - -Returns the notification policy defined by the administrators of ZITADEL - - - - GET: /policies/notification - - -### UpdateNotificationPolicy - -> **rpc** UpdateNotificationPolicy([UpdateNotificationPolicyRequest](#updatenotificationpolicyrequest)) -[UpdateNotificationPolicyResponse](#updatenotificationpolicyresponse) - -Updates the default notification policy of ZITADEL -it impacts all organisations without a customised policy - - - - PUT: /policies/notification - - -### GetDefaultInitMessageText - -> **rpc** GetDefaultInitMessageText([GetDefaultInitMessageTextRequest](#getdefaultinitmessagetextrequest)) -[GetDefaultInitMessageTextResponse](#getdefaultinitmessagetextresponse) - -Returns the default text for initial message (translation file) - - - - GET: /text/default/message/init/{language} - - -### GetCustomInitMessageText - -> **rpc** GetCustomInitMessageText([GetCustomInitMessageTextRequest](#getcustominitmessagetextrequest)) -[GetCustomInitMessageTextResponse](#getcustominitmessagetextresponse) - -Returns the custom text for initial message (overwritten in eventstore) - - - - GET: /text/message/init/{language} - - -### SetDefaultInitMessageText - -> **rpc** SetDefaultInitMessageText([SetDefaultInitMessageTextRequest](#setdefaultinitmessagetextrequest)) -[SetDefaultInitMessageTextResponse](#setdefaultinitmessagetextresponse) - -Sets the default custom text for initial message -it impacts all organisations without customized initial message text -The Following Variables can be used: -{{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/init/{language} - - -### ResetCustomInitMessageTextToDefault - -> **rpc** ResetCustomInitMessageTextToDefault([ResetCustomInitMessageTextToDefaultRequest](#resetcustominitmessagetexttodefaultrequest)) -[ResetCustomInitMessageTextToDefaultResponse](#resetcustominitmessagetexttodefaultresponse) - -Removes the custom init message text of the system -The default text from the translation file will trigger after - - - - DELETE: /text/message/init/{language} - - -### GetDefaultPasswordResetMessageText - -> **rpc** GetDefaultPasswordResetMessageText([GetDefaultPasswordResetMessageTextRequest](#getdefaultpasswordresetmessagetextrequest)) -[GetDefaultPasswordResetMessageTextResponse](#getdefaultpasswordresetmessagetextresponse) - -Returns the default text for password reset message (translation file) - - - - GET: /text/deafult/message/passwordreset/{language} - - -### GetCustomPasswordResetMessageText - -> **rpc** GetCustomPasswordResetMessageText([GetCustomPasswordResetMessageTextRequest](#getcustompasswordresetmessagetextrequest)) -[GetCustomPasswordResetMessageTextResponse](#getcustompasswordresetmessagetextresponse) - -Returns the custom text for password reset message (overwritten in eventstore) - - - - GET: /text/message/passwordreset/{language} - - -### SetDefaultPasswordResetMessageText - -> **rpc** SetDefaultPasswordResetMessageText([SetDefaultPasswordResetMessageTextRequest](#setdefaultpasswordresetmessagetextrequest)) -[SetDefaultPasswordResetMessageTextResponse](#setdefaultpasswordresetmessagetextresponse) - -Sets the default custom text for password reset message -it impacts all organisations without customized password reset message text -The Following Variables can be used: -{{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/passwordreset/{language} - - -### ResetCustomPasswordResetMessageTextToDefault - -> **rpc** ResetCustomPasswordResetMessageTextToDefault([ResetCustomPasswordResetMessageTextToDefaultRequest](#resetcustompasswordresetmessagetexttodefaultrequest)) -[ResetCustomPasswordResetMessageTextToDefaultResponse](#resetcustompasswordresetmessagetexttodefaultresponse) - -Removes the custom password reset message text of the system -The default text from the translation file will trigger after - - - - DELETE: /text/message/verifyemail/{language} - - -### GetDefaultVerifyEmailMessageText - -> **rpc** GetDefaultVerifyEmailMessageText([GetDefaultVerifyEmailMessageTextRequest](#getdefaultverifyemailmessagetextrequest)) -[GetDefaultVerifyEmailMessageTextResponse](#getdefaultverifyemailmessagetextresponse) - -Returns the default text for verify email message (translation files) - - - - GET: /text/default/message/verifyemail/{language} - - -### GetCustomVerifyEmailMessageText - -> **rpc** GetCustomVerifyEmailMessageText([GetCustomVerifyEmailMessageTextRequest](#getcustomverifyemailmessagetextrequest)) -[GetCustomVerifyEmailMessageTextResponse](#getcustomverifyemailmessagetextresponse) - -Returns the custom text for verify email message (overwritten in eventstore) - - - - GET: /text/message/verifyemail/{language} - - -### SetDefaultVerifyEmailMessageText - -> **rpc** SetDefaultVerifyEmailMessageText([SetDefaultVerifyEmailMessageTextRequest](#setdefaultverifyemailmessagetextrequest)) -[SetDefaultVerifyEmailMessageTextResponse](#setdefaultverifyemailmessagetextresponse) - -Sets the default custom text for verify email message -it impacts all organisations without customized verify email message text -The Following Variables can be used: -{{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/verifyemail/{language} - - -### ResetCustomVerifyEmailMessageTextToDefault - -> **rpc** ResetCustomVerifyEmailMessageTextToDefault([ResetCustomVerifyEmailMessageTextToDefaultRequest](#resetcustomverifyemailmessagetexttodefaultrequest)) -[ResetCustomVerifyEmailMessageTextToDefaultResponse](#resetcustomverifyemailmessagetexttodefaultresponse) - -Removes the custom verify email message text of the system -The default text from the translation file will trigger after - - - - DELETE: /text/message/verifyemail/{language} - - -### GetDefaultVerifyPhoneMessageText - -> **rpc** GetDefaultVerifyPhoneMessageText([GetDefaultVerifyPhoneMessageTextRequest](#getdefaultverifyphonemessagetextrequest)) -[GetDefaultVerifyPhoneMessageTextResponse](#getdefaultverifyphonemessagetextresponse) - -Returns the default text for verify phone message (translation file) - - - - GET: /text/default/message/verifyphone/{language} - - -### GetCustomVerifyPhoneMessageText - -> **rpc** GetCustomVerifyPhoneMessageText([GetCustomVerifyPhoneMessageTextRequest](#getcustomverifyphonemessagetextrequest)) -[GetCustomVerifyPhoneMessageTextResponse](#getcustomverifyphonemessagetextresponse) - -Returns the custom text for verify phone message - - - - GET: /text/message/verifyphone/{language} - - -### SetDefaultVerifyPhoneMessageText - -> **rpc** SetDefaultVerifyPhoneMessageText([SetDefaultVerifyPhoneMessageTextRequest](#setdefaultverifyphonemessagetextrequest)) -[SetDefaultVerifyPhoneMessageTextResponse](#setdefaultverifyphonemessagetextresponse) - -Sets the default custom text for verify phone message -it impacts all organisations without customized verify phone message text -The Following Variables can be used: -{{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/verifyphone/{language} - - -### ResetCustomVerifyPhoneMessageTextToDefault - -> **rpc** ResetCustomVerifyPhoneMessageTextToDefault([ResetCustomVerifyPhoneMessageTextToDefaultRequest](#resetcustomverifyphonemessagetexttodefaultrequest)) -[ResetCustomVerifyPhoneMessageTextToDefaultResponse](#resetcustomverifyphonemessagetexttodefaultresponse) - -Removes the custom verify phone text of the system -The default text from the translation file will trigger after - - - - DELETE: /text/message/verifyphone/{language} - - -### GetDefaultDomainClaimedMessageText - -> **rpc** GetDefaultDomainClaimedMessageText([GetDefaultDomainClaimedMessageTextRequest](#getdefaultdomainclaimedmessagetextrequest)) -[GetDefaultDomainClaimedMessageTextResponse](#getdefaultdomainclaimedmessagetextresponse) - -Returns the default text for domain claimed message (translation file) - - - - GET: /text/default/message/domainclaimed/{language} - - -### GetCustomDomainClaimedMessageText - -> **rpc** GetCustomDomainClaimedMessageText([GetCustomDomainClaimedMessageTextRequest](#getcustomdomainclaimedmessagetextrequest)) -[GetCustomDomainClaimedMessageTextResponse](#getcustomdomainclaimedmessagetextresponse) - -Returns the custom text for domain claimed message (overwritten in eventstore) - - - - GET: /text/message/domainclaimed/{language} - - -### SetDefaultDomainClaimedMessageText - -> **rpc** SetDefaultDomainClaimedMessageText([SetDefaultDomainClaimedMessageTextRequest](#setdefaultdomainclaimedmessagetextrequest)) -[SetDefaultDomainClaimedMessageTextResponse](#setdefaultdomainclaimedmessagetextresponse) - -Sets the default custom text for domain claimed message -it impacts all organisations without customized domain claimed message text -The Following Variables can be used: -{{.Domain}} {{.TempUsername}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/domainclaimed/{language} - - -### ResetCustomDomainClaimedMessageTextToDefault - -> **rpc** ResetCustomDomainClaimedMessageTextToDefault([ResetCustomDomainClaimedMessageTextToDefaultRequest](#resetcustomdomainclaimedmessagetexttodefaultrequest)) -[ResetCustomDomainClaimedMessageTextToDefaultResponse](#resetcustomdomainclaimedmessagetexttodefaultresponse) - -Removes the custom domain claimed message text of the system -The default text from the translation file will trigger after - - - - DELETE: /text/message/domainclaimed/{language} - - -### GetDefaultPasswordlessRegistrationMessageText - -> **rpc** GetDefaultPasswordlessRegistrationMessageText([GetDefaultPasswordlessRegistrationMessageTextRequest](#getdefaultpasswordlessregistrationmessagetextrequest)) -[GetDefaultPasswordlessRegistrationMessageTextResponse](#getdefaultpasswordlessregistrationmessagetextresponse) - -Returns the default text for passwordless registration message (translation file) - - - - GET: /text/default/message/passwordless_registration/{language} - - -### GetCustomPasswordlessRegistrationMessageText - -> **rpc** GetCustomPasswordlessRegistrationMessageText([GetCustomPasswordlessRegistrationMessageTextRequest](#getcustompasswordlessregistrationmessagetextrequest)) -[GetCustomPasswordlessRegistrationMessageTextResponse](#getcustompasswordlessregistrationmessagetextresponse) - -Returns the custom text for passwordless registration message (overwritten in eventstore) - - - - GET: /text/message/passwordless_registration/{language} - - -### SetDefaultPasswordlessRegistrationMessageText - -> **rpc** SetDefaultPasswordlessRegistrationMessageText([SetDefaultPasswordlessRegistrationMessageTextRequest](#setdefaultpasswordlessregistrationmessagetextrequest)) -[SetDefaultPasswordlessRegistrationMessageTextResponse](#setdefaultpasswordlessregistrationmessagetextresponse) - -Sets the default custom text for passwordless registration message -it impacts all organisations without customized passwordless registration message text -The Following Variables can be used: -{{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/passwordless_registration/{language} - - -### ResetCustomPasswordlessRegistrationMessageTextToDefault - -> **rpc** ResetCustomPasswordlessRegistrationMessageTextToDefault([ResetCustomPasswordlessRegistrationMessageTextToDefaultRequest](#resetcustompasswordlessregistrationmessagetexttodefaultrequest)) -[ResetCustomPasswordlessRegistrationMessageTextToDefaultResponse](#resetcustompasswordlessregistrationmessagetexttodefaultresponse) - -Removes the custom passwordless link message text of the system -The default text from the translation file will trigger after - - - - DELETE: /text/message/passwordless_registration/{language} - - -### GetDefaultPasswordChangeMessageText - -> **rpc** GetDefaultPasswordChangeMessageText([GetDefaultPasswordChangeMessageTextRequest](#getdefaultpasswordchangemessagetextrequest)) -[GetDefaultPasswordChangeMessageTextResponse](#getdefaultpasswordchangemessagetextresponse) - -Returns the default text for password change message (translation file) - - - - GET: /text/default/message/password_change/{language} - - -### GetCustomPasswordChangeMessageText - -> **rpc** GetCustomPasswordChangeMessageText([GetCustomPasswordChangeMessageTextRequest](#getcustompasswordchangemessagetextrequest)) -[GetCustomPasswordChangeMessageTextResponse](#getcustompasswordchangemessagetextresponse) - -Returns the custom text for password change message (overwritten in eventstore) - - - - GET: /text/message/password_change/{language} - - -### SetDefaultPasswordChangeMessageText - -> **rpc** SetDefaultPasswordChangeMessageText([SetDefaultPasswordChangeMessageTextRequest](#setdefaultpasswordchangemessagetextrequest)) -[SetDefaultPasswordChangeMessageTextResponse](#setdefaultpasswordchangemessagetextresponse) - -Sets the default custom text for password change message -it impacts all organisations without customized password change message text -The Following Variables can be used: -{{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/password_change/{language} - - -### ResetCustomPasswordChangeMessageTextToDefault - -> **rpc** ResetCustomPasswordChangeMessageTextToDefault([ResetCustomPasswordChangeMessageTextToDefaultRequest](#resetcustompasswordchangemessagetexttodefaultrequest)) -[ResetCustomPasswordChangeMessageTextToDefaultResponse](#resetcustompasswordchangemessagetexttodefaultresponse) - -Removes the custom password change message text of the system -The default text from the translation file will trigger after - - - - DELETE: /text/message/password_change/{language} - - -### GetDefaultLoginTexts - -> **rpc** GetDefaultLoginTexts([GetDefaultLoginTextsRequest](#getdefaultlogintextsrequest)) -[GetDefaultLoginTextsResponse](#getdefaultlogintextsresponse) - -Returns the default custom texts for login ui (translation file) - - - - GET: /text/default/login/{language} - - -### GetCustomLoginTexts - -> **rpc** GetCustomLoginTexts([GetCustomLoginTextsRequest](#getcustomlogintextsrequest)) -[GetCustomLoginTextsResponse](#getcustomlogintextsresponse) - -Returns the custom texts for login ui - - - - GET: /text/login/{language} - - -### SetCustomLoginText - -> **rpc** SetCustomLoginText([SetCustomLoginTextsRequest](#setcustomlogintextsrequest)) -[SetCustomLoginTextsResponse](#setcustomlogintextsresponse) - -Sets the custom text for login ui -it impacts all organisations without customized login ui texts - - - - PUT: /text/login/{language} - - -### ResetCustomLoginTextToDefault - -> **rpc** ResetCustomLoginTextToDefault([ResetCustomLoginTextsToDefaultRequest](#resetcustomlogintextstodefaultrequest)) -[ResetCustomLoginTextsToDefaultResponse](#resetcustomlogintextstodefaultresponse) - -Removes the custom texts for login ui -it impacts all organisations without customized login ui texts -The default text form translation file will trigger after - - - - DELETE: /text/login/{language} - - -### ListIAMMemberRoles - -> **rpc** ListIAMMemberRoles([ListIAMMemberRolesRequest](#listiammemberrolesrequest)) -[ListIAMMemberRolesResponse](#listiammemberrolesresponse) - -Returns the IAM roles visible for the requested user - - - - POST: /members/roles/_search - - -### ListIAMMembers - -> **rpc** ListIAMMembers([ListIAMMembersRequest](#listiammembersrequest)) -[ListIAMMembersResponse](#listiammembersresponse) - -Returns all members matching the request -all queries need to match (ANDed) - - - - POST: /members/_search - - -### AddIAMMember - -> **rpc** AddIAMMember([AddIAMMemberRequest](#addiammemberrequest)) -[AddIAMMemberResponse](#addiammemberresponse) - -Adds a user to the membership list of ZITADEL with the given roles -undefined roles will be dropped - - - - POST: /members - - -### UpdateIAMMember - -> **rpc** UpdateIAMMember([UpdateIAMMemberRequest](#updateiammemberrequest)) -[UpdateIAMMemberResponse](#updateiammemberresponse) - -Sets the given roles on a member. -The member has only roles provided by this call - - - - PUT: /members/{user_id} - - -### RemoveIAMMember - -> **rpc** RemoveIAMMember([RemoveIAMMemberRequest](#removeiammemberrequest)) -[RemoveIAMMemberResponse](#removeiammemberresponse) - -Removes the user from the membership list of ZITADEL - - - - DELETE: /members/{user_id} - - -### ListViews - -> **rpc** ListViews([ListViewsRequest](#listviewsrequest)) -[ListViewsResponse](#listviewsresponse) - -Returns all stored read models of ZITADEL -views are used for search optimisation and optimise request latencies -they represent the delta of the event happend on the objects - - - - POST: /views/_search - - -### ListFailedEvents - -> **rpc** ListFailedEvents([ListFailedEventsRequest](#listfailedeventsrequest)) -[ListFailedEventsResponse](#listfailedeventsresponse) - -Returns event descriptions which cannot be processed. -It's possible that some events need some retries. -For example if the SMTP-API wasn't able to send an email at the first time - - - - POST: /failedevents/_search - - -### RemoveFailedEvent - -> **rpc** RemoveFailedEvent([RemoveFailedEventRequest](#removefailedeventrequest)) -[RemoveFailedEventResponse](#removefailedeventresponse) - -Deletes the event from failed events view. -the event is not removed from the change stream -This call is usefull if the system was able to process the event later. -e.g. if the second try of sending an email was successful. the first try produced a -failed event. You can find out if it worked on the `failure_count` - - - - DELETE: /failedevents/{database}/{view_name}/{failed_sequence} - - -### ImportData - -> **rpc** ImportData([ImportDataRequest](#importdatarequest)) -[ImportDataResponse](#importdataresponse) - -Imports data into instance and creates different objects - - - - POST: /import - - -### ExportData - -> **rpc** ExportData([ExportDataRequest](#exportdatarequest)) -[ExportDataResponse](#exportdataresponse) - -Exports data from instance - - - - POST: /export - - -### ListEventTypes - -> **rpc** ListEventTypes([ListEventTypesRequest](#listeventtypesrequest)) -[ListEventTypesResponse](#listeventtypesresponse) - - - - - - POST: /events/types/_search - - -### ListEvents - -> **rpc** ListEvents([ListEventsRequest](#listeventsrequest)) -[ListEventsResponse](#listeventsresponse) - - - - - - POST: /events/_search - - -### ListAggregateTypes - -> **rpc** ListAggregateTypes([ListAggregateTypesRequest](#listaggregatetypesrequest)) -[ListAggregateTypesResponse](#listaggregatetypesresponse) - - - - - - POST: /aggregates/types/_search - - - - - - - -## Messages - - -### ActivateLabelPolicyRequest -This is an empty request - - - - -### ActivateLabelPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ActivateSMSProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ActivateSMSProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddCustomDomainPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_login_must_be_domain | bool | the username has to end with the domain of it's organisation (uniqueness is organisation based) | | -| validate_org_domains | bool | - | | -| smtp_sender_address_matches_instance_domain | bool | - | | - - - - -### AddCustomDomainPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddCustomOrgIAMPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_login_must_be_domain | bool | the username has to end with the domain of it's organisation (uniqueness is organisation based) | | - - - - -### AddCustomOrgIAMPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddGoogleProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | Google will be used as default, if no name is provided | string.max_len: 200
| -| client_id | string | - | string.min_len: 1
string.max_len: 200
| -| client_secret | string | - | string.min_len: 1
string.max_len: 200
| -| scopes | repeated string | - | repeated.max_items: 20
repeated.items.string.min_len: 1
repeated.items.string.max_len: 100
| -| provider_options | zitadel.idp.v1.Options | - | | - - - - -### AddGoogleProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| id | string | - | | - - - - -### AddIAMMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| roles | repeated string | if no roles provided the user won't have any rights | | - - - - -### AddIAMMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddIDPToLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | Id of the predefined idp configuration | string.min_len: 1
string.max_len: 200
| - - - - -### AddIDPToLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddJWTIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.min_len: 1
string.max_len: 200
| -| styling_type | zitadel.idp.v1.IDPStylingType | - | enum.defined_only: true
| -| jwt_endpoint | string | - | string.min_len: 1
string.max_len: 200
| -| issuer | string | - | string.min_len: 1
string.max_len: 200
| -| keys_endpoint | string | - | string.min_len: 1
string.max_len: 200
| -| header_name | string | - | string.min_len: 1
string.max_len: 200
| -| auto_register | bool | - | | - - - - -### AddJWTIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| idp_id | string | - | | - - - - -### AddLDAPProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.min_len: 1
string.max_len: 200
| -| host | string | - | string.min_len: 1
string.max_len: 200
| -| port | string | - | string.max_len: 5
| -| tls | bool | - | | -| base_dn | string | - | string.min_len: 1
string.max_len: 200
| -| user_object_class | string | - | string.min_len: 1
string.max_len: 200
| -| user_unique_attribute | string | - | string.min_len: 1
string.max_len: 200
| -| admin | string | - | string.min_len: 1
string.max_len: 200
| -| password | string | - | string.min_len: 1
string.max_len: 200
| -| attributes | zitadel.idp.v1.LDAPAttributes | - | | -| provider_options | zitadel.idp.v1.Options | - | | - - - - -### AddLDAPProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| id | string | - | | - - - - -### AddMultiFactorToLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | zitadel.policy.v1.MultiFactorType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### AddMultiFactorToLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddNotificationPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| password_change | bool | - | | - - - - -### AddNotificationPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddOIDCIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.min_len: 1
string.max_len: 200
| -| styling_type | zitadel.idp.v1.IDPStylingType | - | enum.defined_only: true
| -| client_id | string | - | string.min_len: 1
string.max_len: 200
| -| client_secret | string | - | string.min_len: 1
string.max_len: 200
| -| issuer | string | - | string.min_len: 1
string.max_len: 200
| -| scopes | repeated string | - | | -| display_name_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true
| -| username_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true
| -| auto_register | bool | - | | - - - - -### AddOIDCIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| idp_id | string | - | | - - - - -### AddOIDCSettingsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| access_token_lifetime | google.protobuf.Duration | - | | -| id_token_lifetime | google.protobuf.Duration | - | | -| refresh_token_idle_expiration | google.protobuf.Duration | - | | -| refresh_token_expiration | google.protobuf.Duration | - | | - - - - -### AddOIDCSettingsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddSMSProviderTwilioRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| sid | string | - | string.min_len: 1
string.max_len: 200
| -| token | string | - | string.min_len: 1
string.max_len: 200
| -| sender_number | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### AddSMSProviderTwilioResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| id | string | - | | - - - - -### AddSMTPConfigRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| sender_address | string | - | string.min_len: 1
string.max_len: 200
| -| sender_name | string | - | string.min_len: 1
string.max_len: 200
| -| tls | bool | - | | -| host | string | - | string.min_len: 1
string.max_len: 500
| -| user | string | - | | -| password | string | - | | - - - - -### AddSMTPConfigResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddSecondFactorToLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | zitadel.policy.v1.SecondFactorType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### AddSecondFactorToLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### DataOrg - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | | -| org | zitadel.management.v1.AddOrgRequest | - | | -| domain_policy | AddCustomDomainPolicyRequest | - | | -| label_policy | zitadel.management.v1.AddCustomLabelPolicyRequest | - | | -| lockout_policy | zitadel.management.v1.AddCustomLockoutPolicyRequest | - | | -| login_policy | zitadel.management.v1.AddCustomLoginPolicyRequest | - | | -| password_complexity_policy | zitadel.management.v1.AddCustomPasswordComplexityPolicyRequest | - | | -| privacy_policy | zitadel.management.v1.AddCustomPrivacyPolicyRequest | - | | -| projects | repeated zitadel.v1.v1.DataProject | - | | -| project_roles | repeated zitadel.management.v1.AddProjectRoleRequest | - | | -| api_apps | repeated zitadel.v1.v1.DataAPIApplication | - | | -| oidc_apps | repeated zitadel.v1.v1.DataOIDCApplication | - | | -| human_users | repeated zitadel.v1.v1.DataHumanUser | - | | -| machine_users | repeated zitadel.v1.v1.DataMachineUser | - | | -| trigger_actions | repeated zitadel.management.v1.SetTriggerActionsRequest | - | | -| actions | repeated zitadel.v1.v1.DataAction | - | | -| project_grants | repeated zitadel.v1.v1.DataProjectGrant | - | | -| user_grants | repeated zitadel.management.v1.AddUserGrantRequest | - | | -| org_members | repeated zitadel.management.v1.AddOrgMemberRequest | - | | -| project_members | repeated zitadel.management.v1.AddProjectMemberRequest | - | | -| project_grant_members | repeated zitadel.management.v1.AddProjectGrantMemberRequest | - | | -| user_metadata | repeated zitadel.management.v1.SetUserMetadataRequest | - | | -| login_texts | repeated zitadel.management.v1.SetCustomLoginTextsRequest | - | | -| init_messages | repeated zitadel.management.v1.SetCustomInitMessageTextRequest | - | | -| password_reset_messages | repeated zitadel.management.v1.SetCustomPasswordResetMessageTextRequest | - | | -| verify_email_messages | repeated zitadel.management.v1.SetCustomVerifyEmailMessageTextRequest | - | | -| verify_phone_messages | repeated zitadel.management.v1.SetCustomVerifyPhoneMessageTextRequest | - | | -| domain_claimed_messages | repeated zitadel.management.v1.SetCustomDomainClaimedMessageTextRequest | - | | -| passwordless_registration_messages | repeated zitadel.management.v1.SetCustomPasswordlessRegistrationMessageTextRequest | - | | -| oidc_idps | repeated zitadel.v1.v1.DataOIDCIDP | - | | -| jwt_idps | repeated zitadel.v1.v1.DataJWTIDP | - | | -| user_links | repeated zitadel.idp.v1.IDPUserLink | - | | -| domains | repeated zitadel.org.v1.Domain | - | | -| app_keys | repeated zitadel.v1.v1.DataAppKey | - | | -| machine_keys | repeated zitadel.v1.v1.DataMachineKey | - | | - - - - -### DeactivateIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### DeactivateIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### DeactivateSMSProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### DeactivateSMSProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### DeleteProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### DeleteProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ExportDataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_ids | repeated string | - | | -| excluded_org_ids | repeated string | - | | -| with_passwords | bool | - | | -| with_otp | bool | - | | -| response_output | bool | - | | -| local_output | ExportDataRequest.LocalOutput | - | | -| s3_output | ExportDataRequest.S3Output | - | | -| gcs_output | ExportDataRequest.GCSOutput | - | | -| timeout | string | - | | - - - - -### ExportDataRequest.GCSOutput - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| bucket | string | - | | -| serviceaccount_json | string | - | | -| path | string | - | | - - - - -### ExportDataRequest.LocalOutput - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| path | string | - | | - - - - -### ExportDataRequest.S3Output - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| path | string | - | | -| endpoint | string | - | | -| access_key_id | string | - | | -| secret_access_key | string | - | | -| ssl | bool | - | | -| bucket | string | - | | - - - - -### ExportDataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| orgs | repeated DataOrg | - | | - - - - -### FailedEvent - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| database | string | - | | -| view_name | string | - | | -| failed_sequence | uint64 | - | | -| failure_count | uint64 | - | | -| error_message | string | - | | -| last_failed | google.protobuf.Timestamp | - | | - - - - -### GetCustomDomainClaimedMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomDomainClaimedMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomDomainPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomDomainPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.DomainPolicy | - | | -| is_default | bool | deprecated: is_default is also defined in zitadel.policy.v1.DomainPolicy | | - - - - -### GetCustomInitMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomInitMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomLoginTextsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomLoginTextsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.LoginCustomText | - | | - - - - -### GetCustomOrgIAMPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomOrgIAMPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.OrgIAMPolicy | - | | -| is_default | bool | deprecated: is_default is also defined in zitadel.policy.v1.OrgIAMPolicy | | - - - - -### GetCustomPasswordChangeMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomPasswordChangeMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomPasswordResetMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomPasswordResetMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomPasswordlessRegistrationMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomPasswordlessRegistrationMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomVerifyEmailMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomVerifyEmailMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomVerifyPhoneMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomVerifyPhoneMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultDomainClaimedMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultDomainClaimedMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultInitMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultInitMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultLanguageRequest -This is an empty request - - - - -### GetDefaultLanguageResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | | - - - - -### GetDefaultLoginTextsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultLoginTextsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.LoginCustomText | - | | - - - - -### GetDefaultOrgRequest -This is an empty request - - - - -### GetDefaultOrgResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org | zitadel.org.v1.Org | - | | - - - - -### GetDefaultPasswordChangeMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultPasswordChangeMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultPasswordResetMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultPasswordResetMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultPasswordlessRegistrationMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultPasswordlessRegistrationMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultVerifyEmailMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultVerifyEmailMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultVerifyPhoneMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultVerifyPhoneMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDomainPolicyRequest - - - - - -### GetDomainPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.DomainPolicy | - | | - - - - -### GetFileSystemNotificationProviderRequest -This is an empty request - - - - -### GetFileSystemNotificationProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| provider | zitadel.settings.v1.DebugNotificationProvider | - | | - - - - -### GetIDPByIDRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetIDPByIDResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp | zitadel.idp.v1.IDP | - | | - - - - -### GetLabelPolicyRequest -This is an empty request - - - - -### GetLabelPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LabelPolicy | - | | - - - - -### GetLockoutPolicyRequest -This is an empty request - - - - -### GetLockoutPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LockoutPolicy | - | | - - - - -### GetLogNotificationProviderRequest -This is an empty request - - - - -### GetLogNotificationProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| provider | zitadel.settings.v1.DebugNotificationProvider | - | | - - - - -### GetLoginPolicyRequest -This is an empty request - - - - -### GetLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LoginPolicy | - | | - - - - -### GetMyInstanceRequest -This is an empty request - - - - -### GetMyInstanceResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance | zitadel.instance.v1.InstanceDetail | - | | - - - - -### GetNotificationPolicyRequest -This is an empty request - - - - -### GetNotificationPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.NotificationPolicy | - | | - - - - -### GetOIDCSettingsRequest -This is an empty request - - - - -### GetOIDCSettingsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| settings | zitadel.settings.v1.OIDCSettings | - | | - - - - -### GetOrgByIDRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetOrgByIDResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org | zitadel.org.v1.Org | - | | - - - - -### GetOrgIAMPolicyRequest - - - - - -### GetOrgIAMPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.OrgIAMPolicy | - | | - - - - -### GetPasswordAgePolicyRequest -This is an empty request - - - - -### GetPasswordAgePolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.PasswordAgePolicy | - | | - - - - -### GetPasswordComplexityPolicyRequest - - - - - -### GetPasswordComplexityPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.PasswordComplexityPolicy | - | | - - - - -### GetPreviewLabelPolicyRequest -This is an empty request - - - - -### GetPreviewLabelPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LabelPolicy | - | | - - - - -### GetPrivacyPolicyRequest -This is an empty request - - - - -### GetPrivacyPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.PrivacyPolicy | - | | - - - - -### GetProviderByIDRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetProviderByIDResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp | zitadel.idp.v1.Provider | - | | - - - - -### GetSMSProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 100
| - - - - -### GetSMSProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| config | zitadel.settings.v1.SMSProvider | - | | - - - - -### GetSMTPConfigRequest -This is an empty request - - - - -### GetSMTPConfigResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| smtp_config | zitadel.settings.v1.SMTPConfig | - | | - - - - -### GetSecretGeneratorRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| generator_type | zitadel.settings.v1.SecretGeneratorType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### GetSecretGeneratorResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| secret_generator | zitadel.settings.v1.SecretGenerator | - | | - - - - -### GetSecurityPolicyRequest -This is an empty request - - - - -### GetSecurityPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.settings.v1.SecurityPolicy | - | | - - - - -### GetSupportedLanguagesRequest -This is an empty request - - - - -### GetSupportedLanguagesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| languages | repeated string | - | | - - - - -### HealthzRequest -This is an empty request - - - - -### HealthzResponse -This is an empty response - - - - -### IDPQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.idp_id_query | zitadel.idp.v1.IDPIDQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.idp_name_query | zitadel.idp.v1.IDPNameQuery | - | | - - - - -### ImportDataError - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | string | - | | -| id | string | - | | -| message | string | - | | - - - - -### ImportDataOrg - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| orgs | repeated DataOrg | - | | - - - - -### ImportDataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) data.data_orgs | ImportDataOrg | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) data.data_orgsv1 | zitadel.v1.v1.ImportDataOrg | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) data.data_orgs_local | ImportDataRequest.LocalInput | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) data.data_orgsv1_local | ImportDataRequest.LocalInput | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) data.data_orgs_s3 | ImportDataRequest.S3Input | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) data.data_orgsv1_s3 | ImportDataRequest.S3Input | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) data.data_orgs_gcs | ImportDataRequest.GCSInput | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) data.data_orgsv1_gcs | ImportDataRequest.GCSInput | - | | -| timeout | string | - | | - - - - -### ImportDataRequest.GCSInput - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| bucket | string | - | | -| serviceaccount_json | string | - | | -| path | string | - | | - - - - -### ImportDataRequest.LocalInput - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| path | string | - | | - - - - -### ImportDataRequest.S3Input - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| path | string | - | | -| endpoint | string | - | | -| access_key_id | string | - | | -| secret_access_key | string | - | | -| ssl | bool | - | | -| bucket | string | - | | - - - - -### ImportDataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| errors | repeated ImportDataError | - | | -| success | ImportDataSuccess | - | | - - - - -### ImportDataSuccess - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| orgs | repeated ImportDataSuccessOrg | - | | - - - - -### ImportDataSuccessOrg - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | | -| project_ids | repeated string | - | | -| project_roles | repeated string | - | | -| oidc_app_ids | repeated string | - | | -| api_app_ids | repeated string | - | | -| human_user_ids | repeated string | - | | -| machine_user_ids | repeated string | - | | -| action_ids | repeated string | - | | -| trigger_actions | repeated zitadel.management.v1.SetTriggerActionsRequest | - | | -| project_grants | repeated ImportDataSuccessProjectGrant | - | | -| user_grants | repeated ImportDataSuccessUserGrant | - | | -| org_members | repeated string | - | | -| project_members | repeated ImportDataSuccessProjectMember | - | | -| project_grant_members | repeated ImportDataSuccessProjectGrantMember | - | | -| oidc_ipds | repeated string | - | | -| jwt_idps | repeated string | - | | -| idp_links | repeated string | - | | -| user_links | repeated ImportDataSuccessUserLinks | - | | -| user_metadata | repeated ImportDataSuccessUserMetadata | - | | -| domains | repeated string | - | | -| app_keys | repeated string | - | | -| machine_keys | repeated string | - | | - - - - -### ImportDataSuccessProjectGrant - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| grant_id | string | - | | -| project_id | string | - | | -| org_id | string | - | | - - - - -### ImportDataSuccessProjectGrantMember - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | | -| grant_id | string | - | | -| user_id | string | - | | - - - - -### ImportDataSuccessProjectMember - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | | -| user_id | string | - | | - - - - -### ImportDataSuccessUserGrant - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | | -| user_id | string | - | | - - - - -### ImportDataSuccessUserLinks - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | | -| external_user_id | string | - | | -| display_name | string | - | | -| idp_id | string | - | | - - - - -### ImportDataSuccessUserMetadata - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | | -| key | string | - | | - - - - -### IsOrgUniqueRequest -if name or domain is already in use, org is not unique -at least one argument has to be provided - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.max_len: 200
| -| domain | string | - | string.max_len: 200
| - - - - -### IsOrgUniqueResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| is_unique | bool | - | | - - - - -### ListAggregateTypesRequest - - - - - -### ListAggregateTypesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| aggregate_types | repeated zitadel.event.v1.AggregateType | - | | - - - - -### ListEventTypesRequest - - - - - -### ListEventTypesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| event_types | repeated zitadel.event.v1.EventType | - | | - - - - -### ListEventsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| sequence | uint64 | sequence represents the order of events. It's always upcounting if asc is false sequence is used as less than filter if asc is true sequence is used as greater than filter if sequence is 0 the field is ignored | | -| limit | uint32 | - | | -| asc | bool | - | | -| editor_user_id | string | - | string.min_len: 0
string.max_len: 200
| -| event_types | repeated string | the types are or filtered and must match the type exatly | repeated.max_items: 30
| -| aggregate_id | string | - | string.min_len: 0
string.max_len: 200
| -| aggregate_types | repeated string | - | repeated.max_items: 10
| -| resource_owner | string | - | string.min_len: 0
string.max_len: 200
| -| creation_date | google.protobuf.Timestamp | if asc is false creation_date is used as less than filter if asc is true creation_date is used as greater than filter if creation_date is not set the field is ignored | | - - - - -### ListEventsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| events | repeated zitadel.event.v1.Event | - | | - - - - -### ListFailedEventsRequest -This is an empty request - - - - -### ListFailedEventsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated FailedEvent | TODO: list details | | - - - - -### ListIAMMemberRolesRequest -This is an empty request - - - - -### ListIAMMemberRolesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| roles | repeated string | - | | - - - - -### ListIAMMembersRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.member.v1.SearchQuery | criterias the client is looking for | | - - - - -### ListIAMMembersResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.member.v1.Member | - | | - - - - -### ListIDPsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| sorting_column | zitadel.idp.v1.IDPFieldName | the field the result is sorted | | -| queries | repeated IDPQuery | criterias the client is looking for | | - - - - -### ListIDPsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| sorting_column | zitadel.idp.v1.IDPFieldName | - | | -| result | repeated zitadel.idp.v1.IDP | - | | - - - - -### ListInstanceDomainsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | - | | -| sorting_column | zitadel.instance.v1.DomainFieldName | the field the result is sorted | | -| queries | repeated zitadel.instance.v1.DomainSearchQuery | criterias the client is looking for | | - - - - -### ListInstanceDomainsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| sorting_column | zitadel.instance.v1.DomainFieldName | - | | -| result | repeated zitadel.instance.v1.Domain | - | | - - - - -### ListLoginPolicyIDPsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | - - - - -### ListLoginPolicyIDPsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.idp.v1.IDPLoginPolicyLink | - | | - - - - -### ListLoginPolicyMultiFactorsRequest -This is an empty request - - - - -### ListLoginPolicyMultiFactorsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.policy.v1.MultiFactorType | - | | - - - - -### ListLoginPolicySecondFactorsRequest -This is an empty request - - - - -### ListLoginPolicySecondFactorsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.policy.v1.SecondFactorType | - | | - - - - -### ListOrgsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| sorting_column | zitadel.org.v1.OrgFieldName | the field the result is sorted | | -| queries | repeated zitadel.org.v1.OrgQuery | criterias the client is looking for | | - - - - -### ListOrgsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| sorting_column | zitadel.org.v1.OrgFieldName | - | | -| result | repeated zitadel.org.v1.Org | - | | - - - - -### ListProvidersRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated ProviderQuery | criteria the client is looking for | | - - - - -### ListProvidersResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.idp.v1.Provider | - | | - - - - -### ListSMSProvidersRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | - - - - -### ListSMSProvidersResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.settings.v1.SMSProvider | - | | - - - - -### ListSecretGeneratorsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.settings.v1.SecretGeneratorQuery | criterias the client is looking for | | - - - - -### ListSecretGeneratorsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.settings.v1.SecretGenerator | - | | - - - - -### ListViewsRequest -This is an empty request - - - - -### ListViewsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated View | TODO: list details | | - - - - -### ProviderQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.idp_id_query | zitadel.idp.v1.IDPIDQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.idp_name_query | zitadel.idp.v1.IDPNameQuery | - | | - - - - -### ReactivateIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ReactivateIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveFailedEventRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| database | string | - | string.min_len: 1
string.max_len: 200
| -| view_name | string | - | string.min_len: 1
string.max_len: 200
| -| failed_sequence | uint64 | - | | - - - - -### RemoveFailedEventResponse -This is an empty response - - - - -### RemoveIAMMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveIAMMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveIDPFromLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveIDPFromLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveLabelPolicyFontRequest -This is an empty request - - - - -### RemoveLabelPolicyFontResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveLabelPolicyIconDarkRequest -This is an empty request - - - - -### RemoveLabelPolicyIconDarkResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveLabelPolicyIconRequest -This is an empty request - - - - -### RemoveLabelPolicyIconResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveLabelPolicyLogoDarkRequest -This is an empty request - - - - -### RemoveLabelPolicyLogoDarkResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveLabelPolicyLogoRequest -This is an empty request - - - - -### RemoveLabelPolicyLogoResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveMultiFactorFromLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | zitadel.policy.v1.MultiFactorType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### RemoveMultiFactorFromLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveOrgRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveOrgResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveSMSProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveSMSProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveSMTPConfigRequest -this is en empty request - - - - -### RemoveSMTPConfigResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveSecondFactorFromLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | zitadel.policy.v1.SecondFactorType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### RemoveSecondFactorFromLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomDomainClaimedMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomDomainClaimedMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomDomainPolicyToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomDomainPolicyToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomInitMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomInitMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomLoginTextsToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomLoginTextsToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomOrgIAMPolicyToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomOrgIAMPolicyToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomPasswordChangeMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomPasswordChangeMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomPasswordResetMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomPasswordResetMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomPasswordlessRegistrationMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomPasswordlessRegistrationMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomVerifyEmailMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomVerifyEmailMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomVerifyPhoneMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomVerifyPhoneMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetCustomLoginTextsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| select_account_text | zitadel.text.v1.SelectAccountScreenText | - | | -| login_text | zitadel.text.v1.LoginScreenText | - | | -| password_text | zitadel.text.v1.PasswordScreenText | - | | -| username_change_text | zitadel.text.v1.UsernameChangeScreenText | - | | -| username_change_done_text | zitadel.text.v1.UsernameChangeDoneScreenText | - | | -| init_password_text | zitadel.text.v1.InitPasswordScreenText | - | | -| init_password_done_text | zitadel.text.v1.InitPasswordDoneScreenText | - | | -| email_verification_text | zitadel.text.v1.EmailVerificationScreenText | - | | -| email_verification_done_text | zitadel.text.v1.EmailVerificationDoneScreenText | - | | -| initialize_user_text | zitadel.text.v1.InitializeUserScreenText | - | | -| initialize_done_text | zitadel.text.v1.InitializeUserDoneScreenText | - | | -| init_mfa_prompt_text | zitadel.text.v1.InitMFAPromptScreenText | - | | -| init_mfa_otp_text | zitadel.text.v1.InitMFAOTPScreenText | - | | -| init_mfa_u2f_text | zitadel.text.v1.InitMFAU2FScreenText | - | | -| init_mfa_done_text | zitadel.text.v1.InitMFADoneScreenText | - | | -| mfa_providers_text | zitadel.text.v1.MFAProvidersText | - | | -| verify_mfa_otp_text | zitadel.text.v1.VerifyMFAOTPScreenText | - | | -| verify_mfa_u2f_text | zitadel.text.v1.VerifyMFAU2FScreenText | - | | -| passwordless_text | zitadel.text.v1.PasswordlessScreenText | - | | -| password_change_text | zitadel.text.v1.PasswordChangeScreenText | - | | -| password_change_done_text | zitadel.text.v1.PasswordChangeDoneScreenText | - | | -| password_reset_done_text | zitadel.text.v1.PasswordResetDoneScreenText | - | | -| registration_option_text | zitadel.text.v1.RegistrationOptionScreenText | - | | -| registration_user_text | zitadel.text.v1.RegistrationUserScreenText | - | | -| registration_org_text | zitadel.text.v1.RegistrationOrgScreenText | - | | -| linking_user_done_text | zitadel.text.v1.LinkingUserDoneScreenText | - | | -| external_user_not_found_text | zitadel.text.v1.ExternalUserNotFoundScreenText | - | | -| success_login_text | zitadel.text.v1.SuccessLoginScreenText | - | | -| logout_text | zitadel.text.v1.LogoutDoneScreenText | - | | -| footer_text | zitadel.text.v1.FooterText | - | | -| passwordless_prompt_text | zitadel.text.v1.PasswordlessPromptScreenText | - | | -| passwordless_registration_text | zitadel.text.v1.PasswordlessRegistrationScreenText | - | | -| passwordless_registration_done_text | zitadel.text.v1.PasswordlessRegistrationDoneScreenText | - | | -| external_registration_user_overview_text | zitadel.text.v1.ExternalRegistrationUserOverviewScreenText | - | | - - - - -### SetCustomLoginTextsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetDefaultDomainClaimedMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetDefaultDomainClaimedMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetDefaultInitMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 1000
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetDefaultInitMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetDefaultLanguageRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 10
| - - - - -### SetDefaultLanguageResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetDefaultOrgRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### SetDefaultOrgResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetDefaultPasswordChangeMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetDefaultPasswordChangeMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetDefaultPasswordResetMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetDefaultPasswordResetMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetDefaultPasswordlessRegistrationMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetDefaultPasswordlessRegistrationMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetDefaultVerifyEmailMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetDefaultVerifyEmailMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetDefaultVerifyPhoneMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetDefaultVerifyPhoneMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetSecurityPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| enable_iframe_embedding | bool | states if iframe embedding is enabled or disabled | | -| allowed_origins | repeated string | origins allowed to load ZITADEL in an iframe if enable_iframe_embedding is true | | - - - - -### SetSecurityPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetUpOrgRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org | SetUpOrgRequest.Org | - | message.required: true
| -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) user.human | SetUpOrgRequest.Human | oneof field for the user managing the organisation | | -| roles | repeated string | specify Org Member Roles for the provided user (default is ORG_OWNER if roles are empty) | | - - - - -### SetUpOrgRequest.Human - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_name | string | - | string.min_len: 1
string.max_len: 200
| -| profile | SetUpOrgRequest.Human.Profile | - | message.required: true
| -| email | SetUpOrgRequest.Human.Email | - | message.required: true
| -| phone | SetUpOrgRequest.Human.Phone | - | | -| password | string | - | | - - - - -### SetUpOrgRequest.Human.Email - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| email | string | - | string.email: true
| -| is_email_verified | bool | - | | - - - - -### SetUpOrgRequest.Human.Phone - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| phone | string | has to be a global number | string.min_len: 1
string.max_len: 50
string.prefix: +
| -| is_phone_verified | bool | - | | - - - - -### SetUpOrgRequest.Human.Profile - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| first_name | string | - | string.min_len: 1
string.max_len: 200
| -| last_name | string | - | string.min_len: 1
string.max_len: 200
| -| nick_name | string | - | string.max_len: 200
| -| display_name | string | - | string.max_len: 200
| -| preferred_language | string | - | string.max_len: 10
| -| gender | zitadel.user.v1.Gender | - | | - - - - -### SetUpOrgRequest.Org - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.min_len: 1
string.max_len: 200
| -| domain | string | - | string.max_len: 200
| - - - - -### SetUpOrgResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| org_id | string | - | | -| user_id | string | - | | - - - - -### UpdateCustomDomainPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_login_must_be_domain | bool | - | | -| validate_org_domains | bool | - | | -| smtp_sender_address_matches_instance_domain | bool | - | | - - - - -### UpdateCustomDomainPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateCustomOrgIAMPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_login_must_be_domain | bool | - | | - - - - -### UpdateCustomOrgIAMPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateDomainPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_login_must_be_domain | bool | - | | -| validate_org_domains | bool | - | | -| smtp_sender_address_matches_instance_domain | bool | - | | - - - - -### UpdateDomainPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateGoogleProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.max_len: 200
| -| client_id | string | - | string.min_len: 1
string.max_len: 200
| -| client_secret | string | client_secret will only be updated if provided | string.max_len: 200
| -| scopes | repeated string | - | repeated.max_items: 20
repeated.items.string.min_len: 1
repeated.items.string.max_len: 100
| -| provider_options | zitadel.idp.v1.Options | - | | - - - - -### UpdateGoogleProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateIAMMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| roles | repeated string | if no roles provided the user won't have any rights | | - - - - -### UpdateIAMMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateIDPJWTConfigRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| -| jwt_endpoint | string | - | string.min_len: 1
string.max_len: 200
| -| issuer | string | - | string.min_len: 1
string.max_len: 200
| -| keys_endpoint | string | - | string.min_len: 1
string.max_len: 200
| -| header_name | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### UpdateIDPJWTConfigResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateIDPOIDCConfigRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| -| issuer | string | - | string.min_len: 1
string.max_len: 200
| -| client_id | string | - | string.min_len: 1
string.max_len: 200
| -| client_secret | string | - | string.max_len: 200
| -| scopes | repeated string | - | | -| display_name_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true
| -| username_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true
| - - - - -### UpdateIDPOIDCConfigResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.min_len: 1
string.max_len: 200
| -| styling_type | zitadel.idp.v1.IDPStylingType | - | enum.defined_only: true
| -| auto_register | bool | - | | - - - - -### UpdateIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateLDAPProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.min_len: 1
string.max_len: 200
| -| host | string | - | string.min_len: 1
string.max_len: 200
| -| port | string | - | string.max_len: 5
| -| tls | bool | - | | -| base_dn | string | - | string.min_len: 1
string.max_len: 200
| -| user_object_class | string | - | string.min_len: 1
string.max_len: 200
| -| user_unique_attribute | string | - | string.min_len: 1
string.max_len: 200
| -| admin | string | - | string.min_len: 1
string.max_len: 200
| -| password | string | - | string.max_len: 200
| -| attributes | zitadel.idp.v1.LDAPAttributes | - | | -| provider_options | zitadel.idp.v1.Options | - | | - - - - -### UpdateLDAPProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateLabelPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| primary_color | string | - | string.max_len: 50
| -| hide_login_name_suffix | bool | - | | -| warn_color | string | - | string.max_len: 50
| -| background_color | string | - | string.max_len: 50
| -| font_color | string | - | string.max_len: 50
| -| primary_color_dark | string | - | string.max_len: 50
| -| background_color_dark | string | - | string.max_len: 50
| -| warn_color_dark | string | - | string.max_len: 50
| -| font_color_dark | string | - | string.max_len: 50
| -| disable_watermark | bool | - | | - - - - -### UpdateLabelPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateLockoutPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| max_password_attempts | uint32 | failed attempts until a user gets locked | | - - - - -### UpdateLockoutPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| allow_username_password | bool | - | | -| allow_register | bool | - | | -| allow_external_idp | bool | - | | -| force_mfa | bool | - | | -| passwordless_type | zitadel.policy.v1.PasswordlessType | - | enum.defined_only: true
| -| hide_password_reset | bool | - | | -| ignore_unknown_usernames | bool | - | | -| default_redirect_uri | string | - | | -| password_check_lifetime | google.protobuf.Duration | - | | -| external_login_check_lifetime | google.protobuf.Duration | - | | -| mfa_init_skip_lifetime | google.protobuf.Duration | - | | -| second_factor_check_lifetime | google.protobuf.Duration | - | | -| multi_factor_check_lifetime | google.protobuf.Duration | - | | -| allow_domain_discovery | bool | If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success. | | -| disable_login_with_email | bool | - | | -| disable_login_with_phone | bool | - | | - - - - -### UpdateLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateNotificationPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| password_change | bool | - | | - - - - -### UpdateNotificationPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateOIDCSettingsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| access_token_lifetime | google.protobuf.Duration | - | | -| id_token_lifetime | google.protobuf.Duration | - | | -| refresh_token_idle_expiration | google.protobuf.Duration | - | | -| refresh_token_expiration | google.protobuf.Duration | - | | - - - - -### UpdateOIDCSettingsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateOrgIAMPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_login_must_be_domain | bool | - | | - - - - -### UpdateOrgIAMPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdatePasswordAgePolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| max_age_days | uint32 | - | | -| expire_warn_days | uint32 | - | | - - - - -### UpdatePasswordAgePolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdatePasswordComplexityPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| min_length | uint32 | - | | -| has_uppercase | bool | - | | -| has_lowercase | bool | - | | -| has_number | bool | - | | -| has_symbol | bool | - | | - - - - -### UpdatePasswordComplexityPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdatePrivacyPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| tos_link | string | - | | -| privacy_link | string | - | | -| help_link | string | - | | - - - - -### UpdatePrivacyPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateSMSProviderTwilioRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| sid | string | - | string.min_len: 1
string.max_len: 200
| -| sender_number | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### UpdateSMSProviderTwilioResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateSMSProviderTwilioTokenRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| token | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### UpdateSMSProviderTwilioTokenResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateSMTPConfigPasswordRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| password | string | - | | - - - - -### UpdateSMTPConfigPasswordResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateSMTPConfigRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| sender_address | string | - | string.min_len: 1
string.max_len: 200
| -| sender_name | string | - | string.min_len: 1
string.max_len: 200
| -| tls | bool | - | | -| host | string | - | string.min_len: 1
string.max_len: 500
| -| user | string | - | | - - - - -### UpdateSMTPConfigResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateSecretGeneratorRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| generator_type | zitadel.settings.v1.SecretGeneratorType | - | enum.defined_only: true
enum.not_in: [0]
| -| length | uint32 | - | | -| expiry | google.protobuf.Duration | - | | -| include_lower_letters | bool | - | | -| include_upper_letters | bool | - | | -| include_digits | bool | - | | -| include_symbols | bool | - | | - - - - -### UpdateSecretGeneratorResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### View - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| database | string | - | | -| view_name | string | - | | -| processed_sequence | uint64 | - | | -| event_timestamp | google.protobuf.Timestamp | The timestamp the event occurred | | -| last_successful_spooler_run | google.protobuf.Timestamp | - | | - - - - - - diff --git a/docs/docs/apis/proto/app.md b/docs/docs/apis/proto/app.md deleted file mode 100644 index bc88cf667..000000000 --- a/docs/docs/apis/proto/app.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -title: zitadel/app.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### APIConfig - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| client_id | string | - | | -| auth_method_type | APIAuthMethodType | - | | - - - - -### App - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| state | AppState | - | | -| name | string | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.oidc_config | OIDCConfig | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.api_config | APIConfig | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.saml_config | SAMLConfig | - | | - - - - -### AppNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### AppQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.name_query | AppNameQuery | - | | - - - - -### OIDCConfig - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| redirect_uris | repeated string | - | | -| response_types | repeated OIDCResponseType | - | | -| grant_types | repeated OIDCGrantType | - | | -| app_type | OIDCAppType | - | | -| client_id | string | - | | -| auth_method_type | OIDCAuthMethodType | - | | -| post_logout_redirect_uris | repeated string | - | | -| version | OIDCVersion | - | | -| none_compliant | bool | - | | -| compliance_problems | repeated zitadel.v1.LocalizedMessage | - | | -| dev_mode | bool | - | | -| access_token_type | OIDCTokenType | - | | -| access_token_role_assertion | bool | - | | -| id_token_role_assertion | bool | - | | -| id_token_userinfo_assertion | bool | - | | -| clock_skew | google.protobuf.Duration | - | | -| additional_origins | repeated string | - | | -| allowed_origins | repeated string | - | | - - - - -### SAMLConfig - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) metadata.metadata_xml | bytes | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) metadata.metadata_url | string | - | | - - - - - - -## Enums - - -### APIAuthMethodType {#apiauthmethodtype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| API_AUTH_METHOD_TYPE_BASIC | 0 | - | -| API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT | 1 | - | - - - - -### AppState {#appstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| APP_STATE_UNSPECIFIED | 0 | - | -| APP_STATE_ACTIVE | 1 | - | -| APP_STATE_INACTIVE | 2 | - | - - - - -### OIDCAppType {#oidcapptype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| OIDC_APP_TYPE_WEB | 0 | - | -| OIDC_APP_TYPE_USER_AGENT | 1 | - | -| OIDC_APP_TYPE_NATIVE | 2 | - | - - - - -### OIDCAuthMethodType {#oidcauthmethodtype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| OIDC_AUTH_METHOD_TYPE_BASIC | 0 | - | -| OIDC_AUTH_METHOD_TYPE_POST | 1 | - | -| OIDC_AUTH_METHOD_TYPE_NONE | 2 | - | -| OIDC_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT | 3 | - | - - - - -### OIDCGrantType {#oidcgranttype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| OIDC_GRANT_TYPE_AUTHORIZATION_CODE | 0 | - | -| OIDC_GRANT_TYPE_IMPLICIT | 1 | - | -| OIDC_GRANT_TYPE_REFRESH_TOKEN | 2 | - | - - - - -### OIDCResponseType {#oidcresponsetype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| OIDC_RESPONSE_TYPE_CODE | 0 | - | -| OIDC_RESPONSE_TYPE_ID_TOKEN | 1 | - | -| OIDC_RESPONSE_TYPE_ID_TOKEN_TOKEN | 2 | - | - - - - -### OIDCTokenType {#oidctokentype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| OIDC_TOKEN_TYPE_BEARER | 0 | - | -| OIDC_TOKEN_TYPE_JWT | 1 | - | - - - - -### OIDCVersion {#oidcversion} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| OIDC_VERSION_1_0 | 0 | - | - - - - diff --git a/docs/docs/apis/proto/auth.md b/docs/docs/apis/proto/auth.md deleted file mode 100644 index 8549fe658..000000000 --- a/docs/docs/apis/proto/auth.md +++ /dev/null @@ -1,1691 +0,0 @@ ---- -title: zitadel/auth.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - -## AuthService {#zitadelauthv1authservice} - - -### Healthz - -> **rpc** Healthz([HealthzRequest](#healthzrequest)) -[HealthzResponse](#healthzresponse) - - - - - - GET: /healthz - - -### GetSupportedLanguages - -> **rpc** GetSupportedLanguages([GetSupportedLanguagesRequest](#getsupportedlanguagesrequest)) -[GetSupportedLanguagesResponse](#getsupportedlanguagesresponse) - -Returns the default languages - - - - GET: /languages - - -### GetMyUser - -> **rpc** GetMyUser([GetMyUserRequest](#getmyuserrequest)) -[GetMyUserResponse](#getmyuserresponse) - -Returns my full blown user - - - - GET: /users/me - - -### RemoveMyUser - -> **rpc** RemoveMyUser([RemoveMyUserRequest](#removemyuserrequest)) -[RemoveMyUserResponse](#removemyuserresponse) - -Changes the user state to deleted - - - - DELETE: /users/me - - -### ListMyUserChanges - -> **rpc** ListMyUserChanges([ListMyUserChangesRequest](#listmyuserchangesrequest)) -[ListMyUserChangesResponse](#listmyuserchangesresponse) - -Returns the history of the authorized user (each event) - - - - POST: /users/me/changes/_search - - -### ListMyUserSessions - -> **rpc** ListMyUserSessions([ListMyUserSessionsRequest](#listmyusersessionsrequest)) -[ListMyUserSessionsResponse](#listmyusersessionsresponse) - -Returns the user sessions of the authorized user of the current useragent - - - - POST: /users/me/sessions/_search - - -### ListMyMetadata - -> **rpc** ListMyMetadata([ListMyMetadataRequest](#listmymetadatarequest)) -[ListMyMetadataResponse](#listmymetadataresponse) - -Returns the user metadata of the authorized user - - - - POST: /users/me/metadata/_search - - -### GetMyMetadata - -> **rpc** GetMyMetadata([GetMyMetadataRequest](#getmymetadatarequest)) -[GetMyMetadataResponse](#getmymetadataresponse) - -Returns the user metadata by key of the authorized user - - - - GET: /users/me/metadata/{key} - - -### ListMyRefreshTokens - -> **rpc** ListMyRefreshTokens([ListMyRefreshTokensRequest](#listmyrefreshtokensrequest)) -[ListMyRefreshTokensResponse](#listmyrefreshtokensresponse) - -Returns the refresh tokens of the authorized user - - - - POST: /users/me/tokens/refresh/_search - - -### RevokeMyRefreshToken - -> **rpc** RevokeMyRefreshToken([RevokeMyRefreshTokenRequest](#revokemyrefreshtokenrequest)) -[RevokeMyRefreshTokenResponse](#revokemyrefreshtokenresponse) - -Revokes a single refresh token of the authorized user by its (token) id - - - - DELETE: /users/me/tokens/refresh/{id} - - -### RevokeAllMyRefreshTokens - -> **rpc** RevokeAllMyRefreshTokens([RevokeAllMyRefreshTokensRequest](#revokeallmyrefreshtokensrequest)) -[RevokeAllMyRefreshTokensResponse](#revokeallmyrefreshtokensresponse) - -Revokes all refresh tokens of the authorized user - - - - POST: /users/me/tokens/refresh/_revoke_all - - -### UpdateMyUserName - -> **rpc** UpdateMyUserName([UpdateMyUserNameRequest](#updatemyusernamerequest)) -[UpdateMyUserNameResponse](#updatemyusernameresponse) - -Change the user name of the authorize user - - - - PUT: /users/me/username - - -### GetMyPasswordComplexityPolicy - -> **rpc** GetMyPasswordComplexityPolicy([GetMyPasswordComplexityPolicyRequest](#getmypasswordcomplexitypolicyrequest)) -[GetMyPasswordComplexityPolicyResponse](#getmypasswordcomplexitypolicyresponse) - -Returns the password complexity policy of my organisation -This policy defines how the password should look - - - - GET: /policies/passwords/complexity - - -### UpdateMyPassword - -> **rpc** UpdateMyPassword([UpdateMyPasswordRequest](#updatemypasswordrequest)) -[UpdateMyPasswordResponse](#updatemypasswordresponse) - -Change the password of the authorized user - - - - PUT: /users/me/password - - -### GetMyProfile - -> **rpc** GetMyProfile([GetMyProfileRequest](#getmyprofilerequest)) -[GetMyProfileResponse](#getmyprofileresponse) - -Returns the profile information of the authorized user - - - - GET: /users/me/profile - - -### UpdateMyProfile - -> **rpc** UpdateMyProfile([UpdateMyProfileRequest](#updatemyprofilerequest)) -[UpdateMyProfileResponse](#updatemyprofileresponse) - -Changes the profile information of the authorized user - - - - PUT: /users/me/profile - - -### GetMyEmail - -> **rpc** GetMyEmail([GetMyEmailRequest](#getmyemailrequest)) -[GetMyEmailResponse](#getmyemailresponse) - -Returns the email address of the authorized user - - - - GET: /users/me/email - - -### SetMyEmail - -> **rpc** SetMyEmail([SetMyEmailRequest](#setmyemailrequest)) -[SetMyEmailResponse](#setmyemailresponse) - -Changes the email address of the authorized user -An email is sent to the given address, to verify it - - - - PUT: /users/me/email - - -### VerifyMyEmail - -> **rpc** VerifyMyEmail([VerifyMyEmailRequest](#verifymyemailrequest)) -[VerifyMyEmailResponse](#verifymyemailresponse) - -Sets the email address to verified - - - - POST: /users/me/email/_verify - - -### ResendMyEmailVerification - -> **rpc** ResendMyEmailVerification([ResendMyEmailVerificationRequest](#resendmyemailverificationrequest)) -[ResendMyEmailVerificationResponse](#resendmyemailverificationresponse) - -Sends a new email to the last given address to verify it - - - - POST: /users/me/email/_resend_verification - - -### GetMyPhone - -> **rpc** GetMyPhone([GetMyPhoneRequest](#getmyphonerequest)) -[GetMyPhoneResponse](#getmyphoneresponse) - -Returns the phone number of the authorized user - - - - GET: /users/me/phone - - -### SetMyPhone - -> **rpc** SetMyPhone([SetMyPhoneRequest](#setmyphonerequest)) -[SetMyPhoneResponse](#setmyphoneresponse) - -Sets the phone number of the authorized user -An sms is sent to the number with a verification code - - - - PUT: /users/me/phone - - -### VerifyMyPhone - -> **rpc** VerifyMyPhone([VerifyMyPhoneRequest](#verifymyphonerequest)) -[VerifyMyPhoneResponse](#verifymyphoneresponse) - -Sets the phone number to verified - - - - POST: /users/me/phone/_verify - - -### ResendMyPhoneVerification - -> **rpc** ResendMyPhoneVerification([ResendMyPhoneVerificationRequest](#resendmyphoneverificationrequest)) -[ResendMyPhoneVerificationResponse](#resendmyphoneverificationresponse) - -Resends a sms to the last given phone number, to verify it - - - - POST: /users/me/phone/_resend_verification - - -### RemoveMyPhone - -> **rpc** RemoveMyPhone([RemoveMyPhoneRequest](#removemyphonerequest)) -[RemoveMyPhoneResponse](#removemyphoneresponse) - -Removed the phone number of the authorized user - - - - DELETE: /users/me/phone - - -### RemoveMyAvatar - -> **rpc** RemoveMyAvatar([RemoveMyAvatarRequest](#removemyavatarrequest)) -[RemoveMyAvatarResponse](#removemyavatarresponse) - -Remove my avatar - - - - DELETE: /users/me/avatar - - -### ListMyLinkedIDPs - -> **rpc** ListMyLinkedIDPs([ListMyLinkedIDPsRequest](#listmylinkedidpsrequest)) -[ListMyLinkedIDPsResponse](#listmylinkedidpsresponse) - -Returns a list of all linked identity providers (social logins, eg. Google, Microsoft, AD, etc.) - - - - POST: /users/me/idps/_search - - -### RemoveMyLinkedIDP - -> **rpc** RemoveMyLinkedIDP([RemoveMyLinkedIDPRequest](#removemylinkedidprequest)) -[RemoveMyLinkedIDPResponse](#removemylinkedidpresponse) - -Removes a linked identity provider (social logins, eg. Google, Microsoft, AD, etc.) - - - - DELETE: /users/me/idps/{idp_id}/{linked_user_id} - - -### ListMyAuthFactors - -> **rpc** ListMyAuthFactors([ListMyAuthFactorsRequest](#listmyauthfactorsrequest)) -[ListMyAuthFactorsResponse](#listmyauthfactorsresponse) - -Returns all configured authentication factors (second and multi) - - - - POST: /users/me/auth_factors/_search - - -### AddMyAuthFactorOTP - -> **rpc** AddMyAuthFactorOTP([AddMyAuthFactorOTPRequest](#addmyauthfactorotprequest)) -[AddMyAuthFactorOTPResponse](#addmyauthfactorotpresponse) - -Adds a new OTP (One Time Password) Second Factor to the authorized user -Only one OTP can be configured per user - - - - POST: /users/me/auth_factors/otp - - -### VerifyMyAuthFactorOTP - -> **rpc** VerifyMyAuthFactorOTP([VerifyMyAuthFactorOTPRequest](#verifymyauthfactorotprequest)) -[VerifyMyAuthFactorOTPResponse](#verifymyauthfactorotpresponse) - -Verify the last added OTP (One Time Password) - - - - POST: /users/me/auth_factors/otp/_verify - - -### RemoveMyAuthFactorOTP - -> **rpc** RemoveMyAuthFactorOTP([RemoveMyAuthFactorOTPRequest](#removemyauthfactorotprequest)) -[RemoveMyAuthFactorOTPResponse](#removemyauthfactorotpresponse) - -Removed the configured OTP (One Time Password) Factor - - - - DELETE: /users/me/auth_factors/otp - - -### AddMyAuthFactorU2F - -> **rpc** AddMyAuthFactorU2F([AddMyAuthFactorU2FRequest](#addmyauthfactoru2frequest)) -[AddMyAuthFactorU2FResponse](#addmyauthfactoru2fresponse) - -Adds a new U2F (Universal Second Factor) to the authorized user -Multiple U2Fs can be configured - - - - POST: /users/me/auth_factors/u2f - - -### VerifyMyAuthFactorU2F - -> **rpc** VerifyMyAuthFactorU2F([VerifyMyAuthFactorU2FRequest](#verifymyauthfactoru2frequest)) -[VerifyMyAuthFactorU2FResponse](#verifymyauthfactoru2fresponse) - -Verifies the last added U2F (Universal Second Factor) of the authorized user - - - - POST: /users/me/auth_factors/u2f/_verify - - -### RemoveMyAuthFactorU2F - -> **rpc** RemoveMyAuthFactorU2F([RemoveMyAuthFactorU2FRequest](#removemyauthfactoru2frequest)) -[RemoveMyAuthFactorU2FResponse](#removemyauthfactoru2fresponse) - -Removes the U2F Authentication from the authorized user - - - - DELETE: /users/me/auth_factors/u2f/{token_id} - - -### ListMyPasswordless - -> **rpc** ListMyPasswordless([ListMyPasswordlessRequest](#listmypasswordlessrequest)) -[ListMyPasswordlessResponse](#listmypasswordlessresponse) - -Returns all configured passwordless authenticators of the authorized user - - - - POST: /users/me/passwordless/_search - - -### AddMyPasswordless - -> **rpc** AddMyPasswordless([AddMyPasswordlessRequest](#addmypasswordlessrequest)) -[AddMyPasswordlessResponse](#addmypasswordlessresponse) - -Adds a new passwordless authenticator to the authorized user -Multiple passwordless authentications can be configured - - - - POST: /users/me/passwordless - - -### AddMyPasswordlessLink - -> **rpc** AddMyPasswordlessLink([AddMyPasswordlessLinkRequest](#addmypasswordlesslinkrequest)) -[AddMyPasswordlessLinkResponse](#addmypasswordlesslinkresponse) - -Adds a new passwordless authenticator link to the authorized user and returns it directly -This link enables the user to register a new device if current passwordless devices are all platform authenticators -e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone - - - - POST: /users/me/passwordless/_link - - -### SendMyPasswordlessLink - -> **rpc** SendMyPasswordlessLink([SendMyPasswordlessLinkRequest](#sendmypasswordlesslinkrequest)) -[SendMyPasswordlessLinkResponse](#sendmypasswordlesslinkresponse) - -Adds a new passwordless authenticator link to the authorized user and sends it to the registered email address -This link enables the user to register a new device if current passwordless devices are all platform authenticators -e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone - - - - POST: /users/me/passwordless/_send_link - - -### VerifyMyPasswordless - -> **rpc** VerifyMyPasswordless([VerifyMyPasswordlessRequest](#verifymypasswordlessrequest)) -[VerifyMyPasswordlessResponse](#verifymypasswordlessresponse) - -Verifies the last added passwordless configuration - - - - POST: /users/me/passwordless/_verify - - -### RemoveMyPasswordless - -> **rpc** RemoveMyPasswordless([RemoveMyPasswordlessRequest](#removemypasswordlessrequest)) -[RemoveMyPasswordlessResponse](#removemypasswordlessresponse) - -Removes the passwordless configuration from the authorized user - - - - DELETE: /users/me/passwordless/{token_id} - - -### ListMyUserGrants - -> **rpc** ListMyUserGrants([ListMyUserGrantsRequest](#listmyusergrantsrequest)) -[ListMyUserGrantsResponse](#listmyusergrantsresponse) - -Returns all user grants (authorizations) of the authorized user - - - - POST: /usergrants/me/_search - - -### ListMyProjectOrgs - -> **rpc** ListMyProjectOrgs([ListMyProjectOrgsRequest](#listmyprojectorgsrequest)) -[ListMyProjectOrgsResponse](#listmyprojectorgsresponse) - -Returns a list of organisations where the authorized user has a user grant (authorization) in the context of the requested project - - - - POST: /global/projectorgs/_search - - -### ListMyZitadelPermissions - -> **rpc** ListMyZitadelPermissions([ListMyZitadelPermissionsRequest](#listmyzitadelpermissionsrequest)) -[ListMyZitadelPermissionsResponse](#listmyzitadelpermissionsresponse) - -Returns the permissions the authorized user has in ZITADEL based on his manager roles (e.g ORG_OWNER) - - - - POST: /permissions/zitadel/me/_search - - -### ListMyProjectPermissions - -> **rpc** ListMyProjectPermissions([ListMyProjectPermissionsRequest](#listmyprojectpermissionsrequest)) -[ListMyProjectPermissionsResponse](#listmyprojectpermissionsresponse) - -Returns a list of roles for the authorized user and project - - - - POST: /permissions/me/_search - - -### ListMyMemberships - -> **rpc** ListMyMemberships([ListMyMembershipsRequest](#listmymembershipsrequest)) -[ListMyMembershipsResponse](#listmymembershipsresponse) - -Show all the permissions my user has in ZITADEL (ZITADEL Manager) -Limit should always be set, there is a default limit set by the service - - - - POST: /memberships/me/_search - - -### GetMyLabelPolicy - -> **rpc** GetMyLabelPolicy([GetMyLabelPolicyRequest](#getmylabelpolicyrequest)) -[GetMyLabelPolicyResponse](#getmylabelpolicyresponse) - -Returns the label policy of the current organisation - - - - GET: /policies/label - - -### GetMyPrivacyPolicy - -> **rpc** GetMyPrivacyPolicy([GetMyPrivacyPolicyRequest](#getmyprivacypolicyrequest)) -[GetMyPrivacyPolicyResponse](#getmyprivacypolicyresponse) - -Returns the privacy policy of the current organisation - - - - GET: /policies/privacy - - -### GetMyLoginPolicy - -> **rpc** GetMyLoginPolicy([GetMyLoginPolicyRequest](#getmyloginpolicyrequest)) -[GetMyLoginPolicyResponse](#getmyloginpolicyresponse) - -Returns the login policy of the current organisation - - - - GET: /policies/login - - - - - - - -## Messages - - -### AddMyAuthFactorOTPRequest -This is an empty request - - - - -### AddMyAuthFactorOTPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| url | string | - | | -| secret | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddMyAuthFactorU2FRequest -This is an empty request - - - - -### AddMyAuthFactorU2FResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | zitadel.user.v1.WebAuthNKey | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddMyPasswordlessLinkRequest -This is an empty request - - - - -### AddMyPasswordlessLinkResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| link | string | - | | -| expiration | google.protobuf.Duration | - | | - - - - -### AddMyPasswordlessRequest -This is an empty request - - - - -### AddMyPasswordlessResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | zitadel.user.v1.WebAuthNKey | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### BulkRemoveMyMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| keys | repeated string | - | repeated.items.string.min_len: 1
repeated.items.string.max_len: 200
| - - - - -### BulkRemoveMyMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### BulkSetMyMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| metadata | repeated BulkSetMyMetadataRequest.Metadata | - | | - - - - -### BulkSetMyMetadataRequest.Metadata - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.min_len: 1
string.max_len: 200
| -| value | bytes | - | bytes.min_len: 1
bytes.max_len: 500000
| - - - - -### BulkSetMyMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### GetMyEmailRequest -This is an empty request - - - - -### GetMyEmailResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| email | zitadel.user.v1.Email | - | | - - - - -### GetMyLabelPolicyRequest -This is an empty request - - - - -### GetMyLabelPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LabelPolicy | - | | - - - - -### GetMyLoginPolicyRequest -This is an empty request - - - - -### GetMyLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LoginPolicy | - | | - - - - -### GetMyMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetMyMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| metadata | zitadel.metadata.v1.Metadata | - | | - - - - -### GetMyPasswordComplexityPolicyRequest -This is an empty request - - - - -### GetMyPasswordComplexityPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.PasswordComplexityPolicy | - | | - - - - -### GetMyPhoneRequest -This is an empty request - - - - -### GetMyPhoneResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| phone | zitadel.user.v1.Phone | - | | - - - - -### GetMyPrivacyPolicyRequest -This is an empty request - - - - -### GetMyPrivacyPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.PrivacyPolicy | - | | - - - - -### GetMyProfileRequest -This is an empty request - - - - -### GetMyProfileResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| profile | zitadel.user.v1.Profile | - | | - - - - -### GetMyUserRequest -This is an empty request -the request parameters are read from the token-header - - - - -### GetMyUserResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user | zitadel.user.v1.User | - | | -| last_login | google.protobuf.Timestamp | - | | - - - - -### GetSupportedLanguagesRequest -This is an empty request - - - - -### GetSupportedLanguagesResponse -This is an empty response - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| languages | repeated string | - | | - - - - -### HealthzRequest -This is an empty request - - - - -### HealthzResponse -This is an empty response - - - - -### ListMyAuthFactorsRequest -This is an empty request - - - - -### ListMyAuthFactorsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.user.v1.AuthFactor | - | | - - - - -### ListMyLinkedIDPsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | - - - - -### ListMyLinkedIDPsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.idp.v1.IDPUserLink | - | | - - - - -### ListMyMembershipsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | the field the result is sorted | | -| queries | repeated zitadel.user.v1.MembershipQuery | criterias the client is looking for | | - - - - -### ListMyMembershipsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.user.v1.Membership | - | | - - - - -### ListMyMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | - | | -| queries | repeated zitadel.metadata.v1.MetadataQuery | - | | - - - - -### ListMyMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.metadata.v1.Metadata | - | | - - - - -### ListMyPasswordlessRequest -This is an empty request - - - - -### ListMyPasswordlessResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.user.v1.WebAuthNToken | - | | - - - - -### ListMyProjectOrgsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.org.v1.OrgQuery | criterias the client is looking for | | - - - - -### ListMyProjectOrgsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.org.v1.Org | - | | - - - - -### ListMyProjectPermissionsRequest -This is an empty request - - - - -### ListMyProjectPermissionsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated string | - | | - - - - -### ListMyRefreshTokensRequest -This is an empty request - - - - -### ListMyRefreshTokensResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.user.v1.RefreshToken | - | | - - - - -### ListMyUserChangesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.change.v1.ChangeQuery | - | | - - - - -### ListMyUserChangesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.change.v1.Change | zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) | | - - - - -### ListMyUserGrantsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | - - - - -### ListMyUserGrantsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated UserGrant | - | | - - - - -### ListMyUserSessionsRequest -This is an empty request - - - - -### ListMyUserSessionsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.user.v1.Session | - | | - - - - -### ListMyZitadelPermissionsRequest -This is an empty request - - - - -### ListMyZitadelPermissionsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated string | - | | - - - - -### RemoveMyAuthFactorOTPRequest -This is an empty request - - - - -### RemoveMyAuthFactorOTPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveMyAuthFactorU2FRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| token_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveMyAuthFactorU2FResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveMyAvatarRequest -This is an empty request - - - - -### RemoveMyAvatarResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveMyLinkedIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| -| linked_user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveMyLinkedIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveMyMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveMyMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveMyPasswordlessRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| token_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveMyPasswordlessResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveMyPhoneRequest -This is an empty request - - - - -### RemoveMyPhoneResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveMyUserRequest -This is an empty request -the request parameters are read from the token-header - - - - -### RemoveMyUserResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResendMyEmailVerificationRequest -This is an empty request - - - - -### ResendMyEmailVerificationResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResendMyPhoneVerificationRequest -This is an empty request - - - - -### ResendMyPhoneVerificationResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RevokeAllMyRefreshTokensRequest -This is an empty request - - - - -### RevokeAllMyRefreshTokensResponse -This is an empty response - - - - -### RevokeMyRefreshTokenRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RevokeMyRefreshTokenResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SendMyPasswordlessLinkRequest -This is an empty request - - - - -### SendMyPasswordlessLinkResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetMyEmailRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| email | string | - | string.email: true
| - - - - -### SetMyEmailResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetMyMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.min_len: 1
string.max_len: 200
| -| value | bytes | - | bytes.min_len: 1
bytes.max_len: 500000
| - - - - -### SetMyMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetMyPhoneRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| phone | string | - | string.min_len: 1
string.max_len: 50
string.prefix: +
| - - - - -### SetMyPhoneResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateMyPasswordRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| old_password | string | - | string.min_len: 1
string.max_bytes: 70
| -| new_password | string | - | string.min_len: 1
string.max_bytes: 70
| - - - - -### UpdateMyPasswordResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateMyProfileRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| first_name | string | - | string.min_len: 1
string.max_len: 200
| -| last_name | string | - | string.min_len: 1
string.max_len: 200
| -| nick_name | string | - | string.max_len: 200
| -| display_name | string | - | string.min_len: 1
string.max_len: 200
| -| preferred_language | string | - | string.max_len: 10
| -| gender | zitadel.user.v1.Gender | - | | - - - - -### UpdateMyProfileResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateMyUserNameRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_name | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### UpdateMyUserNameResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UserGrant - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | | -| project_id | string | - | | -| user_id | string | - | | -| roles | repeated string | - | | -| org_name | string | - | | -| grant_id | string | - | | - - - - -### VerifyMyAuthFactorOTPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| code | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### VerifyMyAuthFactorOTPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### VerifyMyAuthFactorU2FRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| verification | zitadel.user.v1.WebAuthNVerification | - | message.required: true
| - - - - -### VerifyMyAuthFactorU2FResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### VerifyMyEmailRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| code | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### VerifyMyEmailResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### VerifyMyPasswordlessRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| verification | zitadel.user.v1.WebAuthNVerification | - | message.required: true
| - - - - -### VerifyMyPasswordlessResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### VerifyMyPhoneRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| code | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### VerifyMyPhoneResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - - - diff --git a/docs/docs/apis/proto/auth_n_key.md b/docs/docs/apis/proto/auth_n_key.md deleted file mode 100644 index cf33cbf9c..000000000 --- a/docs/docs/apis/proto/auth_n_key.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: zitadel/auth_n_key.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### Key - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| type | KeyType | - | | -| expiration_date | google.protobuf.Timestamp | - | | - - - - - - -## Enums - - -### KeyType {#keytype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| KEY_TYPE_UNSPECIFIED | 0 | - | -| KEY_TYPE_JSON | 1 | - | - - - - diff --git a/docs/docs/apis/proto/change.md b/docs/docs/apis/proto/change.md deleted file mode 100644 index f7d02a269..000000000 --- a/docs/docs/apis/proto/change.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: zitadel/change.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### Change - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| change_date | google.protobuf.Timestamp | - | | -| event_type | zitadel.v1.LocalizedMessage | - | | -| sequence | uint64 | - | | -| editor_id | string | - | | -| editor_display_name | string | - | | -| resource_owner_id | string | - | | -| editor_preferred_login_name | string | - | | -| editor_avatar_url | string | - | | - - - - -### ChangeQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| sequence | uint64 | sequence represents the order of events. It's always upcounting | | -| limit | uint32 | - | | -| asc | bool | - | | - - - - - - diff --git a/docs/docs/apis/proto/event.md b/docs/docs/apis/proto/event.md deleted file mode 100644 index 1df23c2df..000000000 --- a/docs/docs/apis/proto/event.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: zitadel/event.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### Aggregate - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| type | AggregateType | - | | -| resource_owner | string | - | | - - - - -### AggregateType - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | string | - | | -| localized | zitadel.v1.LocalizedMessage | - | | - - - - -### Editor - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | | -| display_name | string | - | | -| service | string | - | | - - - - -### Event - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| editor | Editor | - | | -| aggregate | Aggregate | - | | -| sequence | uint64 | - | | -| creation_date | google.protobuf.Timestamp | The timestamp the event occurred | | -| payload | google.protobuf.Struct | - | | -| type | EventType | - | | - - - - -### EventType - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | string | - | | -| localized | zitadel.v1.LocalizedMessage | - | | - - - - - - diff --git a/docs/docs/apis/proto/idp.md b/docs/docs/apis/proto/idp.md deleted file mode 100644 index 227950218..000000000 --- a/docs/docs/apis/proto/idp.md +++ /dev/null @@ -1,315 +0,0 @@ ---- -title: zitadel/idp.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### GoogleConfig - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| client_id | string | - | | -| scopes | repeated string | - | | - - - - -### IDP - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| state | IDPState | - | | -| name | string | - | | -| styling_type | IDPStylingType | - | | -| owner | IDPOwnerType | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.oidc_config | OIDCConfig | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.jwt_config | JWTConfig | - | | -| auto_register | bool | - | | - - - - -### IDPIDQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.max_len: 200
| - - - - -### IDPLoginPolicyLink - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | | -| idp_name | string | - | | -| idp_type | IDPType | - | | - - - - -### IDPNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### IDPOwnerTypeQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| owner_type | IDPOwnerType | - | enum.defined_only: true
| - - - - -### IDPUserLink - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | | -| idp_id | string | - | | -| idp_name | string | - | | -| provided_user_id | string | - | | -| provided_user_name | string | - | | -| idp_type | IDPType | - | | - - - - -### JWTConfig - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| jwt_endpoint | string | - | string.min_len: 1
string.max_len: 200
| -| issuer | string | - | string.min_len: 1
string.max_len: 200
| -| keys_endpoint | string | - | string.min_len: 1
string.max_len: 200
| -| header_name | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### LDAPAttributes - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id_attribute | string | - | string.max_len: 200
| -| first_name_attribute | string | - | string.max_len: 200
| -| last_name_attribute | string | - | string.max_len: 200
| -| display_name_attribute | string | - | string.max_len: 200
| -| nick_name_attribute | string | - | string.max_len: 200
| -| preferred_username_attribute | string | - | string.max_len: 200
| -| email_attribute | string | - | string.max_len: 200
| -| email_verified_attribute | string | - | string.max_len: 200
| -| phone_attribute | string | - | string.max_len: 200
| -| phone_verified_attribute | string | - | string.max_len: 200
| -| preferred_language_attribute | string | - | string.max_len: 200
| -| avatar_url_attribute | string | - | string.max_len: 200
| -| profile_attribute | string | - | string.max_len: 200
| - - - - -### LDAPConfig - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| host | string | - | | -| port | string | - | | -| tls | bool | - | | -| base_dn | string | - | | -| user_object_class | string | - | | -| user_unique_attribute | string | - | | -| admin | string | - | | -| attributes | LDAPAttributes | - | | -| provider_options | Options | - | | - - - - -### OIDCConfig - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| client_id | string | - | | -| issuer | string | - | | -| scopes | repeated string | - | | -| display_name_mapping | OIDCMappingField | - | | -| username_mapping | OIDCMappingField | - | | - - - - -### Options - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| is_linking_allowed | bool | - | | -| is_creation_allowed | bool | - | | -| is_auto_creation | bool | - | | -| is_auto_update | bool | - | | - - - - -### Provider - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| state | IDPState | - | | -| name | string | - | | -| owner | IDPOwnerType | - | | -| type | ProviderType | - | | -| config | ProviderConfig | - | | - - - - -### ProviderConfig - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| options | Options | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.ldap | LDAPConfig | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.google | GoogleConfig | - | | - - - - - - -## Enums - - -### IDPFieldName {#idpfieldname} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| IDP_FIELD_NAME_UNSPECIFIED | 0 | - | -| IDP_FIELD_NAME_NAME | 1 | - | - - - - -### IDPOwnerType {#idpownertype} -the owner of the identity provider. - -| Name | Number | Description | -| ---- | ------ | ----------- | -| IDP_OWNER_TYPE_UNSPECIFIED | 0 | - | -| IDP_OWNER_TYPE_SYSTEM | 1 | system is managed by the ZITADEL administrators | -| IDP_OWNER_TYPE_ORG | 2 | org is managed by de organisation administrators | - - - - -### IDPState {#idpstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| IDP_STATE_UNSPECIFIED | 0 | - | -| IDP_STATE_ACTIVE | 1 | - | -| IDP_STATE_INACTIVE | 2 | - | - - - - -### IDPStylingType {#idpstylingtype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| STYLING_TYPE_UNSPECIFIED | 0 | - | -| STYLING_TYPE_GOOGLE | 1 | - | - - - - -### IDPType {#idptype} -authorization framework of the identity provider - -| Name | Number | Description | -| ---- | ------ | ----------- | -| IDP_TYPE_UNSPECIFIED | 0 | - | -| IDP_TYPE_OIDC | 1 | - | -| IDP_TYPE_JWT | 3 | PLANNED: IDP_TYPE_SAML | - - - - -### OIDCMappingField {#oidcmappingfield} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| OIDC_MAPPING_FIELD_UNSPECIFIED | 0 | - | -| OIDC_MAPPING_FIELD_PREFERRED_USERNAME | 1 | - | -| OIDC_MAPPING_FIELD_EMAIL | 2 | - | - - - - -### ProviderType {#providertype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| PROVIDER_TYPE_UNSPECIFIED | 0 | - | -| PROVIDER_TYPE_OIDC | 1 | - | -| PROVIDER_TYPE_JWT | 2 | - | -| PROVIDER_TYPE_LDAP | 3 | - | -| PROVIDER_TYPE_OAUTH | 4 | - | -| PROVIDER_TYPE_AZURE_AD | 5 | - | -| PROVIDER_TYPE_GITHUB | 6 | - | -| PROVIDER_TYPE_GITHUB_EE | 7 | - | -| PROVIDER_TYPE_GITLAB | 8 | - | -| PROVIDER_TYPE_GITLAB_SELF_HOSTED | 9 | - | -| PROVIDER_TYPE_GOOGLE | 10 | - | - - - - diff --git a/docs/docs/apis/proto/instance.md b/docs/docs/apis/proto/instance.md deleted file mode 100644 index d024ed645..000000000 --- a/docs/docs/apis/proto/instance.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -title: zitadel/instance.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### Domain - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| domain | string | - | | -| primary | bool | - | | -| generated | bool | - | | - - - - -### DomainGeneratedQuery -DomainGeneratedQuery is always equals - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| generated | bool | - | | - - - - -### DomainPrimaryQuery -DomainPrimaryQuery is always equals - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| primary | bool | - | | - - - - -### DomainQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| domain | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### DomainSearchQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.domain_query | DomainQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.generated_query | DomainGeneratedQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.primary_query | DomainPrimaryQuery | - | | - - - - -### IdsQuery -IdQuery is always equals - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| ids | repeated string | - | | - - - - -### Instance - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| state | State | - | | -| name | string | - | | -| version | string | - | | -| domains | repeated Domain | - | | - - - - -### InstanceDetail - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| state | State | - | | -| name | string | - | | -| version | string | - | | -| domains | repeated Domain | - | | - - - - -### Query - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.id_query | IdsQuery | - | | - - - - - - -## Enums - - -### DomainFieldName {#domainfieldname} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| DOMAIN_FIELD_NAME_UNSPECIFIED | 0 | - | -| DOMAIN_FIELD_NAME_DOMAIN | 1 | - | -| DOMAIN_FIELD_NAME_PRIMARY | 2 | - | -| DOMAIN_FIELD_NAME_GENERATED | 3 | - | -| DOMAIN_FIELD_NAME_CREATION_DATE | 4 | - | - - - - -### FieldName {#fieldname} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| FIELD_NAME_UNSPECIFIED | 0 | - | -| FIELD_NAME_ID | 1 | - | -| FIELD_NAME_NAME | 2 | - | -| FIELD_NAME_CREATION_DATE | 3 | - | - - - - -### State {#state} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| STATE_UNSPECIFIED | 0 | - | -| STATE_CREATING | 1 | - | -| STATE_RUNNING | 2 | - | -| STATE_STOPPING | 3 | - | -| STATE_STOPPED | 4 | - | - - - - diff --git a/docs/docs/apis/proto/management.md b/docs/docs/apis/proto/management.md deleted file mode 100644 index 2c93a965d..000000000 --- a/docs/docs/apis/proto/management.md +++ /dev/null @@ -1,9455 +0,0 @@ ---- -title: zitadel/management.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - -## ManagementService {#zitadelmanagementv1managementservice} - - -### Healthz - -> **rpc** Healthz([HealthzRequest](#healthzrequest)) -[HealthzResponse](#healthzresponse) - - - - - - GET: /healthz - - -### GetOIDCInformation - -> **rpc** GetOIDCInformation([GetOIDCInformationRequest](#getoidcinformationrequest)) -[GetOIDCInformationResponse](#getoidcinformationresponse) - - - - - - GET: /zitadel/docs - - -### GetIAM - -> **rpc** GetIAM([GetIAMRequest](#getiamrequest)) -[GetIAMResponse](#getiamresponse) - -Returns some needed settings of the IAM (Global Organisation ID, Zitadel Project ID) - - - - GET: /iam - - -### GetSupportedLanguages - -> **rpc** GetSupportedLanguages([GetSupportedLanguagesRequest](#getsupportedlanguagesrequest)) -[GetSupportedLanguagesResponse](#getsupportedlanguagesresponse) - -Returns the default languages - - - - GET: /languages - - -### GetUserByID - -> **rpc** GetUserByID([GetUserByIDRequest](#getuserbyidrequest)) -[GetUserByIDResponse](#getuserbyidresponse) - -Returns the requested full blown user (human or machine) - - - - GET: /users/{id} - - -### GetUserByLoginNameGlobal - -> **rpc** GetUserByLoginNameGlobal([GetUserByLoginNameGlobalRequest](#getuserbyloginnameglobalrequest)) -[GetUserByLoginNameGlobalResponse](#getuserbyloginnameglobalresponse) - -Searches a user over all organisations -the login name has to match exactly - - - - GET: /global/users/_by_login_name - - -### ListUsers - -> **rpc** ListUsers([ListUsersRequest](#listusersrequest)) -[ListUsersResponse](#listusersresponse) - -Return the users matching the query -Limit should always be set, there is a default limit set by the service - - - - POST: /users/_search - - -### ListUserChanges - -> **rpc** ListUserChanges([ListUserChangesRequest](#listuserchangesrequest)) -[ListUserChangesResponse](#listuserchangesresponse) - -Returns the history of the user (each event) -Limit should always be set, there is a default limit set by the service - - - - POST: /users/{user_id}/changes/_search - - -### IsUserUnique - -> **rpc** IsUserUnique([IsUserUniqueRequest](#isuseruniquerequest)) -[IsUserUniqueResponse](#isuseruniqueresponse) - -Returns if a user with the searched email or username is unique - - - - GET: /users/_is_unique - - -### AddHumanUser - -> **rpc** AddHumanUser([AddHumanUserRequest](#addhumanuserrequest)) -[AddHumanUserResponse](#addhumanuserresponse) - -Create a user of the type human -A email will be sent to the user if email is not verified or no password is set -If a password is given, the user has to change on the next login - - - - POST: /users/human - - -### ImportHumanUser - -> **rpc** ImportHumanUser([ImportHumanUserRequest](#importhumanuserrequest)) -[ImportHumanUserResponse](#importhumanuserresponse) - -Create a user of the type human -A email will be sent to the user if email is not verified or no password is set -If a password is given, the user doesn't have to change on the next login - - - - POST: /users/human/_import - - -### AddMachineUser - -> **rpc** AddMachineUser([AddMachineUserRequest](#addmachineuserrequest)) -[AddMachineUserResponse](#addmachineuserresponse) - -Create a user of the type machine - - - - POST: /users/machine - - -### DeactivateUser - -> **rpc** DeactivateUser([DeactivateUserRequest](#deactivateuserrequest)) -[DeactivateUserResponse](#deactivateuserresponse) - -Changes the user state to deactivated -The user will not be able to login -returns an error if user state is already deactivated - - - - POST: /users/{id}/_deactivate - - -### ReactivateUser - -> **rpc** ReactivateUser([ReactivateUserRequest](#reactivateuserrequest)) -[ReactivateUserResponse](#reactivateuserresponse) - -Changes the user state to active -returns an error if user state is not deactivated - - - - POST: /users/{id}/_reactivate - - -### LockUser - -> **rpc** LockUser([LockUserRequest](#lockuserrequest)) -[LockUserResponse](#lockuserresponse) - -Changes the user state to deactivated -The user will not be able to login -returns an error if user state is already locked - - - - POST: /users/{id}/_lock - - -### UnlockUser - -> **rpc** UnlockUser([UnlockUserRequest](#unlockuserrequest)) -[UnlockUserResponse](#unlockuserresponse) - -Changes the user state to active -returns an error if user state is not locked - - - - POST: /users/{id}/_unlock - - -### RemoveUser - -> **rpc** RemoveUser([RemoveUserRequest](#removeuserrequest)) -[RemoveUserResponse](#removeuserresponse) - -Changes the user state to deleted - - - - DELETE: /users/{id} - - -### UpdateUserName - -> **rpc** UpdateUserName([UpdateUserNameRequest](#updateusernamerequest)) -[UpdateUserNameResponse](#updateusernameresponse) - -Changes the username - - - - PUT: /users/{user_id}/username - - -### SetUserMetadata - -> **rpc** SetUserMetadata([SetUserMetadataRequest](#setusermetadatarequest)) -[SetUserMetadataResponse](#setusermetadataresponse) - -Sets a user metadata by key - - - - POST: /users/{id}/metadata/{key} - - -### BulkSetUserMetadata - -> **rpc** BulkSetUserMetadata([BulkSetUserMetadataRequest](#bulksetusermetadatarequest)) -[BulkSetUserMetadataResponse](#bulksetusermetadataresponse) - -Set a list of user metadata - - - - POST: /users/{id}/metadata/_bulk - - -### ListUserMetadata - -> **rpc** ListUserMetadata([ListUserMetadataRequest](#listusermetadatarequest)) -[ListUserMetadataResponse](#listusermetadataresponse) - -Returns the user metadata - - - - POST: /users/{id}/metadata/_search - - -### GetUserMetadata - -> **rpc** GetUserMetadata([GetUserMetadataRequest](#getusermetadatarequest)) -[GetUserMetadataResponse](#getusermetadataresponse) - -Returns the user metadata by key - - - - GET: /users/{id}/metadata/{key} - - -### RemoveUserMetadata - -> **rpc** RemoveUserMetadata([RemoveUserMetadataRequest](#removeusermetadatarequest)) -[RemoveUserMetadataResponse](#removeusermetadataresponse) - -Removes a user metadata by key - - - - DELETE: /users/{id}/metadata/{key} - - -### BulkRemoveUserMetadata - -> **rpc** BulkRemoveUserMetadata([BulkRemoveUserMetadataRequest](#bulkremoveusermetadatarequest)) -[BulkRemoveUserMetadataResponse](#bulkremoveusermetadataresponse) - -Set a list of user metadata - - - - DELETE: /users/{id}/metadata/_bulk - - -### GetHumanProfile - -> **rpc** GetHumanProfile([GetHumanProfileRequest](#gethumanprofilerequest)) -[GetHumanProfileResponse](#gethumanprofileresponse) - -Returns the profile of the human - - - - GET: /users/{user_id}/profile - - -### UpdateHumanProfile - -> **rpc** UpdateHumanProfile([UpdateHumanProfileRequest](#updatehumanprofilerequest)) -[UpdateHumanProfileResponse](#updatehumanprofileresponse) - -Changes the profile of the human - - - - PUT: /users/{user_id}/profile - - -### GetHumanEmail - -> **rpc** GetHumanEmail([GetHumanEmailRequest](#gethumanemailrequest)) -[GetHumanEmailResponse](#gethumanemailresponse) - -GetHumanEmail returns the email and verified state of the human - - - - GET: /users/{user_id}/email - - -### UpdateHumanEmail - -> **rpc** UpdateHumanEmail([UpdateHumanEmailRequest](#updatehumanemailrequest)) -[UpdateHumanEmailResponse](#updatehumanemailresponse) - -Changes the email of the human -If state is not verified, the user will get a verification email - - - - PUT: /users/{user_id}/email - - -### ResendHumanInitialization - -> **rpc** ResendHumanInitialization([ResendHumanInitializationRequest](#resendhumaninitializationrequest)) -[ResendHumanInitializationResponse](#resendhumaninitializationresponse) - -Resends an email to the given email address to finish the initialization process of the user -Changes the email address of the user if it is provided - - - - POST: /users/{user_id}/_resend_initialization - - -### ResendHumanEmailVerification - -> **rpc** ResendHumanEmailVerification([ResendHumanEmailVerificationRequest](#resendhumanemailverificationrequest)) -[ResendHumanEmailVerificationResponse](#resendhumanemailverificationresponse) - -Resends an email to the given email address to finish the email verification process of the user - - - - POST: /users/{user_id}/email/_resend_verification - - -### GetHumanPhone - -> **rpc** GetHumanPhone([GetHumanPhoneRequest](#gethumanphonerequest)) -[GetHumanPhoneResponse](#gethumanphoneresponse) - -Returns the phone and verified state of the human phone - - - - GET: /users/{user_id}/phone - - -### UpdateHumanPhone - -> **rpc** UpdateHumanPhone([UpdateHumanPhoneRequest](#updatehumanphonerequest)) -[UpdateHumanPhoneResponse](#updatehumanphoneresponse) - -Changes the phone number -If verified is not set, the user will get an sms to verify the number - - - - PUT: /users/{user_id}/phone - - -### RemoveHumanPhone - -> **rpc** RemoveHumanPhone([RemoveHumanPhoneRequest](#removehumanphonerequest)) -[RemoveHumanPhoneResponse](#removehumanphoneresponse) - -Removes the phone number of the human - - - - DELETE: /users/{user_id}/phone - - -### ResendHumanPhoneVerification - -> **rpc** ResendHumanPhoneVerification([ResendHumanPhoneVerificationRequest](#resendhumanphoneverificationrequest)) -[ResendHumanPhoneVerificationResponse](#resendhumanphoneverificationresponse) - -An sms will be sent to the given phone number to finish the phone verification process of the user - - - - POST: /users/{user_id}/phone/_resend_verification - - -### RemoveHumanAvatar - -> **rpc** RemoveHumanAvatar([RemoveHumanAvatarRequest](#removehumanavatarrequest)) -[RemoveHumanAvatarResponse](#removehumanavatarresponse) - -Removes the avatar number of the human - - - - DELETE: /users/{user_id}/avatar - - -### SetHumanInitialPassword - -> **rpc** SetHumanInitialPassword([SetHumanInitialPasswordRequest](#sethumaninitialpasswordrequest)) -[SetHumanInitialPasswordResponse](#sethumaninitialpasswordresponse) - -deprecated: use SetHumanPassword - - - - POST: /users/{user_id}/password/_initialize - - -### SetHumanPassword - -> **rpc** SetHumanPassword([SetHumanPasswordRequest](#sethumanpasswordrequest)) -[SetHumanPasswordResponse](#sethumanpasswordresponse) - -Set a new password for a user, on default the user has to change the password on the next login -Set no_change_required to true if the user does not have to change the password on the next login - - - - POST: /users/{user_id}/password - - -### SendHumanResetPasswordNotification - -> **rpc** SendHumanResetPasswordNotification([SendHumanResetPasswordNotificationRequest](#sendhumanresetpasswordnotificationrequest)) -[SendHumanResetPasswordNotificationResponse](#sendhumanresetpasswordnotificationresponse) - -An email will be sent to the given address to reset the password of the user - - - - POST: /users/{user_id}/password/_reset - - -### ListHumanAuthFactors - -> **rpc** ListHumanAuthFactors([ListHumanAuthFactorsRequest](#listhumanauthfactorsrequest)) -[ListHumanAuthFactorsResponse](#listhumanauthfactorsresponse) - -Returns a list of all factors (second and multi) which are configured on the user - - - - POST: /users/{user_id}/auth_factors/_search - - -### RemoveHumanAuthFactorOTP - -> **rpc** RemoveHumanAuthFactorOTP([RemoveHumanAuthFactorOTPRequest](#removehumanauthfactorotprequest)) -[RemoveHumanAuthFactorOTPResponse](#removehumanauthfactorotpresponse) - -The otp second factor will be removed from the user -Because only one otp can be configured per user, the configured one will be removed - - - - DELETE: /users/{user_id}/auth_factors/otp - - -### RemoveHumanAuthFactorU2F - -> **rpc** RemoveHumanAuthFactorU2F([RemoveHumanAuthFactorU2FRequest](#removehumanauthfactoru2frequest)) -[RemoveHumanAuthFactorU2FResponse](#removehumanauthfactoru2fresponse) - -The u2f (universial second factor) will be removed from the user - - - - DELETE: /users/{user_id}/auth_factors/u2f/{token_id} - - -### ListHumanPasswordless - -> **rpc** ListHumanPasswordless([ListHumanPasswordlessRequest](#listhumanpasswordlessrequest)) -[ListHumanPasswordlessResponse](#listhumanpasswordlessresponse) - -Returns all configured passwordless authenticators - - - - POST: /users/{user_id}/passwordless/_search - - -### AddPasswordlessRegistration - -> **rpc** AddPasswordlessRegistration([AddPasswordlessRegistrationRequest](#addpasswordlessregistrationrequest)) -[AddPasswordlessRegistrationResponse](#addpasswordlessregistrationresponse) - -Adds a new passwordless authenticator link to the user and returns it directly -This link enables the user to register a new device if current passwordless devices are all platform authenticators -e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone - - - - POST: /users/{user_id}/passwordless/_link - - -### SendPasswordlessRegistration - -> **rpc** SendPasswordlessRegistration([SendPasswordlessRegistrationRequest](#sendpasswordlessregistrationrequest)) -[SendPasswordlessRegistrationResponse](#sendpasswordlessregistrationresponse) - -Adds a new passwordless authenticator link to the user and sends it to the registered email address -This link enables the user to register a new device if current passwordless devices are all platform authenticators -e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone - - - - POST: /users/{user_id}/passwordless/_send_link - - -### RemoveHumanPasswordless - -> **rpc** RemoveHumanPasswordless([RemoveHumanPasswordlessRequest](#removehumanpasswordlessrequest)) -[RemoveHumanPasswordlessResponse](#removehumanpasswordlessresponse) - -Removed a configured passwordless authenticator - - - - DELETE: /users/{user_id}/passwordless/{token_id} - - -### UpdateMachine - -> **rpc** UpdateMachine([UpdateMachineRequest](#updatemachinerequest)) -[UpdateMachineResponse](#updatemachineresponse) - -Changes a machine user - - - - PUT: /users/{user_id}/machine - - -### GenerateMachineSecret - -> **rpc** GenerateMachineSecret([GenerateMachineSecretRequest](#generatemachinesecretrequest)) -[GenerateMachineSecretResponse](#generatemachinesecretresponse) - -Generates and sets a new machine secret - - - - PUT: /users/{user_id}/secret - - -### RemoveMachineSecret - -> **rpc** RemoveMachineSecret([RemoveMachineSecretRequest](#removemachinesecretrequest)) -[RemoveMachineSecretResponse](#removemachinesecretresponse) - -Removes the machine secret - - - - DELETE: /users/{user_id}/secret - - -### GetMachineKeyByIDs - -> **rpc** GetMachineKeyByIDs([GetMachineKeyByIDsRequest](#getmachinekeybyidsrequest)) -[GetMachineKeyByIDsResponse](#getmachinekeybyidsresponse) - -Returns a machine key of a (machine) user - - - - GET: /users/{user_id}/keys/{key_id} - - -### ListMachineKeys - -> **rpc** ListMachineKeys([ListMachineKeysRequest](#listmachinekeysrequest)) -[ListMachineKeysResponse](#listmachinekeysresponse) - -Returns all machine keys of a (machine) user which match the query -Limit should always be set, there is a default limit set by the service - - - - POST: /users/{user_id}/keys/_search - - -### AddMachineKey - -> **rpc** AddMachineKey([AddMachineKeyRequest](#addmachinekeyrequest)) -[AddMachineKeyResponse](#addmachinekeyresponse) - -Generates a new machine key, details should be stored after return - - - - POST: /users/{user_id}/keys - - -### RemoveMachineKey - -> **rpc** RemoveMachineKey([RemoveMachineKeyRequest](#removemachinekeyrequest)) -[RemoveMachineKeyResponse](#removemachinekeyresponse) - -Removes a machine key - - - - DELETE: /users/{user_id}/keys/{key_id} - - -### GetPersonalAccessTokenByIDs - -> **rpc** GetPersonalAccessTokenByIDs([GetPersonalAccessTokenByIDsRequest](#getpersonalaccesstokenbyidsrequest)) -[GetPersonalAccessTokenByIDsResponse](#getpersonalaccesstokenbyidsresponse) - -Returns a personal access token of a (machine) user - - - - GET: /users/{user_id}/pats/{token_id} - - -### ListPersonalAccessTokens - -> **rpc** ListPersonalAccessTokens([ListPersonalAccessTokensRequest](#listpersonalaccesstokensrequest)) -[ListPersonalAccessTokensResponse](#listpersonalaccesstokensresponse) - -Returns all personal access tokens of a (machine) user which match the query -Limit should always be set, there is a default limit set by the service - - - - POST: /users/{user_id}/pats/_search - - -### AddPersonalAccessToken - -> **rpc** AddPersonalAccessToken([AddPersonalAccessTokenRequest](#addpersonalaccesstokenrequest)) -[AddPersonalAccessTokenResponse](#addpersonalaccesstokenresponse) - -Generates a new personal access token for a machine user, details should be stored after return - - - - POST: /users/{user_id}/pats - - -### RemovePersonalAccessToken - -> **rpc** RemovePersonalAccessToken([RemovePersonalAccessTokenRequest](#removepersonalaccesstokenrequest)) -[RemovePersonalAccessTokenResponse](#removepersonalaccesstokenresponse) - -Removes a personal access token - - - - DELETE: /users/{user_id}/pats/{token_id} - - -### ListHumanLinkedIDPs - -> **rpc** ListHumanLinkedIDPs([ListHumanLinkedIDPsRequest](#listhumanlinkedidpsrequest)) -[ListHumanLinkedIDPsResponse](#listhumanlinkedidpsresponse) - -Lists all identity providers (social logins) which a human has configured (e.g Google, Microsoft, AD, etc..) -Limit should always be set, there is a default limit set by the service - - - - POST: /users/{user_id}/idps/_search - - -### RemoveHumanLinkedIDP - -> **rpc** RemoveHumanLinkedIDP([RemoveHumanLinkedIDPRequest](#removehumanlinkedidprequest)) -[RemoveHumanLinkedIDPResponse](#removehumanlinkedidpresponse) - -Removed a configured identity provider (social login) of a human - - - - DELETE: /users/{user_id}/idps/{idp_id}/{linked_user_id} - - -### ListUserMemberships - -> **rpc** ListUserMemberships([ListUserMembershipsRequest](#listusermembershipsrequest)) -[ListUserMembershipsResponse](#listusermembershipsresponse) - -Show all the permissions a user has iin ZITADEL (ZITADEL Manager) -Limit should always be set, there is a default limit set by the service - - - - POST: /users/{user_id}/memberships/_search - - -### GetMyOrg - -> **rpc** GetMyOrg([GetMyOrgRequest](#getmyorgrequest)) -[GetMyOrgResponse](#getmyorgresponse) - -Returns the org given in the header - - - - GET: /orgs/me - - -### GetOrgByDomainGlobal - -> **rpc** GetOrgByDomainGlobal([GetOrgByDomainGlobalRequest](#getorgbydomainglobalrequest)) -[GetOrgByDomainGlobalResponse](#getorgbydomainglobalresponse) - -Search a org over all organisations -Domain must match exactly - - - - GET: /global/orgs/_by_domain - - -### ListOrgChanges - -> **rpc** ListOrgChanges([ListOrgChangesRequest](#listorgchangesrequest)) -[ListOrgChangesResponse](#listorgchangesresponse) - -Returns the history of my organisation (each event) -Limit should always be set, there is a default limit set by the service - - - - POST: /orgs/me/changes/_search - - -### AddOrg - -> **rpc** AddOrg([AddOrgRequest](#addorgrequest)) -[AddOrgResponse](#addorgresponse) - -Creates a new organisation - - - - POST: /orgs - - -### UpdateOrg - -> **rpc** UpdateOrg([UpdateOrgRequest](#updateorgrequest)) -[UpdateOrgResponse](#updateorgresponse) - -Changes my organisation - - - - PUT: /orgs/me - - -### DeactivateOrg - -> **rpc** DeactivateOrg([DeactivateOrgRequest](#deactivateorgrequest)) -[DeactivateOrgResponse](#deactivateorgresponse) - -Sets the state of my organisation to deactivated -Users of this organisation will not be able login - - - - POST: /orgs/me/_deactivate - - -### ReactivateOrg - -> **rpc** ReactivateOrg([ReactivateOrgRequest](#reactivateorgrequest)) -[ReactivateOrgResponse](#reactivateorgresponse) - -Sets the state of my organisation to active - - - - POST: /orgs/me/_reactivate - - -### RemoveOrg - -> **rpc** RemoveOrg([RemoveOrgRequest](#removeorgrequest)) -[RemoveOrgResponse](#removeorgresponse) - -Sets the state of my organisation and all its resource (Users, Projects, Grants to and from the org) to removed -Users of this organisation will not be able login - - - - DELETE: /orgs/me - - -### SetOrgMetadata - -> **rpc** SetOrgMetadata([SetOrgMetadataRequest](#setorgmetadatarequest)) -[SetOrgMetadataResponse](#setorgmetadataresponse) - -Sets a org metadata by key - - - - POST: /metadata/{key} - - -### BulkSetOrgMetadata - -> **rpc** BulkSetOrgMetadata([BulkSetOrgMetadataRequest](#bulksetorgmetadatarequest)) -[BulkSetOrgMetadataResponse](#bulksetorgmetadataresponse) - -Set a list of org metadata - - - - POST: /metadata/_bulk - - -### ListOrgMetadata - -> **rpc** ListOrgMetadata([ListOrgMetadataRequest](#listorgmetadatarequest)) -[ListOrgMetadataResponse](#listorgmetadataresponse) - -Returns the org metadata - - - - POST: /metadata/_search - - -### GetOrgMetadata - -> **rpc** GetOrgMetadata([GetOrgMetadataRequest](#getorgmetadatarequest)) -[GetOrgMetadataResponse](#getorgmetadataresponse) - -Returns the org metadata by key - - - - GET: /metadata/{key} - - -### RemoveOrgMetadata - -> **rpc** RemoveOrgMetadata([RemoveOrgMetadataRequest](#removeorgmetadatarequest)) -[RemoveOrgMetadataResponse](#removeorgmetadataresponse) - -Removes a org metadata by key - - - - DELETE: /metadata/{key} - - -### BulkRemoveOrgMetadata - -> **rpc** BulkRemoveOrgMetadata([BulkRemoveOrgMetadataRequest](#bulkremoveorgmetadatarequest)) -[BulkRemoveOrgMetadataResponse](#bulkremoveorgmetadataresponse) - -Set a list of org metadata - - - - DELETE: /metadata/_bulk - - -### ListOrgDomains - -> **rpc** ListOrgDomains([ListOrgDomainsRequest](#listorgdomainsrequest)) -[ListOrgDomainsResponse](#listorgdomainsresponse) - -Returns all registered domains of my organisation -Limit should always be set, there is a default limit set by the service - - - - POST: /orgs/me/domains/_search - - -### AddOrgDomain - -> **rpc** AddOrgDomain([AddOrgDomainRequest](#addorgdomainrequest)) -[AddOrgDomainResponse](#addorgdomainresponse) - -Adds a new domain to my organisation - - - - POST: /orgs/me/domains - - -### RemoveOrgDomain - -> **rpc** RemoveOrgDomain([RemoveOrgDomainRequest](#removeorgdomainrequest)) -[RemoveOrgDomainResponse](#removeorgdomainresponse) - -Removed the domain from my organisation - - - - DELETE: /orgs/me/domains/{domain} - - -### GenerateOrgDomainValidation - -> **rpc** GenerateOrgDomainValidation([GenerateOrgDomainValidationRequest](#generateorgdomainvalidationrequest)) -[GenerateOrgDomainValidationResponse](#generateorgdomainvalidationresponse) - -Generates a new file to validate you domain - - - - POST: /orgs/me/domains/{domain}/validation/_generate - - -### ValidateOrgDomain - -> **rpc** ValidateOrgDomain([ValidateOrgDomainRequest](#validateorgdomainrequest)) -[ValidateOrgDomainResponse](#validateorgdomainresponse) - -Validates your domain with the choosen method -Validated domains must be unique - - - - POST: /orgs/me/domains/{domain}/validation/_validate - - -### SetPrimaryOrgDomain - -> **rpc** SetPrimaryOrgDomain([SetPrimaryOrgDomainRequest](#setprimaryorgdomainrequest)) -[SetPrimaryOrgDomainResponse](#setprimaryorgdomainresponse) - -Sets the domain as primary -Primary domain is shown as suffix on the preferred username on the users of the organisation - - - - POST: /orgs/me/domains/{domain}/_set_primary - - -### ListOrgMemberRoles - -> **rpc** ListOrgMemberRoles([ListOrgMemberRolesRequest](#listorgmemberrolesrequest)) -[ListOrgMemberRolesResponse](#listorgmemberrolesresponse) - -Returns all ZITADEL roles which are for organisation managers - - - - POST: /orgs/members/roles/_search - - -### ListOrgMembers - -> **rpc** ListOrgMembers([ListOrgMembersRequest](#listorgmembersrequest)) -[ListOrgMembersResponse](#listorgmembersresponse) - -Returns all ZITADEL managers of this organisation (Project and Project Grant managers not included) -Limit should always be set, there is a default limit set by the service - - - - POST: /orgs/me/members/_search - - -### AddOrgMember - -> **rpc** AddOrgMember([AddOrgMemberRequest](#addorgmemberrequest)) -[AddOrgMemberResponse](#addorgmemberresponse) - -Adds a new organisation manager, which is allowed to administrate ZITADEL - - - - POST: /orgs/me/members - - -### UpdateOrgMember - -> **rpc** UpdateOrgMember([UpdateOrgMemberRequest](#updateorgmemberrequest)) -[UpdateOrgMemberResponse](#updateorgmemberresponse) - -Changes the organisation manager - - - - PUT: /orgs/me/members/{user_id} - - -### RemoveOrgMember - -> **rpc** RemoveOrgMember([RemoveOrgMemberRequest](#removeorgmemberrequest)) -[RemoveOrgMemberResponse](#removeorgmemberresponse) - -Removes an organisation manager - - - - DELETE: /orgs/me/members/{user_id} - - -### GetProjectByID - -> **rpc** GetProjectByID([GetProjectByIDRequest](#getprojectbyidrequest)) -[GetProjectByIDResponse](#getprojectbyidresponse) - -Returns a project from my organisation (no granted projects) - - - - GET: /projects/{id} - - -### GetGrantedProjectByID - -> **rpc** GetGrantedProjectByID([GetGrantedProjectByIDRequest](#getgrantedprojectbyidrequest)) -[GetGrantedProjectByIDResponse](#getgrantedprojectbyidresponse) - -returns a project my organisation got granted from another organisation - - - - GET: /granted_projects/{project_id}/grants/{grant_id} - - -### ListProjects - -> **rpc** ListProjects([ListProjectsRequest](#listprojectsrequest)) -[ListProjectsResponse](#listprojectsresponse) - -Returns all projects my organisation is the owner (no granted projects) -Limit should always be set, there is a default limit set by the service - - - - POST: /projects/_search - - -### ListGrantedProjects - -> **rpc** ListGrantedProjects([ListGrantedProjectsRequest](#listgrantedprojectsrequest)) -[ListGrantedProjectsResponse](#listgrantedprojectsresponse) - -returns all projects my organisation got granted from another organisation -Limit should always be set, there is a default limit set by the service - - - - POST: /granted_projects/_search - - -### ListGrantedProjectRoles - -> **rpc** ListGrantedProjectRoles([ListGrantedProjectRolesRequest](#listgrantedprojectrolesrequest)) -[ListGrantedProjectRolesResponse](#listgrantedprojectrolesresponse) - -returns all roles of a project grant -Limit should always be set, there is a default limit set by the service - - - - GET: /granted_projects/{project_id}/grants/{grant_id}/roles/_search - - -### ListProjectChanges - -> **rpc** ListProjectChanges([ListProjectChangesRequest](#listprojectchangesrequest)) -[ListProjectChangesResponse](#listprojectchangesresponse) - -Returns the history of the project (each event) -Limit should always be set, there is a default limit set by the service - - - - POST: /projects/{project_id}/changes/_search - - -### AddProject - -> **rpc** AddProject([AddProjectRequest](#addprojectrequest)) -[AddProjectResponse](#addprojectresponse) - -Adds an new project to the organisation - - - - POST: /projects - - -### UpdateProject - -> **rpc** UpdateProject([UpdateProjectRequest](#updateprojectrequest)) -[UpdateProjectResponse](#updateprojectresponse) - -Changes a project - - - - PUT: /projects/{id} - - -### DeactivateProject - -> **rpc** DeactivateProject([DeactivateProjectRequest](#deactivateprojectrequest)) -[DeactivateProjectResponse](#deactivateprojectresponse) - -Sets the state of a project to deactivated -Returns an error if project is already deactivated - - - - POST: /projects/{id}/_deactivate - - -### ReactivateProject - -> **rpc** ReactivateProject([ReactivateProjectRequest](#reactivateprojectrequest)) -[ReactivateProjectResponse](#reactivateprojectresponse) - -Sets the state of a project to active -Returns an error if project is not deactivated - - - - POST: /projects/{id}/_reactivate - - -### RemoveProject - -> **rpc** RemoveProject([RemoveProjectRequest](#removeprojectrequest)) -[RemoveProjectResponse](#removeprojectresponse) - -Removes a project -All project grants, applications and user grants for this project will be removed - - - - DELETE: /projects/{id} - - -### ListProjectRoles - -> **rpc** ListProjectRoles([ListProjectRolesRequest](#listprojectrolesrequest)) -[ListProjectRolesResponse](#listprojectrolesresponse) - -Returns all roles of a project matching the search query -If no limit is requested, default limit will be set, if the limit is higher then the default an error will be returned - - - - POST: /projects/{project_id}/roles/_search - - -### AddProjectRole - -> **rpc** AddProjectRole([AddProjectRoleRequest](#addprojectrolerequest)) -[AddProjectRoleResponse](#addprojectroleresponse) - -Adds a role to a project, key must be unique in the project - - - - POST: /projects/{project_id}/roles - - -### BulkAddProjectRoles - -> **rpc** BulkAddProjectRoles([BulkAddProjectRolesRequest](#bulkaddprojectrolesrequest)) -[BulkAddProjectRolesResponse](#bulkaddprojectrolesresponse) - -add a list of project roles in one request - - - - POST: /projects/{project_id}/roles/_bulk - - -### UpdateProjectRole - -> **rpc** UpdateProjectRole([UpdateProjectRoleRequest](#updateprojectrolerequest)) -[UpdateProjectRoleResponse](#updateprojectroleresponse) - -Changes a project role, key is not editable -If a key should change, remove the role and create a new - - - - PUT: /projects/{project_id}/roles/{role_key} - - -### RemoveProjectRole - -> **rpc** RemoveProjectRole([RemoveProjectRoleRequest](#removeprojectrolerequest)) -[RemoveProjectRoleResponse](#removeprojectroleresponse) - -Removes role from UserGrants, ProjectGrants and from Project - - - - DELETE: /projects/{project_id}/roles/{role_key} - - -### ListProjectMemberRoles - -> **rpc** ListProjectMemberRoles([ListProjectMemberRolesRequest](#listprojectmemberrolesrequest)) -[ListProjectMemberRolesResponse](#listprojectmemberrolesresponse) - -Returns all ZITADEL roles which are for project managers - - - - POST: /projects/members/roles/_search - - -### ListProjectMembers - -> **rpc** ListProjectMembers([ListProjectMembersRequest](#listprojectmembersrequest)) -[ListProjectMembersResponse](#listprojectmembersresponse) - -Returns all ZITADEL managers of a projects -Limit should always be set, there is a default limit set by the service - - - - POST: /projects/{project_id}/members/_search - - -### AddProjectMember - -> **rpc** AddProjectMember([AddProjectMemberRequest](#addprojectmemberrequest)) -[AddProjectMemberResponse](#addprojectmemberresponse) - -Adds a new project manager, which is allowed to administrate in ZITADEL - - - - POST: /projects/{project_id}/members - - -### UpdateProjectMember - -> **rpc** UpdateProjectMember([UpdateProjectMemberRequest](#updateprojectmemberrequest)) -[UpdateProjectMemberResponse](#updateprojectmemberresponse) - -Change project manager, which is allowed to administrate in ZITADEL - - - - PUT: /projects/{project_id}/members/{user_id} - - -### RemoveProjectMember - -> **rpc** RemoveProjectMember([RemoveProjectMemberRequest](#removeprojectmemberrequest)) -[RemoveProjectMemberResponse](#removeprojectmemberresponse) - -Remove project manager, which is allowed to administrate in ZITADEL - - - - DELETE: /projects/{project_id}/members/{user_id} - - -### GetAppByID - -> **rpc** GetAppByID([GetAppByIDRequest](#getappbyidrequest)) -[GetAppByIDResponse](#getappbyidresponse) - -Returns an application (oidc or api) - - - - GET: /projects/{project_id}/apps/{app_id} - - -### ListApps - -> **rpc** ListApps([ListAppsRequest](#listappsrequest)) -[ListAppsResponse](#listappsresponse) - -Returns all applications of a project matching the query -Limit should always be set, there is a default limit set by the service - - - - POST: /projects/{project_id}/apps/_search - - -### ListAppChanges - -> **rpc** ListAppChanges([ListAppChangesRequest](#listappchangesrequest)) -[ListAppChangesResponse](#listappchangesresponse) - -Returns the history of the application (each event) -Limit should always be set, there is a default limit set by the service - - - - POST: /projects/{project_id}/apps/{app_id}/changes/_search - - -### AddOIDCApp - -> **rpc** AddOIDCApp([AddOIDCAppRequest](#addoidcapprequest)) -[AddOIDCAppResponse](#addoidcappresponse) - -Adds a new oidc client -Returns a client id -Returns a new generated secret if needed (Depending on the configuration) - - - - POST: /projects/{project_id}/apps/oidc - - -### AddSAMLApp - -> **rpc** AddSAMLApp([AddSAMLAppRequest](#addsamlapprequest)) -[AddSAMLAppResponse](#addsamlappresponse) - -Adds a new saml service provider -Returns a entityID - - - - POST: /projects/{project_id}/apps/saml - - -### AddAPIApp - -> **rpc** AddAPIApp([AddAPIAppRequest](#addapiapprequest)) -[AddAPIAppResponse](#addapiappresponse) - -Adds a new api application -Returns a client id -Returns a new generated secret if needed (Depending on the configuration) - - - - POST: /projects/{project_id}/apps/api - - -### UpdateApp - -> **rpc** UpdateApp([UpdateAppRequest](#updateapprequest)) -[UpdateAppResponse](#updateappresponse) - -Changes application - - - - PUT: /projects/{project_id}/apps/{app_id} - - -### UpdateOIDCAppConfig - -> **rpc** UpdateOIDCAppConfig([UpdateOIDCAppConfigRequest](#updateoidcappconfigrequest)) -[UpdateOIDCAppConfigResponse](#updateoidcappconfigresponse) - -Changes the configuration of the oidc client - - - - PUT: /projects/{project_id}/apps/{app_id}/oidc_config - - -### UpdateSAMLAppConfig - -> **rpc** UpdateSAMLAppConfig([UpdateSAMLAppConfigRequest](#updatesamlappconfigrequest)) -[UpdateSAMLAppConfigResponse](#updatesamlappconfigresponse) - -Changes the configuration of the saml application - - - - PUT: /projects/{project_id}/apps/{app_id}/saml_config - - -### UpdateAPIAppConfig - -> **rpc** UpdateAPIAppConfig([UpdateAPIAppConfigRequest](#updateapiappconfigrequest)) -[UpdateAPIAppConfigResponse](#updateapiappconfigresponse) - -Changes the configuration of the api application - - - - PUT: /projects/{project_id}/apps/{app_id}/api_config - - -### DeactivateApp - -> **rpc** DeactivateApp([DeactivateAppRequest](#deactivateapprequest)) -[DeactivateAppResponse](#deactivateappresponse) - -Set the state to deactivated -Its not possible to request tokens for deactivated apps -Returns an error if already deactivated - - - - POST: /projects/{project_id}/apps/{app_id}/_deactivate - - -### ReactivateApp - -> **rpc** ReactivateApp([ReactivateAppRequest](#reactivateapprequest)) -[ReactivateAppResponse](#reactivateappresponse) - -Set the state to active -Returns an error if not deactivated - - - - POST: /projects/{project_id}/apps/{app_id}/_reactivate - - -### RemoveApp - -> **rpc** RemoveApp([RemoveAppRequest](#removeapprequest)) -[RemoveAppResponse](#removeappresponse) - -Removed the application - - - - DELETE: /projects/{project_id}/apps/{app_id} - - -### RegenerateOIDCClientSecret - -> **rpc** RegenerateOIDCClientSecret([RegenerateOIDCClientSecretRequest](#regenerateoidcclientsecretrequest)) -[RegenerateOIDCClientSecretResponse](#regenerateoidcclientsecretresponse) - -Generates a new client secret for the oidc client, make sure to save the response - - - - POST: /projects/{project_id}/apps/{app_id}/oidc_config/_generate_client_secret - - -### RegenerateAPIClientSecret - -> **rpc** RegenerateAPIClientSecret([RegenerateAPIClientSecretRequest](#regenerateapiclientsecretrequest)) -[RegenerateAPIClientSecretResponse](#regenerateapiclientsecretresponse) - -Generates a new client secret for the api application, make sure to save the response - - - - POST: /projects/{project_id}/apps/{app_id}/api_config/_generate_client_secret - - -### GetAppKey - -> **rpc** GetAppKey([GetAppKeyRequest](#getappkeyrequest)) -[GetAppKeyResponse](#getappkeyresponse) - -Returns an application key - - - - GET: /projects/{project_id}/apps/{app_id}/keys/{key_id} - - -### ListAppKeys - -> **rpc** ListAppKeys([ListAppKeysRequest](#listappkeysrequest)) -[ListAppKeysResponse](#listappkeysresponse) - -Returns all application keys matching the result -Limit should always be set, there is a default limit set by the service - - - - POST: /projects/{project_id}/apps/{app_id}/keys/_search - - -### AddAppKey - -> **rpc** AddAppKey([AddAppKeyRequest](#addappkeyrequest)) -[AddAppKeyResponse](#addappkeyresponse) - -Creates a new app key -Will return key details in result, make sure to save it - - - - POST: /projects/{project_id}/apps/{app_id}/keys - - -### RemoveAppKey - -> **rpc** RemoveAppKey([RemoveAppKeyRequest](#removeappkeyrequest)) -[RemoveAppKeyResponse](#removeappkeyresponse) - -Removes an app key - - - - DELETE: /projects/{project_id}/apps/{app_id}/keys/{key_id} - - -### ListProjectGrantChanges - -> **rpc** ListProjectGrantChanges([ListProjectGrantChangesRequest](#listprojectgrantchangesrequest)) -[ListProjectGrantChangesResponse](#listprojectgrantchangesresponse) - -Returns the history of the project grant (each event) -Limit should always be set, there is a default limit set by the service - - - - POST: /projects/{project_id}/grants/{grant_id}/changes/_search - - -### GetProjectGrantByID - -> **rpc** GetProjectGrantByID([GetProjectGrantByIDRequest](#getprojectgrantbyidrequest)) -[GetProjectGrantByIDResponse](#getprojectgrantbyidresponse) - -Returns a project grant (ProjectGrant = Grant another organisation for my project) - - - - GET: /projects/{project_id}/grants/{grant_id} - - -### ListProjectGrants - -> **rpc** ListProjectGrants([ListProjectGrantsRequest](#listprojectgrantsrequest)) -[ListProjectGrantsResponse](#listprojectgrantsresponse) - -Returns all project grants matching the query, (ProjectGrant = Grant another organisation for my project) -Limit should always be set, there is a default limit set by the service - - - - POST: /projects/{project_id}/grants/_search - - -### ListAllProjectGrants - -> **rpc** ListAllProjectGrants([ListAllProjectGrantsRequest](#listallprojectgrantsrequest)) -[ListAllProjectGrantsResponse](#listallprojectgrantsresponse) - -Returns all project grants matching the query, (ProjectGrant = Grant another organisation for my project) -Limit should always be set, there is a default limit set by the service - - - - POST: /projectgrants/_search - - -### AddProjectGrant - -> **rpc** AddProjectGrant([AddProjectGrantRequest](#addprojectgrantrequest)) -[AddProjectGrantResponse](#addprojectgrantresponse) - -Add a new project grant (ProjectGrant = Grant another organisation for my project) -Project Grant will be listed in granted project of the other organisation - - - - POST: /projects/{project_id}/grants - - -### UpdateProjectGrant - -> **rpc** UpdateProjectGrant([UpdateProjectGrantRequest](#updateprojectgrantrequest)) -[UpdateProjectGrantResponse](#updateprojectgrantresponse) - -Change project grant (ProjectGrant = Grant another organisation for my project) -Project Grant will be listed in granted project of the other organisation - - - - PUT: /projects/{project_id}/grants/{grant_id} - - -### DeactivateProjectGrant - -> **rpc** DeactivateProjectGrant([DeactivateProjectGrantRequest](#deactivateprojectgrantrequest)) -[DeactivateProjectGrantResponse](#deactivateprojectgrantresponse) - -Set state of project grant to deactivated (ProjectGrant = Grant another organisation for my project) -Returns error if project not active - - - - POST: /projects/{project_id}/grants/{grant_id}/_deactivate - - -### ReactivateProjectGrant - -> **rpc** ReactivateProjectGrant([ReactivateProjectGrantRequest](#reactivateprojectgrantrequest)) -[ReactivateProjectGrantResponse](#reactivateprojectgrantresponse) - -Set state of project grant to active (ProjectGrant = Grant another organisation for my project) -Returns error if project not deactivated - - - - POST: /projects/{project_id}/grants/{grant_id}/_reactivate - - -### RemoveProjectGrant - -> **rpc** RemoveProjectGrant([RemoveProjectGrantRequest](#removeprojectgrantrequest)) -[RemoveProjectGrantResponse](#removeprojectgrantresponse) - -Removes project grant and all user grants for this project grant - - - - DELETE: /projects/{project_id}/grants/{grant_id} - - -### ListProjectGrantMemberRoles - -> **rpc** ListProjectGrantMemberRoles([ListProjectGrantMemberRolesRequest](#listprojectgrantmemberrolesrequest)) -[ListProjectGrantMemberRolesResponse](#listprojectgrantmemberrolesresponse) - -Returns all ZITADEL roles which are for project grant managers - - - - POST: /projects/grants/members/roles/_search - - -### ListProjectGrantMembers - -> **rpc** ListProjectGrantMembers([ListProjectGrantMembersRequest](#listprojectgrantmembersrequest)) -[ListProjectGrantMembersResponse](#listprojectgrantmembersresponse) - -Returns all ZITADEL managers of this project grant -Limit should always be set, there is a default limit set by the service - - - - POST: /projects/{project_id}/grants/{grant_id}/members/_search - - -### AddProjectGrantMember - -> **rpc** AddProjectGrantMember([AddProjectGrantMemberRequest](#addprojectgrantmemberrequest)) -[AddProjectGrantMemberResponse](#addprojectgrantmemberresponse) - -Adds a new project grant manager, which is allowed to administrate in ZITADEL - - - - POST: /projects/{project_id}/grants/{grant_id}/members - - -### UpdateProjectGrantMember - -> **rpc** UpdateProjectGrantMember([UpdateProjectGrantMemberRequest](#updateprojectgrantmemberrequest)) -[UpdateProjectGrantMemberResponse](#updateprojectgrantmemberresponse) - -Changes project grant manager, which is allowed to administrate in ZITADEL - - - - PUT: /projects/{project_id}/grants/{grant_id}/members/{user_id} - - -### RemoveProjectGrantMember - -> **rpc** RemoveProjectGrantMember([RemoveProjectGrantMemberRequest](#removeprojectgrantmemberrequest)) -[RemoveProjectGrantMemberResponse](#removeprojectgrantmemberresponse) - -Removed project grant manager - - - - DELETE: /projects/{project_id}/grants/{grant_id}/members/{user_id} - - -### GetUserGrantByID - -> **rpc** GetUserGrantByID([GetUserGrantByIDRequest](#getusergrantbyidrequest)) -[GetUserGrantByIDResponse](#getusergrantbyidresponse) - -Returns a user grant (authorization of a user for a project) - - - - GET: /users/{user_id}/grants/{grant_id} - - -### ListUserGrants - -> **rpc** ListUserGrants([ListUserGrantRequest](#listusergrantrequest)) -[ListUserGrantResponse](#listusergrantresponse) - -Returns al user grant matching the query (authorizations of user for projects) -Limit should always be set, there is a default limit set by the service - - - - POST: /users/grants/_search - - -### AddUserGrant - -> **rpc** AddUserGrant([AddUserGrantRequest](#addusergrantrequest)) -[AddUserGrantResponse](#addusergrantresponse) - -Creates a new user grant (authorization of a user for a project with specified roles) - - - - POST: /users/{user_id}/grants - - -### UpdateUserGrant - -> **rpc** UpdateUserGrant([UpdateUserGrantRequest](#updateusergrantrequest)) -[UpdateUserGrantResponse](#updateusergrantresponse) - -Changes a user grant (authorization of a user for a project with specified roles) - - - - PUT: /users/{user_id}/grants/{grant_id} - - -### DeactivateUserGrant - -> **rpc** DeactivateUserGrant([DeactivateUserGrantRequest](#deactivateusergrantrequest)) -[DeactivateUserGrantResponse](#deactivateusergrantresponse) - -Sets the state of a user grant to deactivated -User will not be able to use the granted project anymore -Returns an error if user grant is already deactivated - - - - POST: /users/{user_id}/grants/{grant_id}/_deactivate - - -### ReactivateUserGrant - -> **rpc** ReactivateUserGrant([ReactivateUserGrantRequest](#reactivateusergrantrequest)) -[ReactivateUserGrantResponse](#reactivateusergrantresponse) - -Sets the state of a user grant to active -Returns an error if user grant is not deactivated - - - - POST: /users/{user_id}/grants/{grant_id}/_reactivate - - -### RemoveUserGrant - -> **rpc** RemoveUserGrant([RemoveUserGrantRequest](#removeusergrantrequest)) -[RemoveUserGrantResponse](#removeusergrantresponse) - -Removes a user grant - - - - DELETE: /users/{user_id}/grants/{grant_id} - - -### BulkRemoveUserGrant - -> **rpc** BulkRemoveUserGrant([BulkRemoveUserGrantRequest](#bulkremoveusergrantrequest)) -[BulkRemoveUserGrantResponse](#bulkremoveusergrantresponse) - -remove a list of user grants in one request - - - - DELETE: /user_grants/_bulk - - -### GetOrgIAMPolicy - -> **rpc** GetOrgIAMPolicy([GetOrgIAMPolicyRequest](#getorgiampolicyrequest)) -[GetOrgIAMPolicyResponse](#getorgiampolicyresponse) - -deprecated: please use DomainPolicy instead -Returns the domain policy (this policy is managed by the iam administrator) - - - - GET: /policies/orgiam - - -### GetDomainPolicy - -> **rpc** GetDomainPolicy([GetDomainPolicyRequest](#getdomainpolicyrequest)) -[GetDomainPolicyResponse](#getdomainpolicyresponse) - -Returns the domain policy (this policy is managed by the iam administrator) - - - - GET: /policies/domain - - -### GetLoginPolicy - -> **rpc** GetLoginPolicy([GetLoginPolicyRequest](#getloginpolicyrequest)) -[GetLoginPolicyResponse](#getloginpolicyresponse) - -Returns the login policy of the organisation -With this policy the login gui can be configured - - - - GET: /policies/login - - -### GetDefaultLoginPolicy - -> **rpc** GetDefaultLoginPolicy([GetDefaultLoginPolicyRequest](#getdefaultloginpolicyrequest)) -[GetDefaultLoginPolicyResponse](#getdefaultloginpolicyresponse) - -Returns the default login policy configured in the IAM - - - - GET: /policies/default/login - - -### AddCustomLoginPolicy - -> **rpc** AddCustomLoginPolicy([AddCustomLoginPolicyRequest](#addcustomloginpolicyrequest)) -[AddCustomLoginPolicyResponse](#addcustomloginpolicyresponse) - -Add a custom login policy for the organisation -With this policy the login gui can be configured - - - - POST: /policies/login - - -### UpdateCustomLoginPolicy - -> **rpc** UpdateCustomLoginPolicy([UpdateCustomLoginPolicyRequest](#updatecustomloginpolicyrequest)) -[UpdateCustomLoginPolicyResponse](#updatecustomloginpolicyresponse) - -Change the custom login policy for the organisation -With this policy the login gui can be configured - - - - PUT: /policies/login - - -### ResetLoginPolicyToDefault - -> **rpc** ResetLoginPolicyToDefault([ResetLoginPolicyToDefaultRequest](#resetloginpolicytodefaultrequest)) -[ResetLoginPolicyToDefaultResponse](#resetloginpolicytodefaultresponse) - -Removes the custom login policy of the organisation -The default policy of the IAM will trigger after - - - - DELETE: /policies/login - - -### ListLoginPolicyIDPs - -> **rpc** ListLoginPolicyIDPs([ListLoginPolicyIDPsRequest](#listloginpolicyidpsrequest)) -[ListLoginPolicyIDPsResponse](#listloginpolicyidpsresponse) - -Lists all possible identity providers configured on the organisation -Limit should always be set, there is a default limit set by the service - - - - POST: /policies/login/idps/_search - - -### AddIDPToLoginPolicy - -> **rpc** AddIDPToLoginPolicy([AddIDPToLoginPolicyRequest](#addidptologinpolicyrequest)) -[AddIDPToLoginPolicyResponse](#addidptologinpolicyresponse) - -Add a (preconfigured) identity provider to the custom login policy - - - - POST: /policies/login/idps - - -### RemoveIDPFromLoginPolicy - -> **rpc** RemoveIDPFromLoginPolicy([RemoveIDPFromLoginPolicyRequest](#removeidpfromloginpolicyrequest)) -[RemoveIDPFromLoginPolicyResponse](#removeidpfromloginpolicyresponse) - -Remove a identity provider from the custom login policy - - - - DELETE: /policies/login/idps/{idp_id} - - -### ListLoginPolicySecondFactors - -> **rpc** ListLoginPolicySecondFactors([ListLoginPolicySecondFactorsRequest](#listloginpolicysecondfactorsrequest)) -[ListLoginPolicySecondFactorsResponse](#listloginpolicysecondfactorsresponse) - -Returns all configured second factors of the custom login policy - - - - POST: /policies/login/second_factors/_search - - -### AddSecondFactorToLoginPolicy - -> **rpc** AddSecondFactorToLoginPolicy([AddSecondFactorToLoginPolicyRequest](#addsecondfactortologinpolicyrequest)) -[AddSecondFactorToLoginPolicyResponse](#addsecondfactortologinpolicyresponse) - -Adds a new second factor to the custom login policy - - - - POST: /policies/login/second_factors - - -### RemoveSecondFactorFromLoginPolicy - -> **rpc** RemoveSecondFactorFromLoginPolicy([RemoveSecondFactorFromLoginPolicyRequest](#removesecondfactorfromloginpolicyrequest)) -[RemoveSecondFactorFromLoginPolicyResponse](#removesecondfactorfromloginpolicyresponse) - -Remove a second factor from the custom login policy - - - - DELETE: /policies/login/second_factors/{type} - - -### ListLoginPolicyMultiFactors - -> **rpc** ListLoginPolicyMultiFactors([ListLoginPolicyMultiFactorsRequest](#listloginpolicymultifactorsrequest)) -[ListLoginPolicyMultiFactorsResponse](#listloginpolicymultifactorsresponse) - -Returns all configured multi factors of the custom login policy - - - - POST: /policies/login/auth_factors/_search - - -### AddMultiFactorToLoginPolicy - -> **rpc** AddMultiFactorToLoginPolicy([AddMultiFactorToLoginPolicyRequest](#addmultifactortologinpolicyrequest)) -[AddMultiFactorToLoginPolicyResponse](#addmultifactortologinpolicyresponse) - -Adds a new multi factor to the custom login policy - - - - POST: /policies/login/multi_factors - - -### RemoveMultiFactorFromLoginPolicy - -> **rpc** RemoveMultiFactorFromLoginPolicy([RemoveMultiFactorFromLoginPolicyRequest](#removemultifactorfromloginpolicyrequest)) -[RemoveMultiFactorFromLoginPolicyResponse](#removemultifactorfromloginpolicyresponse) - -Remove a multi factor from the custom login policy - - - - DELETE: /policies/login/multi_factors/{type} - - -### GetPasswordComplexityPolicy - -> **rpc** GetPasswordComplexityPolicy([GetPasswordComplexityPolicyRequest](#getpasswordcomplexitypolicyrequest)) -[GetPasswordComplexityPolicyResponse](#getpasswordcomplexitypolicyresponse) - -Returns the password complexity policy of the organisation -With this policy the password strength can be configured - - - - GET: /policies/password/complexity - - -### GetDefaultPasswordComplexityPolicy - -> **rpc** GetDefaultPasswordComplexityPolicy([GetDefaultPasswordComplexityPolicyRequest](#getdefaultpasswordcomplexitypolicyrequest)) -[GetDefaultPasswordComplexityPolicyResponse](#getdefaultpasswordcomplexitypolicyresponse) - -Returns the default password complexity policy of the IAM -With this policy the password strength can be configured - - - - GET: /policies/default/password/complexity - - -### AddCustomPasswordComplexityPolicy - -> **rpc** AddCustomPasswordComplexityPolicy([AddCustomPasswordComplexityPolicyRequest](#addcustompasswordcomplexitypolicyrequest)) -[AddCustomPasswordComplexityPolicyResponse](#addcustompasswordcomplexitypolicyresponse) - -Add a custom password complexity policy for the organisation -With this policy the password strength can be configured - - - - POST: /policies/password/complexity - - -### UpdateCustomPasswordComplexityPolicy - -> **rpc** UpdateCustomPasswordComplexityPolicy([UpdateCustomPasswordComplexityPolicyRequest](#updatecustompasswordcomplexitypolicyrequest)) -[UpdateCustomPasswordComplexityPolicyResponse](#updatecustompasswordcomplexitypolicyresponse) - -Update the custom password complexity policy for the organisation -With this policy the password strength can be configured - - - - PUT: /policies/password/complexity - - -### ResetPasswordComplexityPolicyToDefault - -> **rpc** ResetPasswordComplexityPolicyToDefault([ResetPasswordComplexityPolicyToDefaultRequest](#resetpasswordcomplexitypolicytodefaultrequest)) -[ResetPasswordComplexityPolicyToDefaultResponse](#resetpasswordcomplexitypolicytodefaultresponse) - -Removes the custom password complexity policy of the organisation -The default policy of the IAM will trigger after - - - - DELETE: /policies/password/complexity - - -### GetPasswordAgePolicy - -> **rpc** GetPasswordAgePolicy([GetPasswordAgePolicyRequest](#getpasswordagepolicyrequest)) -[GetPasswordAgePolicyResponse](#getpasswordagepolicyresponse) - -The password age policy is not used at the moment - - - - GET: /policies/password/age - - -### GetDefaultPasswordAgePolicy - -> **rpc** GetDefaultPasswordAgePolicy([GetDefaultPasswordAgePolicyRequest](#getdefaultpasswordagepolicyrequest)) -[GetDefaultPasswordAgePolicyResponse](#getdefaultpasswordagepolicyresponse) - -The password age policy is not used at the moment - - - - GET: /policies/default/password/age - - -### AddCustomPasswordAgePolicy - -> **rpc** AddCustomPasswordAgePolicy([AddCustomPasswordAgePolicyRequest](#addcustompasswordagepolicyrequest)) -[AddCustomPasswordAgePolicyResponse](#addcustompasswordagepolicyresponse) - -The password age policy is not used at the moment - - - - POST: /policies/password/age - - -### UpdateCustomPasswordAgePolicy - -> **rpc** UpdateCustomPasswordAgePolicy([UpdateCustomPasswordAgePolicyRequest](#updatecustompasswordagepolicyrequest)) -[UpdateCustomPasswordAgePolicyResponse](#updatecustompasswordagepolicyresponse) - -The password age policy is not used at the moment - - - - PUT: /policies/password/age - - -### ResetPasswordAgePolicyToDefault - -> **rpc** ResetPasswordAgePolicyToDefault([ResetPasswordAgePolicyToDefaultRequest](#resetpasswordagepolicytodefaultrequest)) -[ResetPasswordAgePolicyToDefaultResponse](#resetpasswordagepolicytodefaultresponse) - -The password age policy is not used at the moment - - - - DELETE: /policies/password/age - - -### GetLockoutPolicy - -> **rpc** GetLockoutPolicy([GetLockoutPolicyRequest](#getlockoutpolicyrequest)) -[GetLockoutPolicyResponse](#getlockoutpolicyresponse) - - - - - - GET: /policies/lockout - - -### GetDefaultLockoutPolicy - -> **rpc** GetDefaultLockoutPolicy([GetDefaultLockoutPolicyRequest](#getdefaultlockoutpolicyrequest)) -[GetDefaultLockoutPolicyResponse](#getdefaultlockoutpolicyresponse) - - - - - - GET: /policies/default/lockout - - -### AddCustomLockoutPolicy - -> **rpc** AddCustomLockoutPolicy([AddCustomLockoutPolicyRequest](#addcustomlockoutpolicyrequest)) -[AddCustomLockoutPolicyResponse](#addcustomlockoutpolicyresponse) - - - - - - POST: /policies/lockout - - -### UpdateCustomLockoutPolicy - -> **rpc** UpdateCustomLockoutPolicy([UpdateCustomLockoutPolicyRequest](#updatecustomlockoutpolicyrequest)) -[UpdateCustomLockoutPolicyResponse](#updatecustomlockoutpolicyresponse) - - - - - - PUT: /policies/lockout - - -### ResetLockoutPolicyToDefault - -> **rpc** ResetLockoutPolicyToDefault([ResetLockoutPolicyToDefaultRequest](#resetlockoutpolicytodefaultrequest)) -[ResetLockoutPolicyToDefaultResponse](#resetlockoutpolicytodefaultresponse) - - - - - - DELETE: /policies/lockout - - -### GetPrivacyPolicy - -> **rpc** GetPrivacyPolicy([GetPrivacyPolicyRequest](#getprivacypolicyrequest)) -[GetPrivacyPolicyResponse](#getprivacypolicyresponse) - -Returns the privacy policy of the organisation -With this policy privacy relevant things can be configured (e.g. tos link) - - - - GET: /policies/privacy - - -### GetDefaultPrivacyPolicy - -> **rpc** GetDefaultPrivacyPolicy([GetDefaultPrivacyPolicyRequest](#getdefaultprivacypolicyrequest)) -[GetDefaultPrivacyPolicyResponse](#getdefaultprivacypolicyresponse) - -Returns the default privacy policy of the IAM -With this policy the privacy relevant things can be configured (e.g tos link) - - - - GET: /policies/default/privacy - - -### AddCustomPrivacyPolicy - -> **rpc** AddCustomPrivacyPolicy([AddCustomPrivacyPolicyRequest](#addcustomprivacypolicyrequest)) -[AddCustomPrivacyPolicyResponse](#addcustomprivacypolicyresponse) - -Add a custom privacy policy for the organisation -With this policy privacy relevant things can be configured (e.g. tos link) -Variable {{.Lang}} can be set to have different links based on the language - - - - POST: /policies/privacy - - -### UpdateCustomPrivacyPolicy - -> **rpc** UpdateCustomPrivacyPolicy([UpdateCustomPrivacyPolicyRequest](#updatecustomprivacypolicyrequest)) -[UpdateCustomPrivacyPolicyResponse](#updatecustomprivacypolicyresponse) - -Update the privacy policy for the organisation -With this policy privacy relevant things can be configured (e.g. tos link) -Variable {{.Lang}} can be set to have different links based on the language - - - - PUT: /policies/privacy - - -### ResetPrivacyPolicyToDefault - -> **rpc** ResetPrivacyPolicyToDefault([ResetPrivacyPolicyToDefaultRequest](#resetprivacypolicytodefaultrequest)) -[ResetPrivacyPolicyToDefaultResponse](#resetprivacypolicytodefaultresponse) - -Removes the privacy policy of the organisation -The default policy of the IAM will trigger after - - - - DELETE: /policies/privacy - - -### GetNotificationPolicy - -> **rpc** GetNotificationPolicy([GetNotificationPolicyRequest](#getnotificationpolicyrequest)) -[GetNotificationPolicyResponse](#getnotificationpolicyresponse) - -Returns the notification policy of the organisation -With this notification policy it can be configured how users should be notified - - - - GET: /policies/notification - - -### GetDefaultNotificationPolicy - -> **rpc** GetDefaultNotificationPolicy([GetDefaultNotificationPolicyRequest](#getdefaultnotificationpolicyrequest)) -[GetDefaultNotificationPolicyResponse](#getdefaultnotificationpolicyresponse) - -Returns the default notification policy of the IAM -With this notification privacy it can be configured how users should be notified - - - - GET: /policies/default/notification - - -### AddCustomNotificationPolicy - -> **rpc** AddCustomNotificationPolicy([AddCustomNotificationPolicyRequest](#addcustomnotificationpolicyrequest)) -[AddCustomNotificationPolicyResponse](#addcustomnotificationpolicyresponse) - -Add a custom notification policy for the organisation -With this notification privacy it can be configured how users should be notified - - - - POST: /policies/notification - - -### UpdateCustomNotificationPolicy - -> **rpc** UpdateCustomNotificationPolicy([UpdateCustomNotificationPolicyRequest](#updatecustomnotificationpolicyrequest)) -[UpdateCustomNotificationPolicyResponse](#updatecustomnotificationpolicyresponse) - -Update the notification policy for the organisation -With this notification privacy it can be configured how users should be notified - - - - PUT: /policies/notification - - -### ResetNotificationPolicyToDefault - -> **rpc** ResetNotificationPolicyToDefault([ResetNotificationPolicyToDefaultRequest](#resetnotificationpolicytodefaultrequest)) -[ResetNotificationPolicyToDefaultResponse](#resetnotificationpolicytodefaultresponse) - -Removes the notification policy of the organisation -The default policy of the IAM will trigger after - - - - DELETE: /policies/notification - - -### GetLabelPolicy - -> **rpc** GetLabelPolicy([GetLabelPolicyRequest](#getlabelpolicyrequest)) -[GetLabelPolicyResponse](#getlabelpolicyresponse) - -Returns the active label policy of the organisation -With this policy the private labeling can be configured (colors, etc.) - - - - GET: /policies/label - - -### GetPreviewLabelPolicy - -> **rpc** GetPreviewLabelPolicy([GetPreviewLabelPolicyRequest](#getpreviewlabelpolicyrequest)) -[GetPreviewLabelPolicyResponse](#getpreviewlabelpolicyresponse) - -Returns the preview label policy of the organisation -With this policy the private labeling can be configured (colors, etc.) - - - - GET: /policies/label/_preview - - -### GetDefaultLabelPolicy - -> **rpc** GetDefaultLabelPolicy([GetDefaultLabelPolicyRequest](#getdefaultlabelpolicyrequest)) -[GetDefaultLabelPolicyResponse](#getdefaultlabelpolicyresponse) - -Returns the default label policy of the IAM -With this policy the private labeling can be configured (colors, etc.) - - - - GET: /policies/default/label - - -### AddCustomLabelPolicy - -> **rpc** AddCustomLabelPolicy([AddCustomLabelPolicyRequest](#addcustomlabelpolicyrequest)) -[AddCustomLabelPolicyResponse](#addcustomlabelpolicyresponse) - -Add a custom label policy for the organisation -With this policy the private labeling can be configured (colors, etc.) - - - - POST: /policies/label - - -### UpdateCustomLabelPolicy - -> **rpc** UpdateCustomLabelPolicy([UpdateCustomLabelPolicyRequest](#updatecustomlabelpolicyrequest)) -[UpdateCustomLabelPolicyResponse](#updatecustomlabelpolicyresponse) - -Changes the custom label policy for the organisation -With this policy the private labeling can be configured (colors, etc.) - - - - PUT: /policies/label - - -### ActivateCustomLabelPolicy - -> **rpc** ActivateCustomLabelPolicy([ActivateCustomLabelPolicyRequest](#activatecustomlabelpolicyrequest)) -[ActivateCustomLabelPolicyResponse](#activatecustomlabelpolicyresponse) - -Activates all changes of the label policy - - - - POST: /policies/label/_activate - - -### RemoveCustomLabelPolicyLogo - -> **rpc** RemoveCustomLabelPolicyLogo([RemoveCustomLabelPolicyLogoRequest](#removecustomlabelpolicylogorequest)) -[RemoveCustomLabelPolicyLogoResponse](#removecustomlabelpolicylogoresponse) - -Removes the logo of the label policy - - - - DELETE: /policies/label/logo - - -### RemoveCustomLabelPolicyLogoDark - -> **rpc** RemoveCustomLabelPolicyLogoDark([RemoveCustomLabelPolicyLogoDarkRequest](#removecustomlabelpolicylogodarkrequest)) -[RemoveCustomLabelPolicyLogoDarkResponse](#removecustomlabelpolicylogodarkresponse) - -Removes the logo dark of the label policy - - - - DELETE: /policies/label/logo_dark - - -### RemoveCustomLabelPolicyIcon - -> **rpc** RemoveCustomLabelPolicyIcon([RemoveCustomLabelPolicyIconRequest](#removecustomlabelpolicyiconrequest)) -[RemoveCustomLabelPolicyIconResponse](#removecustomlabelpolicyiconresponse) - -Removes the icon of the label policy - - - - DELETE: /policies/label/icon - - -### RemoveCustomLabelPolicyIconDark - -> **rpc** RemoveCustomLabelPolicyIconDark([RemoveCustomLabelPolicyIconDarkRequest](#removecustomlabelpolicyicondarkrequest)) -[RemoveCustomLabelPolicyIconDarkResponse](#removecustomlabelpolicyicondarkresponse) - -Removes the logo dark of the label policy - - - - DELETE: /policies/label/icon_dark - - -### RemoveCustomLabelPolicyFont - -> **rpc** RemoveCustomLabelPolicyFont([RemoveCustomLabelPolicyFontRequest](#removecustomlabelpolicyfontrequest)) -[RemoveCustomLabelPolicyFontResponse](#removecustomlabelpolicyfontresponse) - -Removes the font of the label policy - - - - DELETE: /policies/label/font - - -### ResetLabelPolicyToDefault - -> **rpc** ResetLabelPolicyToDefault([ResetLabelPolicyToDefaultRequest](#resetlabelpolicytodefaultrequest)) -[ResetLabelPolicyToDefaultResponse](#resetlabelpolicytodefaultresponse) - -Removes the custom label policy of the organisation -The default policy of the IAM will trigger after - - - - DELETE: /policies/label - - -### GetCustomInitMessageText - -> **rpc** GetCustomInitMessageText([GetCustomInitMessageTextRequest](#getcustominitmessagetextrequest)) -[GetCustomInitMessageTextResponse](#getcustominitmessagetextresponse) - -Returns the custom text for initial message - - - - GET: /text/message/init/{language} - - -### GetDefaultInitMessageText - -> **rpc** GetDefaultInitMessageText([GetDefaultInitMessageTextRequest](#getdefaultinitmessagetextrequest)) -[GetDefaultInitMessageTextResponse](#getdefaultinitmessagetextresponse) - -Returns the default text for initial message - - - - GET: /text/default/message/init/{language} - - -### SetCustomInitMessageText - -> **rpc** SetCustomInitMessageText([SetCustomInitMessageTextRequest](#setcustominitmessagetextrequest)) -[SetCustomInitMessageTextResponse](#setcustominitmessagetextresponse) - -Sets the custom text for initial message -The Following Variables can be used: -{{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} - - - - PUT: /text/message/init/{language} - - -### ResetCustomInitMessageTextToDefault - -> **rpc** ResetCustomInitMessageTextToDefault([ResetCustomInitMessageTextToDefaultRequest](#resetcustominitmessagetexttodefaultrequest)) -[ResetCustomInitMessageTextToDefaultResponse](#resetcustominitmessagetexttodefaultresponse) - -Removes the custom init message text of the organisation -The default text of the IAM will trigger after - - - - DELETE: /text/message/init/{language} - - -### GetCustomPasswordResetMessageText - -> **rpc** GetCustomPasswordResetMessageText([GetCustomPasswordResetMessageTextRequest](#getcustompasswordresetmessagetextrequest)) -[GetCustomPasswordResetMessageTextResponse](#getcustompasswordresetmessagetextresponse) - -Returns the custom text for password reset message - - - - GET: /text/message/passwordreset/{language} - - -### GetDefaultPasswordResetMessageText - -> **rpc** GetDefaultPasswordResetMessageText([GetDefaultPasswordResetMessageTextRequest](#getdefaultpasswordresetmessagetextrequest)) -[GetDefaultPasswordResetMessageTextResponse](#getdefaultpasswordresetmessagetextresponse) - -Returns the default text for password reset message - - - - GET: /text/default/message/passwordreset/{language} - - -### SetCustomPasswordResetMessageText - -> **rpc** SetCustomPasswordResetMessageText([SetCustomPasswordResetMessageTextRequest](#setcustompasswordresetmessagetextrequest)) -[SetCustomPasswordResetMessageTextResponse](#setcustompasswordresetmessagetextresponse) - -Sets the custom text for password reset message -The Following Variables can be used: -{{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/passwordreset/{language} - - -### ResetCustomPasswordResetMessageTextToDefault - -> **rpc** ResetCustomPasswordResetMessageTextToDefault([ResetCustomPasswordResetMessageTextToDefaultRequest](#resetcustompasswordresetmessagetexttodefaultrequest)) -[ResetCustomPasswordResetMessageTextToDefaultResponse](#resetcustompasswordresetmessagetexttodefaultresponse) - -Removes the custom password reset message text of the organisation -The default text of the IAM will trigger after - - - - DELETE: /text/message/verifyemail/{language} - - -### GetCustomVerifyEmailMessageText - -> **rpc** GetCustomVerifyEmailMessageText([GetCustomVerifyEmailMessageTextRequest](#getcustomverifyemailmessagetextrequest)) -[GetCustomVerifyEmailMessageTextResponse](#getcustomverifyemailmessagetextresponse) - -Returns the custom text for verify email message - - - - GET: /text/message/verifyemail/{language} - - -### GetDefaultVerifyEmailMessageText - -> **rpc** GetDefaultVerifyEmailMessageText([GetDefaultVerifyEmailMessageTextRequest](#getdefaultverifyemailmessagetextrequest)) -[GetDefaultVerifyEmailMessageTextResponse](#getdefaultverifyemailmessagetextresponse) - -Returns the default text for verify email message - - - - GET: /text/default/message/verifyemail/{language} - - -### SetCustomVerifyEmailMessageText - -> **rpc** SetCustomVerifyEmailMessageText([SetCustomVerifyEmailMessageTextRequest](#setcustomverifyemailmessagetextrequest)) -[SetCustomVerifyEmailMessageTextResponse](#setcustomverifyemailmessagetextresponse) - -Sets the custom text for verify email message -The Following Variables can be used: -{{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/verifyemail/{language} - - -### ResetCustomVerifyEmailMessageTextToDefault - -> **rpc** ResetCustomVerifyEmailMessageTextToDefault([ResetCustomVerifyEmailMessageTextToDefaultRequest](#resetcustomverifyemailmessagetexttodefaultrequest)) -[ResetCustomVerifyEmailMessageTextToDefaultResponse](#resetcustomverifyemailmessagetexttodefaultresponse) - -Removes the custom verify email message text of the organisation -The default text of the IAM will trigger after - - - - DELETE: /text/message/verifyemail/{language} - - -### GetCustomVerifyPhoneMessageText - -> **rpc** GetCustomVerifyPhoneMessageText([GetCustomVerifyPhoneMessageTextRequest](#getcustomverifyphonemessagetextrequest)) -[GetCustomVerifyPhoneMessageTextResponse](#getcustomverifyphonemessagetextresponse) - -Returns the custom text for verify email message - - - - GET: /text/message/verifyphone/{language} - - -### GetDefaultVerifyPhoneMessageText - -> **rpc** GetDefaultVerifyPhoneMessageText([GetDefaultVerifyPhoneMessageTextRequest](#getdefaultverifyphonemessagetextrequest)) -[GetDefaultVerifyPhoneMessageTextResponse](#getdefaultverifyphonemessagetextresponse) - -Returns the custom text for verify email message - - - - GET: /text/default/message/verifyphone/{language} - - -### SetCustomVerifyPhoneMessageText - -> **rpc** SetCustomVerifyPhoneMessageText([SetCustomVerifyPhoneMessageTextRequest](#setcustomverifyphonemessagetextrequest)) -[SetCustomVerifyPhoneMessageTextResponse](#setcustomverifyphonemessagetextresponse) - -Sets the default custom text for verify email message -The Following Variables can be used: -{{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/verifyphone/{language} - - -### ResetCustomVerifyPhoneMessageTextToDefault - -> **rpc** ResetCustomVerifyPhoneMessageTextToDefault([ResetCustomVerifyPhoneMessageTextToDefaultRequest](#resetcustomverifyphonemessagetexttodefaultrequest)) -[ResetCustomVerifyPhoneMessageTextToDefaultResponse](#resetcustomverifyphonemessagetexttodefaultresponse) - -Removes the custom verify phone text of the organisation -The default text of the IAM will trigger after - - - - DELETE: /text/message/verifyphone/{language} - - -### GetCustomDomainClaimedMessageText - -> **rpc** GetCustomDomainClaimedMessageText([GetCustomDomainClaimedMessageTextRequest](#getcustomdomainclaimedmessagetextrequest)) -[GetCustomDomainClaimedMessageTextResponse](#getcustomdomainclaimedmessagetextresponse) - -Returns the custom text for domain claimed message - - - - GET: /text/message/domainclaimed/{language} - - -### GetDefaultDomainClaimedMessageText - -> **rpc** GetDefaultDomainClaimedMessageText([GetDefaultDomainClaimedMessageTextRequest](#getdefaultdomainclaimedmessagetextrequest)) -[GetDefaultDomainClaimedMessageTextResponse](#getdefaultdomainclaimedmessagetextresponse) - -Returns the custom text for domain claimed message - - - - GET: /text/default/message/domainclaimed/{language} - - -### SetCustomDomainClaimedMessageCustomText - -> **rpc** SetCustomDomainClaimedMessageCustomText([SetCustomDomainClaimedMessageTextRequest](#setcustomdomainclaimedmessagetextrequest)) -[SetCustomDomainClaimedMessageTextResponse](#setcustomdomainclaimedmessagetextresponse) - -Sets the custom text for domain claimed message -The Following Variables can be used: -{{.Domain}} {{.TempUsername}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/domainclaimed/{language} - - -### ResetCustomDomainClaimedMessageTextToDefault - -> **rpc** ResetCustomDomainClaimedMessageTextToDefault([ResetCustomDomainClaimedMessageTextToDefaultRequest](#resetcustomdomainclaimedmessagetexttodefaultrequest)) -[ResetCustomDomainClaimedMessageTextToDefaultResponse](#resetcustomdomainclaimedmessagetexttodefaultresponse) - -Removes the custom domain claimed message text of the organisation -The default text of the IAM will trigger after - - - - DELETE: /text/message/domainclaimed/{language} - - -### GetCustomPasswordlessRegistrationMessageText - -> **rpc** GetCustomPasswordlessRegistrationMessageText([GetCustomPasswordlessRegistrationMessageTextRequest](#getcustompasswordlessregistrationmessagetextrequest)) -[GetCustomPasswordlessRegistrationMessageTextResponse](#getcustompasswordlessregistrationmessagetextresponse) - -Returns the custom text for passwordless link message - - - - GET: /text/message/passwordless_registration/{language} - - -### GetDefaultPasswordlessRegistrationMessageText - -> **rpc** GetDefaultPasswordlessRegistrationMessageText([GetDefaultPasswordlessRegistrationMessageTextRequest](#getdefaultpasswordlessregistrationmessagetextrequest)) -[GetDefaultPasswordlessRegistrationMessageTextResponse](#getdefaultpasswordlessregistrationmessagetextresponse) - -Returns the custom text for passwordless link message - - - - GET: /text/default/message/passwordless_registration/{language} - - -### SetCustomPasswordlessRegistrationMessageCustomText - -> **rpc** SetCustomPasswordlessRegistrationMessageCustomText([SetCustomPasswordlessRegistrationMessageTextRequest](#setcustompasswordlessregistrationmessagetextrequest)) -[SetCustomPasswordlessRegistrationMessageTextResponse](#setcustompasswordlessregistrationmessagetextresponse) - -Sets the custom text for passwordless link message -The Following Variables can be used: -{{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/passwordless_registration/{language} - - -### ResetCustomPasswordlessRegistrationMessageTextToDefault - -> **rpc** ResetCustomPasswordlessRegistrationMessageTextToDefault([ResetCustomPasswordlessRegistrationMessageTextToDefaultRequest](#resetcustompasswordlessregistrationmessagetexttodefaultrequest)) -[ResetCustomPasswordlessRegistrationMessageTextToDefaultResponse](#resetcustompasswordlessregistrationmessagetexttodefaultresponse) - -Removes the custom passwordless link message text of the organisation -The default text of the IAM will trigger after - - - - DELETE: /text/message/passwordless_registration/{language} - - -### GetCustomPasswordChangeMessageText - -> **rpc** GetCustomPasswordChangeMessageText([GetCustomPasswordChangeMessageTextRequest](#getcustompasswordchangemessagetextrequest)) -[GetCustomPasswordChangeMessageTextResponse](#getcustompasswordchangemessagetextresponse) - -Returns the custom text for password change message - - - - GET: /text/message/password_change/{language} - - -### GetDefaultPasswordChangeMessageText - -> **rpc** GetDefaultPasswordChangeMessageText([GetDefaultPasswordChangeMessageTextRequest](#getdefaultpasswordchangemessagetextrequest)) -[GetDefaultPasswordChangeMessageTextResponse](#getdefaultpasswordchangemessagetextresponse) - -Returns the custom text for password change link message - - - - GET: /text/default/message/password_change/{language} - - -### SetCustomPasswordChangeMessageCustomText - -> **rpc** SetCustomPasswordChangeMessageCustomText([SetCustomPasswordChangeMessageTextRequest](#setcustompasswordchangemessagetextrequest)) -[SetCustomPasswordChangeMessageTextResponse](#setcustompasswordchangemessagetextresponse) - -Sets the custom text for password change message -The Following Variables can be used: -{{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} - - - - PUT: /text/message/password_change/{language} - - -### ResetCustomPasswordChangeMessageTextToDefault - -> **rpc** ResetCustomPasswordChangeMessageTextToDefault([ResetCustomPasswordChangeMessageTextToDefaultRequest](#resetcustompasswordchangemessagetexttodefaultrequest)) -[ResetCustomPasswordChangeMessageTextToDefaultResponse](#resetcustompasswordchangemessagetexttodefaultresponse) - -Removes the custom password change message text of the organisation -The default text of the IAM will trigger after - - - - DELETE: /text/message/password_change/{language} - - -### GetCustomLoginTexts - -> **rpc** GetCustomLoginTexts([GetCustomLoginTextsRequest](#getcustomlogintextsrequest)) -[GetCustomLoginTextsResponse](#getcustomlogintextsresponse) - -Returns the custom texts for login ui - - - - GET: /text/login/{language} - - -### GetDefaultLoginTexts - -> **rpc** GetDefaultLoginTexts([GetDefaultLoginTextsRequest](#getdefaultlogintextsrequest)) -[GetDefaultLoginTextsResponse](#getdefaultlogintextsresponse) - -Returns the custom texts for login ui - - - - GET: /text/default/login/{language} - - -### SetCustomLoginText - -> **rpc** SetCustomLoginText([SetCustomLoginTextsRequest](#setcustomlogintextsrequest)) -[SetCustomLoginTextsResponse](#setcustomlogintextsresponse) - -Sets the default custom text for login ui -it impacts all organisations without customized login ui texts - - - - PUT: /text/login/{language} - - -### ResetCustomLoginTextToDefault - -> **rpc** ResetCustomLoginTextToDefault([ResetCustomLoginTextsToDefaultRequest](#resetcustomlogintextstodefaultrequest)) -[ResetCustomLoginTextsToDefaultResponse](#resetcustomlogintextstodefaultresponse) - -Removes the custom login text of the organisation -The default text of the IAM will trigger after - - - - DELETE: /text/login/{language} - - -### GetOrgIDPByID - -> **rpc** GetOrgIDPByID([GetOrgIDPByIDRequest](#getorgidpbyidrequest)) -[GetOrgIDPByIDResponse](#getorgidpbyidresponse) - -Returns a identity provider configuration of the organisation - - - - GET: /idps/{id} - - -### ListOrgIDPs - -> **rpc** ListOrgIDPs([ListOrgIDPsRequest](#listorgidpsrequest)) -[ListOrgIDPsResponse](#listorgidpsresponse) - -Returns all identity provider configuration in the organisation, which match the query -Limit should always be set, there is a default limit set by the service - - - - POST: /idps/_search - - -### AddOrgOIDCIDP - -> **rpc** AddOrgOIDCIDP([AddOrgOIDCIDPRequest](#addorgoidcidprequest)) -[AddOrgOIDCIDPResponse](#addorgoidcidpresponse) - -Add a new identity provider configuration in the organisation -Provider must be OIDC compliant - - - - POST: /idps/oidc - - -### AddOrgJWTIDP - -> **rpc** AddOrgJWTIDP([AddOrgJWTIDPRequest](#addorgjwtidprequest)) -[AddOrgJWTIDPResponse](#addorgjwtidpresponse) - -Add a new jwt identity provider configuration in the organisation - - - - POST: /idps/jwt - - -### DeactivateOrgIDP - -> **rpc** DeactivateOrgIDP([DeactivateOrgIDPRequest](#deactivateorgidprequest)) -[DeactivateOrgIDPResponse](#deactivateorgidpresponse) - -Deactivate identity provider configuration -Users will not be able to use this provider for login (e.g Google, Microsoft, AD, etc) -Returns error if already deactivated - - - - POST: /idps/{idp_id}/_deactivate - - -### ReactivateOrgIDP - -> **rpc** ReactivateOrgIDP([ReactivateOrgIDPRequest](#reactivateorgidprequest)) -[ReactivateOrgIDPResponse](#reactivateorgidpresponse) - -Activate identity provider configuration -Returns error if not deactivated - - - - POST: /idps/{idp_id}/_reactivate - - -### RemoveOrgIDP - -> **rpc** RemoveOrgIDP([RemoveOrgIDPRequest](#removeorgidprequest)) -[RemoveOrgIDPResponse](#removeorgidpresponse) - -Removes identity provider configuration -Will remove all linked providers of this configuration on the users - - - - DELETE: /idps/{idp_id} - - -### UpdateOrgIDP - -> **rpc** UpdateOrgIDP([UpdateOrgIDPRequest](#updateorgidprequest)) -[UpdateOrgIDPResponse](#updateorgidpresponse) - -Change identity provider configuration of the organisation - - - - PUT: /idps/{idp_id} - - -### UpdateOrgIDPOIDCConfig - -> **rpc** UpdateOrgIDPOIDCConfig([UpdateOrgIDPOIDCConfigRequest](#updateorgidpoidcconfigrequest)) -[UpdateOrgIDPOIDCConfigResponse](#updateorgidpoidcconfigresponse) - -Change OIDC identity provider configuration of the organisation - - - - PUT: /idps/{idp_id}/oidc_config - - -### UpdateOrgIDPJWTConfig - -> **rpc** UpdateOrgIDPJWTConfig([UpdateOrgIDPJWTConfigRequest](#updateorgidpjwtconfigrequest)) -[UpdateOrgIDPJWTConfigResponse](#updateorgidpjwtconfigresponse) - -Change JWT identity provider configuration of the organisation - - - - PUT: /idps/{idp_id}/jwt_config - - -### ListProviders - -> **rpc** ListProviders([ListProvidersRequest](#listprovidersrequest)) -[ListProvidersResponse](#listprovidersresponse) - -Returns all identity providers, which match the query -Limit should always be set, there is a default limit set by the service - - - - POST: /idps/templates/_search - - -### GetProviderByID - -> **rpc** GetProviderByID([GetProviderByIDRequest](#getproviderbyidrequest)) -[GetProviderByIDResponse](#getproviderbyidresponse) - -Returns an identity provider of the organisation - - - - GET: /idps/templates/{id} - - -### AddGoogleProvider - -> **rpc** AddGoogleProvider([AddGoogleProviderRequest](#addgoogleproviderrequest)) -[AddGoogleProviderResponse](#addgoogleproviderresponse) - -Add a new Google identity provider in the organisation - - - - POST: /idps/google - - -### UpdateGoogleProvider - -> **rpc** UpdateGoogleProvider([UpdateGoogleProviderRequest](#updategoogleproviderrequest)) -[UpdateGoogleProviderResponse](#updategoogleproviderresponse) - -Change an existing Google identity provider in the organisation - - - - PUT: /idps/google/{id} - - -### AddLDAPProvider - -> **rpc** AddLDAPProvider([AddLDAPProviderRequest](#addldapproviderrequest)) -[AddLDAPProviderResponse](#addldapproviderresponse) - -Add a new LDAP identity provider in the organisation - - - - POST: /idps/ldap - - -### UpdateLDAPProvider - -> **rpc** UpdateLDAPProvider([UpdateLDAPProviderRequest](#updateldapproviderrequest)) -[UpdateLDAPProviderResponse](#updateldapproviderresponse) - -Change an existing LDAP identity provider in the organisation - - - - PUT: /idps/ldap/{id} - - -### DeleteProvider - -> **rpc** DeleteProvider([DeleteProviderRequest](#deleteproviderrequest)) -[DeleteProviderResponse](#deleteproviderresponse) - -Remove an identity provider -Will remove all linked providers of this configuration on the users - - - - DELETE: /idps/templates/{id} - - -### ListActions - -> **rpc** ListActions([ListActionsRequest](#listactionsrequest)) -[ListActionsResponse](#listactionsresponse) - - - - - - POST: /actions/_search - - -### GetAction - -> **rpc** GetAction([GetActionRequest](#getactionrequest)) -[GetActionResponse](#getactionresponse) - - - - - - GET: /actions/{id} - - -### CreateAction - -> **rpc** CreateAction([CreateActionRequest](#createactionrequest)) -[CreateActionResponse](#createactionresponse) - - - - - - POST: /actions - - -### UpdateAction - -> **rpc** UpdateAction([UpdateActionRequest](#updateactionrequest)) -[UpdateActionResponse](#updateactionresponse) - - - - - - PUT: /actions/{id} - - -### DeactivateAction - -> **rpc** DeactivateAction([DeactivateActionRequest](#deactivateactionrequest)) -[DeactivateActionResponse](#deactivateactionresponse) - - - - - - POST: /actions/{id}/_deactivate - - -### ReactivateAction - -> **rpc** ReactivateAction([ReactivateActionRequest](#reactivateactionrequest)) -[ReactivateActionResponse](#reactivateactionresponse) - - - - - - POST: /actions/{id}/_reactivate - - -### DeleteAction - -> **rpc** DeleteAction([DeleteActionRequest](#deleteactionrequest)) -[DeleteActionResponse](#deleteactionresponse) - - - - - - DELETE: /actions/{id} - - -### ListFlowTypes - -> **rpc** ListFlowTypes([ListFlowTypesRequest](#listflowtypesrequest)) -[ListFlowTypesResponse](#listflowtypesresponse) - - - - - - POST: /flows/types/_search - - -### ListFlowTriggerTypes - -> **rpc** ListFlowTriggerTypes([ListFlowTriggerTypesRequest](#listflowtriggertypesrequest)) -[ListFlowTriggerTypesResponse](#listflowtriggertypesresponse) - - - - - - POST: /flows/{type}/triggers/_search - - -### GetFlow - -> **rpc** GetFlow([GetFlowRequest](#getflowrequest)) -[GetFlowResponse](#getflowresponse) - - - - - - GET: /flows/{type} - - -### ClearFlow - -> **rpc** ClearFlow([ClearFlowRequest](#clearflowrequest)) -[ClearFlowResponse](#clearflowresponse) - - - - - - POST: /flows/{type}/_clear - - -### SetTriggerActions - -> **rpc** SetTriggerActions([SetTriggerActionsRequest](#settriggeractionsrequest)) -[SetTriggerActionsResponse](#settriggeractionsresponse) - - - - - - POST: /flows/{flow_type}/trigger/{trigger_type} - - - - - - - -## Messages - - -### ActionQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.action_id_query | zitadel.action.v1.ActionIDQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.action_name_query | zitadel.action.v1.ActionNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.action_state_query | zitadel.action.v1.ActionStateQuery | - | | - - - - -### ActivateCustomLabelPolicyRequest -This is an empty request - - - - -### ActivateCustomLabelPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddAPIAppRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.min_len: 1
string.max_len: 200
| -| auth_method_type | zitadel.app.v1.APIAuthMethodType | - | enum.defined_only: true
| - - - - -### AddAPIAppResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| app_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| client_id | string | - | | -| client_secret | string | - | | - - - - -### AddAppKeyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| -| type | zitadel.authn.v1.KeyType | - | enum.defined_only: true
enum.not_in: [0]
| -| expiration_date | google.protobuf.Timestamp | - | | - - - - -### AddAppKeyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| key_details | bytes | - | | - - - - -### AddCustomLabelPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| primary_color | string | - | string.max_len: 50
| -| hide_login_name_suffix | bool | hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set | | -| warn_color | string | - | string.max_len: 50
| -| background_color | string | - | string.max_len: 50
| -| font_color | string | - | string.max_len: 50
| -| primary_color_dark | string | - | string.max_len: 50
| -| background_color_dark | string | - | string.max_len: 50
| -| warn_color_dark | string | - | string.max_len: 50
| -| font_color_dark | string | - | string.max_len: 50
| -| disable_watermark | bool | - | | - - - - -### AddCustomLabelPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddCustomLockoutPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| max_password_attempts | uint32 | - | | - - - - -### AddCustomLockoutPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddCustomLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| allow_username_password | bool | - | | -| allow_register | bool | - | | -| allow_external_idp | bool | - | | -| force_mfa | bool | - | | -| passwordless_type | zitadel.policy.v1.PasswordlessType | - | enum.defined_only: true
| -| hide_password_reset | bool | - | | -| ignore_unknown_usernames | bool | - | | -| default_redirect_uri | string | - | | -| password_check_lifetime | google.protobuf.Duration | - | | -| external_login_check_lifetime | google.protobuf.Duration | - | | -| mfa_init_skip_lifetime | google.protobuf.Duration | - | | -| second_factor_check_lifetime | google.protobuf.Duration | - | | -| multi_factor_check_lifetime | google.protobuf.Duration | - | | -| second_factors | repeated zitadel.policy.v1.SecondFactorType | - | | -| multi_factors | repeated zitadel.policy.v1.MultiFactorType | - | | -| idps | repeated AddCustomLoginPolicyRequest.IDP | - | | -| allow_domain_discovery | bool | If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success. | | -| disable_login_with_email | bool | - | | -| disable_login_with_phone | bool | - | | - - - - -### AddCustomLoginPolicyRequest.IDP - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| -| ownerType | zitadel.idp.v1.IDPOwnerType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### AddCustomLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddCustomNotificationPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| password_change | bool | - | | - - - - -### AddCustomNotificationPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddCustomPasswordAgePolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| max_age_days | uint32 | - | | -| expire_warn_days | uint32 | - | | - - - - -### AddCustomPasswordAgePolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddCustomPasswordComplexityPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| min_length | uint64 | - | | -| has_uppercase | bool | - | | -| has_lowercase | bool | - | | -| has_number | bool | - | | -| has_symbol | bool | - | | - - - - -### AddCustomPasswordComplexityPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddCustomPrivacyPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| tos_link | string | - | | -| privacy_link | string | - | | -| help_link | string | - | | - - - - -### AddCustomPrivacyPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddGoogleProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | Google will be used as default, if no name is provided | string.max_len: 200
| -| client_id | string | - | string.min_len: 1
string.max_len: 200
| -| client_secret | string | - | string.min_len: 1
string.max_len: 200
| -| scopes | repeated string | - | repeated.max_items: 20
repeated.items.string.min_len: 1
repeated.items.string.max_len: 100
| -| provider_options | zitadel.idp.v1.Options | - | | - - - - -### AddGoogleProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| id | string | - | | - - - - -### AddHumanUserRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_name | string | - | string.min_len: 1
string.max_len: 200
| -| profile | AddHumanUserRequest.Profile | - | message.required: true
| -| email | AddHumanUserRequest.Email | - | message.required: true
| -| phone | AddHumanUserRequest.Phone | - | | -| initial_password | string | - | | - - - - -### AddHumanUserRequest.Email - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| email | string | - | string.email: true
| -| is_email_verified | bool | - | | - - - - -### AddHumanUserRequest.Phone - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| phone | string | has to be a global number | string.min_len: 1
string.max_len: 50
string.prefix: +
| -| is_phone_verified | bool | - | | - - - - -### AddHumanUserRequest.Profile - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| first_name | string | - | string.min_len: 1
string.max_len: 200
| -| last_name | string | - | string.min_len: 1
string.max_len: 200
| -| nick_name | string | - | string.max_len: 200
| -| display_name | string | - | string.max_len: 200
| -| preferred_language | string | - | string.max_len: 10
| -| gender | zitadel.user.v1.Gender | - | | - - - - -### AddHumanUserResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddIDPToLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| -| ownerType | zitadel.idp.v1.IDPOwnerType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### AddIDPToLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddLDAPProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.min_len: 1
string.max_len: 200
| -| host | string | - | string.min_len: 1
string.max_len: 200
| -| port | string | - | string.max_len: 5
| -| tls | bool | - | | -| base_dn | string | - | string.min_len: 1
string.max_len: 200
| -| user_object_class | string | - | string.min_len: 1
string.max_len: 200
| -| user_unique_attribute | string | - | string.min_len: 1
string.max_len: 200
| -| admin | string | - | string.min_len: 1
string.max_len: 200
| -| password | string | - | string.min_len: 1
string.max_len: 200
| -| attributes | zitadel.idp.v1.LDAPAttributes | - | | -| provider_options | zitadel.idp.v1.Options | - | | - - - - -### AddLDAPProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| id | string | - | | - - - - -### AddMachineKeyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
| -| type | zitadel.authn.v1.KeyType | - | enum.defined_only: true
enum.not_in: [0]
| -| expiration_date | google.protobuf.Timestamp | - | | - - - - -### AddMachineKeyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key_id | string | - | | -| key_details | bytes | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddMachineUserRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_name | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.min_len: 1
string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| access_token_type | zitadel.user.v1.AccessTokenType | - | enum.defined_only: true
| - - - - -### AddMachineUserResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddMultiFactorToLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | zitadel.policy.v1.MultiFactorType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### AddMultiFactorToLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddOIDCAppRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.min_len: 1
string.max_len: 200
| -| redirect_uris | repeated string | - | | -| response_types | repeated zitadel.app.v1.OIDCResponseType | - | | -| grant_types | repeated zitadel.app.v1.OIDCGrantType | - | | -| app_type | zitadel.app.v1.OIDCAppType | - | enum.defined_only: true
| -| auth_method_type | zitadel.app.v1.OIDCAuthMethodType | - | enum.defined_only: true
| -| post_logout_redirect_uris | repeated string | - | | -| version | zitadel.app.v1.OIDCVersion | - | enum.defined_only: true
| -| dev_mode | bool | - | | -| access_token_type | zitadel.app.v1.OIDCTokenType | - | enum.defined_only: true
| -| access_token_role_assertion | bool | - | | -| id_token_role_assertion | bool | - | | -| id_token_userinfo_assertion | bool | - | | -| clock_skew | google.protobuf.Duration | - | duration.lte.seconds: 5
duration.lte.nanos: 0
duration.gte.seconds: 0
duration.gte.nanos: 0
| -| additional_origins | repeated string | - | | - - - - -### AddOIDCAppResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| app_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| client_id | string | - | | -| client_secret | string | - | | -| none_compliant | bool | - | | -| compliance_problems | repeated zitadel.v1.LocalizedMessage | - | | - - - - -### AddOrgDomainRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| domain | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### AddOrgDomainResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddOrgJWTIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.min_len: 1
string.max_len: 200
| -| styling_type | zitadel.idp.v1.IDPStylingType | - | enum.defined_only: true
| -| jwt_endpoint | string | - | string.min_len: 1
string.max_len: 200
| -| issuer | string | - | string.min_len: 1
string.max_len: 200
| -| keys_endpoint | string | - | string.min_len: 1
string.max_len: 200
| -| header_name | string | - | string.min_len: 1
string.max_len: 200
| -| auto_register | bool | - | | - - - - -### AddOrgJWTIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| idp_id | string | - | | - - - - -### AddOrgMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| roles | repeated string | - | | - - - - -### AddOrgMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddOrgOIDCIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.min_len: 1
string.max_len: 200
| -| styling_type | zitadel.idp.v1.IDPStylingType | - | enum.defined_only: true
| -| client_id | string | - | string.min_len: 1
string.max_len: 200
| -| client_secret | string | - | string.min_len: 1
string.max_len: 200
| -| issuer | string | - | string.min_len: 1
string.max_len: 200
| -| scopes | repeated string | - | | -| display_name_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true
| -| username_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true
| -| auto_register | bool | - | | - - - - -### AddOrgOIDCIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| idp_id | string | - | | - - - - -### AddOrgRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### AddOrgResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddPasswordlessRegistrationRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### AddPasswordlessRegistrationResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| link | string | - | | -| expiration | google.protobuf.Duration | - | | - - - - -### AddPersonalAccessTokenRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
| -| expiration_date | google.protobuf.Timestamp | - | | - - - - -### AddPersonalAccessTokenResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| token_id | string | - | | -| token | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddProjectGrantMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| roles | repeated string | - | | - - - - -### AddProjectGrantMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddProjectGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| granted_org_id | string | - | string.min_len: 1
string.max_len: 200
| -| role_keys | repeated string | - | | - - - - -### AddProjectGrantResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| grant_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddProjectMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| roles | repeated string | - | | - - - - -### AddProjectMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddProjectRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.min_len: 1
string.max_len: 200
| -| project_role_assertion | bool | - | | -| project_role_check | bool | - | | -| has_project_check | bool | - | | -| private_labeling_setting | zitadel.project.v1.PrivateLabelingSetting | - | enum.defined_only: true
| - - - - -### AddProjectResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddProjectRoleRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| role_key | string | - | string.min_len: 1
string.max_len: 200
| -| display_name | string | - | string.min_len: 1
string.max_len: 200
| -| group | string | - | string.max_len: 200
| - - - - -### AddProjectRoleResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddSAMLAppRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.min_len: 1
string.max_len: 200
| -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) metadata.metadata_xml | bytes | - | bytes.max_len: 500000
| -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) metadata.metadata_url | string | - | string.max_len: 200
| - - - - -### AddSAMLAppResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| app_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddSecondFactorToLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | zitadel.policy.v1.SecondFactorType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### AddSecondFactorToLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddUserGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| project_grant_id | string | - | string.max_len: 200
| -| role_keys | repeated string | - | | - - - - -### AddUserGrantResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_grant_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### BulkAddProjectRolesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| roles | repeated BulkAddProjectRolesRequest.Role | - | | - - - - -### BulkAddProjectRolesRequest.Role - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.min_len: 1
string.max_len: 200
| -| display_name | string | - | string.min_len: 1
string.max_len: 200
| -| group | string | - | string.max_len: 200
| - - - - -### BulkAddProjectRolesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### BulkRemoveOrgMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| keys | repeated string | - | repeated.items.string.min_len: 1
repeated.items.string.max_len: 200
| - - - - -### BulkRemoveOrgMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### BulkRemoveUserGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| grant_id | repeated string | - | | - - - - -### BulkRemoveUserGrantResponse - - - - - -### BulkRemoveUserMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| keys | repeated string | - | repeated.items.string.min_len: 1
repeated.items.string.max_len: 200
| - - - - -### BulkRemoveUserMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### BulkSetOrgMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| metadata | repeated BulkSetOrgMetadataRequest.Metadata | - | | - - - - -### BulkSetOrgMetadataRequest.Metadata - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.min_len: 1
string.max_len: 200
| -| value | bytes | - | bytes.min_len: 1
bytes.max_len: 500000
| - - - - -### BulkSetOrgMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### BulkSetUserMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| metadata | repeated BulkSetUserMetadataRequest.Metadata | - | | - - - - -### BulkSetUserMetadataRequest.Metadata - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.min_len: 1
string.max_len: 200
| -| value | bytes | - | bytes.min_len: 1
bytes.max_len: 500000
| - - - - -### BulkSetUserMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ClearFlowRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | string | id of the flow | | - - - - -### ClearFlowResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### CreateActionRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.min_len: 1
string.max_len: 200
| -| script | string | - | string.min_len: 1
string.max_len: 2000
| -| timeout | google.protobuf.Duration | - | duration.lte.seconds: 20
duration.lte.nanos: 0
duration.gte.seconds: 0
duration.gte.nanos: 0
| -| allowed_to_fail | bool | - | | - - - - -### CreateActionResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| id | string | - | | - - - - -### DeactivateActionRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | - - - - -### DeactivateActionResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### DeactivateAppRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### DeactivateAppResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### DeactivateOrgIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### DeactivateOrgIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### DeactivateOrgRequest -This is an empty request - - - - -### DeactivateOrgResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### DeactivateProjectGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### DeactivateProjectGrantResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### DeactivateProjectRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### DeactivateProjectResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### DeactivateUserGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### DeactivateUserGrantResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### DeactivateUserRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### DeactivateUserResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### DeleteActionRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | - - - - -### DeleteActionResponse - - - - - -### DeleteProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### DeleteProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### GenerateMachineSecretRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
| - - - - -### GenerateMachineSecretResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| client_id | string | - | | -| client_secret | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### GenerateOrgDomainValidationRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| domain | string | - | string.min_len: 1
string.max_len: 200
| -| type | zitadel.org.v1.DomainValidationType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### GenerateOrgDomainValidationResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| token | string | - | | -| url | string | - | | - - - - -### GetActionRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | - - - - -### GetActionResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| action | zitadel.action.v1.Action | - | | - - - - -### GetAppByIDRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetAppByIDResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| app | zitadel.app.v1.App | - | | - - - - -### GetAppKeyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| -| key_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetAppKeyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | zitadel.authn.v1.Key | - | | - - - - -### GetCustomDomainClaimedMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomDomainClaimedMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomInitMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomInitMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomLoginTextsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomLoginTextsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.LoginCustomText | - | | - - - - -### GetCustomPasswordChangeMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomPasswordChangeMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomPasswordResetMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomPasswordResetMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomPasswordlessRegistrationMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomPasswordlessRegistrationMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomVerifyEmailMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomVerifyEmailMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetCustomVerifyPhoneMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetCustomVerifyPhoneMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultDomainClaimedMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultDomainClaimedMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultInitMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultInitMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultLabelPolicyRequest -This is an empty request - - - - -### GetDefaultLabelPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LabelPolicy | - | | - - - - -### GetDefaultLockoutPolicyRequest -This is an empty request - - - - -### GetDefaultLockoutPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LockoutPolicy | - | | - - - - -### GetDefaultLoginPolicyRequest - - - - - -### GetDefaultLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LoginPolicy | - | | - - - - -### GetDefaultLoginTextsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultLoginTextsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.LoginCustomText | - | | - - - - -### GetDefaultNotificationPolicyRequest -This is an empty request - - - - -### GetDefaultNotificationPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.NotificationPolicy | - | | - - - - -### GetDefaultPasswordAgePolicyRequest -This is an empty request - - - - -### GetDefaultPasswordAgePolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.PasswordAgePolicy | - | | - - - - -### GetDefaultPasswordChangeMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultPasswordChangeMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultPasswordComplexityPolicyRequest -This is an empty request - - - - -### GetDefaultPasswordComplexityPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.PasswordComplexityPolicy | - | | - - - - -### GetDefaultPasswordResetMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultPasswordResetMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultPasswordlessRegistrationMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultPasswordlessRegistrationMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultPrivacyPolicyRequest -This is an empty request - - - - -### GetDefaultPrivacyPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.PrivacyPolicy | - | | - - - - -### GetDefaultVerifyEmailMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultVerifyEmailMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDefaultVerifyPhoneMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetDefaultVerifyPhoneMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| custom_text | zitadel.text.v1.MessageCustomText | - | | - - - - -### GetDomainPolicyRequest - - - - - -### GetDomainPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.DomainPolicy | - | | - - - - -### GetFlowRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | string | id of the flow | | - - - - -### GetFlowResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| flow | zitadel.action.v1.Flow | - | | - - - - -### GetGrantedProjectByIDRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetGrantedProjectByIDResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| granted_project | zitadel.project.v1.GrantedProject | - | | - - - - -### GetHumanEmailRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetHumanEmailResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| email | zitadel.user.v1.Email | - | | - - - - -### GetHumanPhoneRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetHumanPhoneResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| phone | zitadel.user.v1.Phone | - | | - - - - -### GetHumanProfileRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetHumanProfileResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| profile | zitadel.user.v1.Profile | - | | - - - - -### GetIAMRequest -This is an empty request - - - - -### GetIAMResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| global_org_id | string | deprecated: use default_org_id instead | | -| iam_project_id | string | - | | -| default_org_id | string | - | | - - - - -### GetLabelPolicyRequest -This is an empty request - - - - -### GetLabelPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LabelPolicy | - | | -| is_default | bool | deprecated: is_default is also defined in zitadel.policy.v1.LabelPolicy | | - - - - -### GetLockoutPolicyRequest -This is an empty request - - - - -### GetLockoutPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LockoutPolicy | - | | -| is_default | bool | deprecated: is_default is also defined in zitadel.policy.v1.LockoutPolicy | | - - - - -### GetLoginPolicyRequest - - - - - -### GetLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LoginPolicy | - | | -| is_default | bool | deprecated: is_default is also defined in zitadel.policy.v1.LoginPolicy | | - - - - -### GetMachineKeyByIDsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| key_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetMachineKeyByIDsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | zitadel.authn.v1.Key | - | | - - - - -### GetMyOrgRequest -This is an empty request - - - - -### GetMyOrgResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org | zitadel.org.v1.Org | - | | - - - - -### GetNotificationPolicyRequest -This is an empty request - - - - -### GetNotificationPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.NotificationPolicy | - | | - - - - -### GetOIDCInformationRequest -This is an empty request - - - - -### GetOIDCInformationResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| issuer | string | - | | -| discovery_endpoint | string | - | | - - - - -### GetOrgByDomainGlobalRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| domain | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetOrgByDomainGlobalResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org | zitadel.org.v1.Org | - | | - - - - -### GetOrgIAMPolicyRequest - - - - - -### GetOrgIAMPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.OrgIAMPolicy | - | | - - - - -### GetOrgIDPByIDRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetOrgIDPByIDResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp | zitadel.idp.v1.IDP | - | | - - - - -### GetOrgMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetOrgMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| metadata | zitadel.metadata.v1.Metadata | - | | - - - - -### GetPasswordAgePolicyRequest -This is an empty request - - - - -### GetPasswordAgePolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.PasswordAgePolicy | - | | -| is_default | bool | deprecated: is_default is also defined in zitadel.policy.v1.PasswordAgePolicy | | - - - - -### GetPasswordComplexityPolicyRequest - - - - - -### GetPasswordComplexityPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.PasswordComplexityPolicy | - | | -| is_default | bool | deprecated: is_default is also defined in zitadel.policy.v1.PasswordComplexityPolicy | | - - - - -### GetPersonalAccessTokenByIDsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| token_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetPersonalAccessTokenByIDsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| token | zitadel.user.v1.PersonalAccessToken | - | | - - - - -### GetPreviewLabelPolicyRequest -This is an empty request - - - - -### GetPreviewLabelPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.LabelPolicy | - | | -| is_default | bool | deprecated: is_default is also defined in zitadel.policy.v1.LabelPolicy | | - - - - -### GetPrivacyPolicyRequest -This is an empty request - - - - -### GetPrivacyPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| policy | zitadel.policy.v1.PrivacyPolicy | - | | - - - - -### GetProjectByIDRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetProjectByIDResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project | zitadel.project.v1.Project | - | | - - - - -### GetProjectGrantByIDRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetProjectGrantByIDResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_grant | zitadel.project.v1.GrantedProject | - | | - - - - -### GetProviderByIDRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetProviderByIDResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp | zitadel.idp.v1.Provider | - | | - - - - -### GetSupportedLanguagesRequest -This is an empty request - - - - -### GetSupportedLanguagesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| languages | repeated string | - | | - - - - -### GetUserByIDRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetUserByIDResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user | zitadel.user.v1.User | - | | - - - - -### GetUserByLoginNameGlobalRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| login_name | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetUserByLoginNameGlobalResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user | zitadel.user.v1.User | - | | - - - - -### GetUserGrantByIDRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetUserGrantByIDResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_grant | zitadel.user.v1.UserGrant | - | | - - - - -### GetUserMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| key | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetUserMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| metadata | zitadel.metadata.v1.Metadata | - | | - - - - -### HealthzRequest -This is an empty request - - - - -### HealthzResponse -This is an empty response - - - - -### IDPQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.idp_id_query | zitadel.idp.v1.IDPIDQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.idp_name_query | zitadel.idp.v1.IDPNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.owner_type_query | zitadel.idp.v1.IDPOwnerTypeQuery | - | | - - - - -### ImportHumanUserRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_name | string | - | string.min_len: 1
string.max_len: 200
| -| profile | ImportHumanUserRequest.Profile | - | message.required: true
| -| email | ImportHumanUserRequest.Email | - | message.required: true
| -| phone | ImportHumanUserRequest.Phone | - | | -| password | string | - | | -| hashed_password | ImportHumanUserRequest.HashedPassword | - | | -| password_change_required | bool | - | | -| request_passwordless_registration | bool | - | | -| otp_code | string | - | | -| idps | repeated ImportHumanUserRequest.IDP | - | | - - - - -### ImportHumanUserRequest.Email - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| email | string | - | string.email: true
| -| is_email_verified | bool | - | | - - - - -### ImportHumanUserRequest.HashedPassword - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| value | string | - | | -| algorithm | string | - | | - - - - -### ImportHumanUserRequest.IDP - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| config_id | string | internal id of the IDP in ZITADEL | string.min_len: 1
string.max_len: 200
| -| external_user_id | string | id of the user on the IDP | string.min_len: 1
string.max_len: 200
| -| display_name | string | (display) name of the user on the IDP | string.max_len: 200
| - - - - -### ImportHumanUserRequest.Phone - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| phone | string | has to be a global number | string.min_len: 1
string.max_len: 50
string.prefix: +
| -| is_phone_verified | bool | - | | - - - - -### ImportHumanUserRequest.Profile - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| first_name | string | - | string.min_len: 1
string.max_len: 200
| -| last_name | string | - | string.min_len: 1
string.max_len: 200
| -| nick_name | string | - | string.max_len: 200
| -| display_name | string | - | string.max_len: 200
| -| preferred_language | string | - | string.max_len: 10
| -| gender | zitadel.user.v1.Gender | - | | - - - - -### ImportHumanUserResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| passwordless_registration | ImportHumanUserResponse.PasswordlessRegistration | - | | - - - - -### ImportHumanUserResponse.PasswordlessRegistration - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| link | string | - | | -| lifetime | google.protobuf.Duration | deprecated: use expiration instead | | -| expiration | google.protobuf.Duration | - | | - - - - -### IsUserUniqueRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_name | string | - | string.max_len: 200
| -| email | string | - | string.max_len: 200
| - - - - -### IsUserUniqueResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| is_unique | bool | - | | - - - - -### ListActionsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| sorting_column | zitadel.action.v1.ActionFieldName | the field the result is sorted | | -| queries | repeated ActionQuery | criteria the client is looking for | | - - - - -### ListActionsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| sorting_column | zitadel.action.v1.ActionFieldName | - | | -| result | repeated zitadel.action.v1.Action | - | | - - - - -### ListAllProjectGrantsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.project.v1.AllProjectGrantQuery | criterias the client is looking for | | - - - - -### ListAllProjectGrantsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.project.v1.GrantedProject | - | | - - - - -### ListAppChangesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.change.v1.ChangeQuery | list limitations and ordering | | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ListAppChangesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.change.v1.Change | zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) | | - - - - -### ListAppKeysRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| app_id | string | - | string.min_len: 1
string.max_len: 200
| -| project_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ListAppKeysResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.authn.v1.Key | - | | - - - - -### ListAppsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.app.v1.AppQuery | criterias the client is looking for | | - - - - -### ListAppsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.app.v1.App | - | | - - - - -### ListFlowTriggerTypesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | string | - | | - - - - -### ListFlowTriggerTypesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.action.v1.TriggerType | - | | - - - - -### ListFlowTypesRequest - - - - - -### ListFlowTypesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.action.v1.FlowType | - | | - - - - -### ListGrantedProjectRolesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.project.v1.RoleQuery | criterias the client is looking for | | - - - - -### ListGrantedProjectRolesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.project.v1.Role | - | | - - - - -### ListGrantedProjectsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.project.v1.ProjectQuery | criterias the client is looking for | | - - - - -### ListGrantedProjectsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.project.v1.GrantedProject | - | | - - - - -### ListHumanAuthFactorsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ListHumanAuthFactorsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.user.v1.AuthFactor | - | | - - - - -### ListHumanLinkedIDPsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | list limitations and ordering | | - - - - -### ListHumanLinkedIDPsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.idp.v1.IDPUserLink | - | | - - - - -### ListHumanPasswordlessRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ListHumanPasswordlessResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.user.v1.WebAuthNToken | - | | - - - - -### ListLoginPolicyIDPsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | - | | - - - - -### ListLoginPolicyIDPsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.idp.v1.IDPLoginPolicyLink | - | | - - - - -### ListLoginPolicyMultiFactorsRequest - - - - - -### ListLoginPolicyMultiFactorsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.policy.v1.MultiFactorType | - | | - - - - -### ListLoginPolicySecondFactorsRequest - - - - - -### ListLoginPolicySecondFactorsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.policy.v1.SecondFactorType | - | | - - - - -### ListMachineKeysRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | list limitations and ordering | | - - - - -### ListMachineKeysResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.authn.v1.Key | - | | - - - - -### ListOrgChangesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.change.v1.ChangeQuery | list limitations and ordering | | - - - - -### ListOrgChangesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.change.v1.Change | zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) | | - - - - -### ListOrgDomainsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.org.v1.DomainSearchQuery | criterias the client is looking for | | - - - - -### ListOrgDomainsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.org.v1.Domain | - | | - - - - -### ListOrgIDPsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| sorting_column | zitadel.idp.v1.IDPFieldName | the field the result is sorted | | -| queries | repeated IDPQuery | criterias the client is looking for | | - - - - -### ListOrgIDPsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| sorting_column | zitadel.idp.v1.IDPFieldName | - | | -| result | repeated zitadel.idp.v1.IDP | - | | - - - - -### ListOrgMemberRolesRequest -This is an empty request - - - - -### ListOrgMemberRolesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated string | - | | - - - - -### ListOrgMembersRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.member.v1.SearchQuery | criterias the client is looking for | | - - - - -### ListOrgMembersResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | list limitations and ordering | | -| result | repeated zitadel.member.v1.Member | criterias the client is looking for | | - - - - -### ListOrgMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | - | | -| queries | repeated zitadel.metadata.v1.MetadataQuery | - | | - - - - -### ListOrgMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.metadata.v1.Metadata | - | | - - - - -### ListPersonalAccessTokensRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | list limitations and ordering | | - - - - -### ListPersonalAccessTokensResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.user.v1.PersonalAccessToken | - | | - - - - -### ListProjectChangesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.change.v1.ChangeQuery | list limitations and ordering | | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ListProjectChangesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.change.v1.Change | zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) | | - - - - -### ListProjectGrantChangesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.change.v1.ChangeQuery | list limitations and ordering | | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ListProjectGrantChangesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.change.v1.Change | zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) | | - - - - -### ListProjectGrantMemberRolesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | - | | -| result | repeated string | - | | - - - - -### ListProjectGrantMemberRolesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated string | - | | - - - - -### ListProjectGrantMembersRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.member.v1.SearchQuery | criterias the client is looking for | | - - - - -### ListProjectGrantMembersResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.member.v1.Member | - | | - - - - -### ListProjectGrantsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.project.v1.ProjectGrantQuery | criterias the client is looking for | | - - - - -### ListProjectGrantsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.project.v1.GrantedProject | - | | - - - - -### ListProjectMemberRolesRequest -This is an empty request - - - - -### ListProjectMemberRolesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated string | - | | - - - - -### ListProjectMembersRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.member.v1.SearchQuery | criterias the client is looking for | | - - - - -### ListProjectMembersResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.member.v1.Member | - | | - - - - -### ListProjectRolesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.project.v1.RoleQuery | criterias the client is looking for | | - - - - -### ListProjectRolesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.project.v1.Role | - | | - - - - -### ListProjectsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.project.v1.ProjectQuery | criterias the client is looking for | | - - - - -### ListProjectsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.project.v1.Project | - | | - - - - -### ListProvidersRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated ProviderQuery | criteria the client is looking for | | - - - - -### ListProvidersResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.idp.v1.Provider | - | | - - - - -### ListUserChangesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.change.v1.ChangeQuery | list limitations and ordering | | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ListUserChangesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated zitadel.change.v1.Change | zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) | | - - - - -### ListUserGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| queries | repeated zitadel.user.v1.UserGrantQuery | criterias the client is looking for | | - - - - -### ListUserGrantResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.user.v1.UserGrant | - | | - - - - -### ListUserMembershipsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | list limitations and ordering | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | the field the result is sorted | | -| queries | repeated zitadel.user.v1.MembershipQuery | criterias the client is looking for | | - - - - -### ListUserMembershipsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.user.v1.Membership | - | | - - - - -### ListUserMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | - | | -| queries | repeated zitadel.metadata.v1.MetadataQuery | - | | - - - - -### ListUserMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.metadata.v1.Metadata | - | | - - - - -### ListUsersRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| sorting_column | zitadel.user.v1.UserFieldName | the field the result is sorted | | -| queries | repeated zitadel.user.v1.SearchQuery | criterias the client is looking for | | - - - - -### ListUsersResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| sorting_column | zitadel.user.v1.UserFieldName | - | | -| result | repeated zitadel.user.v1.User | - | | - - - - -### LockUserRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### LockUserResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ProviderQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.idp_id_query | zitadel.idp.v1.IDPIDQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.idp_name_query | zitadel.idp.v1.IDPNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.owner_type_query | zitadel.idp.v1.IDPOwnerTypeQuery | - | | - - - - -### ReactivateActionRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | - - - - -### ReactivateActionResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ReactivateAppRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ReactivateAppResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ReactivateOrgIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ReactivateOrgIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ReactivateOrgRequest -This is an empty request - - - - -### ReactivateOrgResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ReactivateProjectGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ReactivateProjectGrantResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ReactivateProjectRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ReactivateProjectResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ReactivateUserGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ReactivateUserGrantResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ReactivateUserRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ReactivateUserResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RegenerateAPIClientSecretRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RegenerateAPIClientSecretResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| client_secret | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RegenerateOIDCClientSecretRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RegenerateOIDCClientSecretResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| client_secret | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveAppKeyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| -| key_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveAppKeyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveAppRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveAppResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveCustomLabelPolicyFontRequest -This is an empty request - - - - -### RemoveCustomLabelPolicyFontResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveCustomLabelPolicyIconDarkRequest -This is an empty request - - - - -### RemoveCustomLabelPolicyIconDarkResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveCustomLabelPolicyIconRequest -This is an empty request - - - - -### RemoveCustomLabelPolicyIconResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveCustomLabelPolicyLogoDarkRequest -This is an empty request - - - - -### RemoveCustomLabelPolicyLogoDarkResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveCustomLabelPolicyLogoRequest -This is an empty request - - - - -### RemoveCustomLabelPolicyLogoResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveHumanAuthFactorOTPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveHumanAuthFactorOTPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveHumanAuthFactorU2FRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| token_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveHumanAuthFactorU2FResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveHumanAvatarRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveHumanAvatarResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveHumanLinkedIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| -| linked_user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveHumanLinkedIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveHumanPasswordlessRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| token_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveHumanPasswordlessResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveHumanPhoneRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveHumanPhoneResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveIDPFromLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveIDPFromLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveMachineKeyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| key_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveMachineKeyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveMachineSecretRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveMachineSecretResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveMultiFactorFromLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | zitadel.policy.v1.MultiFactorType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### RemoveMultiFactorFromLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveOrgDomainRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| domain | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveOrgDomainResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveOrgIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveOrgIDPResponse -This is an empty response - - - - -### RemoveOrgMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveOrgMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveOrgMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveOrgMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveOrgRequest - - - - - -### RemoveOrgResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemovePersonalAccessTokenRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| token_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemovePersonalAccessTokenResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveProjectGrantMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveProjectGrantMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveProjectGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveProjectGrantResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveProjectMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveProjectMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveProjectRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveProjectResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveProjectRoleRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| role_key | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveProjectRoleResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveSecondFactorFromLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | zitadel.policy.v1.SecondFactorType | - | enum.defined_only: true
enum.not_in: [0]
| - - - - -### RemoveSecondFactorFromLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveUserGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveUserGrantResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveUserMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| key | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveUserMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveUserRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveUserResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResendHumanEmailVerificationRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResendHumanEmailVerificationResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResendHumanInitializationRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| email | string | - | string.email: true
string.ignore_empty: true
| - - - - -### ResendHumanInitializationResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResendHumanPhoneVerificationRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResendHumanPhoneVerificationResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomDomainClaimedMessageTextToDefaultRequest -This is an empty request - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomDomainClaimedMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomInitMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomInitMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomLoginTextsToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomLoginTextsToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomPasswordChangeMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomPasswordChangeMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomPasswordResetMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomPasswordResetMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomPasswordlessRegistrationMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomPasswordlessRegistrationMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomVerifyEmailMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomVerifyEmailMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetCustomVerifyPhoneMessageTextToDefaultRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ResetCustomVerifyPhoneMessageTextToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetLabelPolicyToDefaultRequest -This is an empty request - - - - -### ResetLabelPolicyToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetLockoutPolicyToDefaultRequest -This is an empty request - - - - -### ResetLockoutPolicyToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetLoginPolicyToDefaultRequest - - - - - -### ResetLoginPolicyToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetNotificationPolicyToDefaultRequest -This is an empty request - - - - -### ResetNotificationPolicyToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetPasswordAgePolicyToDefaultRequest -This is an empty request - - - - -### ResetPasswordAgePolicyToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetPasswordComplexityPolicyToDefaultRequest -This is an empty request - - - - -### ResetPasswordComplexityPolicyToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ResetPrivacyPolicyToDefaultRequest -This is an empty request - - - - -### ResetPrivacyPolicyToDefaultResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SendHumanResetPasswordNotificationRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| type | SendHumanResetPasswordNotificationRequest.Type | - | enum.defined_only: true
| - - - - -### SendHumanResetPasswordNotificationResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SendPasswordlessRegistrationRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### SendPasswordlessRegistrationResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetCustomDomainClaimedMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetCustomDomainClaimedMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetCustomInitMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetCustomInitMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetCustomLoginTextsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| select_account_text | zitadel.text.v1.SelectAccountScreenText | - | | -| login_text | zitadel.text.v1.LoginScreenText | - | | -| password_text | zitadel.text.v1.PasswordScreenText | - | | -| username_change_text | zitadel.text.v1.UsernameChangeScreenText | - | | -| username_change_done_text | zitadel.text.v1.UsernameChangeDoneScreenText | - | | -| init_password_text | zitadel.text.v1.InitPasswordScreenText | - | | -| init_password_done_text | zitadel.text.v1.InitPasswordDoneScreenText | - | | -| email_verification_text | zitadel.text.v1.EmailVerificationScreenText | - | | -| email_verification_done_text | zitadel.text.v1.EmailVerificationDoneScreenText | - | | -| initialize_user_text | zitadel.text.v1.InitializeUserScreenText | - | | -| initialize_done_text | zitadel.text.v1.InitializeUserDoneScreenText | - | | -| init_mfa_prompt_text | zitadel.text.v1.InitMFAPromptScreenText | - | | -| init_mfa_otp_text | zitadel.text.v1.InitMFAOTPScreenText | - | | -| init_mfa_u2f_text | zitadel.text.v1.InitMFAU2FScreenText | - | | -| init_mfa_done_text | zitadel.text.v1.InitMFADoneScreenText | - | | -| mfa_providers_text | zitadel.text.v1.MFAProvidersText | - | | -| verify_mfa_otp_text | zitadel.text.v1.VerifyMFAOTPScreenText | - | | -| verify_mfa_u2f_text | zitadel.text.v1.VerifyMFAU2FScreenText | - | | -| passwordless_text | zitadel.text.v1.PasswordlessScreenText | - | | -| password_change_text | zitadel.text.v1.PasswordChangeScreenText | - | | -| password_change_done_text | zitadel.text.v1.PasswordChangeDoneScreenText | - | | -| password_reset_done_text | zitadel.text.v1.PasswordResetDoneScreenText | - | | -| registration_option_text | zitadel.text.v1.RegistrationOptionScreenText | - | | -| registration_user_text | zitadel.text.v1.RegistrationUserScreenText | - | | -| registration_org_text | zitadel.text.v1.RegistrationOrgScreenText | - | | -| linking_user_done_text | zitadel.text.v1.LinkingUserDoneScreenText | - | | -| external_user_not_found_text | zitadel.text.v1.ExternalUserNotFoundScreenText | - | | -| success_login_text | zitadel.text.v1.SuccessLoginScreenText | - | | -| logout_text | zitadel.text.v1.LogoutDoneScreenText | - | | -| footer_text | zitadel.text.v1.FooterText | - | | -| passwordless_prompt_text | zitadel.text.v1.PasswordlessPromptScreenText | - | | -| passwordless_registration_text | zitadel.text.v1.PasswordlessRegistrationScreenText | - | | -| passwordless_registration_done_text | zitadel.text.v1.PasswordlessRegistrationDoneScreenText | - | | -| external_registration_user_overview_text | zitadel.text.v1.ExternalRegistrationUserOverviewScreenText | - | | - - - - -### SetCustomLoginTextsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetCustomPasswordChangeMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetCustomPasswordChangeMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetCustomPasswordResetMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetCustomPasswordResetMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetCustomPasswordlessRegistrationMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetCustomPasswordlessRegistrationMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetCustomVerifyEmailMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetCustomVerifyEmailMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetCustomVerifyPhoneMessageTextRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| language | string | - | string.min_len: 1
string.max_len: 200
| -| title | string | - | string.max_len: 200
| -| pre_header | string | - | string.max_len: 200
| -| subject | string | - | string.max_len: 200
| -| greeting | string | - | string.max_len: 200
| -| text | string | - | string.max_len: 800
| -| button_text | string | - | string.max_len: 200
| -| footer_text | string | - | string.max_len: 200
| - - - - -### SetCustomVerifyPhoneMessageTextResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetHumanInitialPasswordRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
| -| password | string | - | string.min_len: 1
string.max_len: 72
| - - - - -### SetHumanInitialPasswordResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetHumanPasswordRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
| -| password | string | - | string.min_len: 1
string.max_len: 72
| -| no_change_required | bool | - | | - - - - -### SetHumanPasswordResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetOrgMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.min_len: 1
string.max_len: 200
| -| value | bytes | - | bytes.min_len: 1
bytes.max_len: 500000
| - - - - -### SetOrgMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetPrimaryOrgDomainRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| domain | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### SetPrimaryOrgDomainResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetTriggerActionsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| flow_type | string | id of the flow type | | -| trigger_type | string | id of the trigger type | | -| action_ids | repeated string | - | | - - - - -### SetTriggerActionsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetUserMetadataRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| key | string | - | string.min_len: 1
string.max_len: 200
| -| value | bytes | - | bytes.min_len: 1
bytes.max_len: 500000
| - - - - -### SetUserMetadataResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UnlockUserRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### UnlockUserResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateAPIAppConfigRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| -| auth_method_type | zitadel.app.v1.APIAuthMethodType | - | enum.defined_only: true
| - - - - -### UpdateAPIAppConfigResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateActionRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.min_len: 1
string.max_len: 200
| -| script | string | - | string.min_len: 1
string.max_len: 2000
| -| timeout | google.protobuf.Duration | - | duration.lte.seconds: 20
duration.lte.nanos: 0
duration.gte.seconds: 0
duration.gte.nanos: 0
| -| allowed_to_fail | bool | - | | - - - - -### UpdateActionResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateAppRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### UpdateAppResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateCustomLabelPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| primary_color | string | - | string.max_len: 50
| -| hide_login_name_suffix | bool | - | | -| warn_color | string | - | string.max_len: 50
| -| background_color | string | - | string.max_len: 50
| -| font_color | string | - | string.max_len: 50
| -| primary_color_dark | string | - | string.max_len: 50
| -| background_color_dark | string | - | string.max_len: 50
| -| warn_color_dark | string | - | string.max_len: 50
| -| font_color_dark | string | - | string.max_len: 50
| -| disable_watermark | bool | - | | - - - - -### UpdateCustomLabelPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateCustomLockoutPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| max_password_attempts | uint32 | - | | - - - - -### UpdateCustomLockoutPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateCustomLoginPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| allow_username_password | bool | - | | -| allow_register | bool | - | | -| allow_external_idp | bool | - | | -| force_mfa | bool | - | | -| passwordless_type | zitadel.policy.v1.PasswordlessType | - | enum.defined_only: true
| -| hide_password_reset | bool | - | | -| ignore_unknown_usernames | bool | - | | -| default_redirect_uri | string | - | | -| password_check_lifetime | google.protobuf.Duration | - | | -| external_login_check_lifetime | google.protobuf.Duration | - | | -| mfa_init_skip_lifetime | google.protobuf.Duration | - | | -| second_factor_check_lifetime | google.protobuf.Duration | - | | -| multi_factor_check_lifetime | google.protobuf.Duration | - | | -| allow_domain_discovery | bool | If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success. | | -| disable_login_with_email | bool | - | | -| disable_login_with_phone | bool | - | | - - - - -### UpdateCustomLoginPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateCustomNotificationPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| password_change | bool | - | | - - - - -### UpdateCustomNotificationPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateCustomPasswordAgePolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| max_age_days | uint32 | - | | -| expire_warn_days | uint32 | - | | - - - - -### UpdateCustomPasswordAgePolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateCustomPasswordComplexityPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| min_length | uint64 | - | | -| has_uppercase | bool | - | | -| has_lowercase | bool | - | | -| has_number | bool | - | | -| has_symbol | bool | - | | - - - - -### UpdateCustomPasswordComplexityPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateCustomPrivacyPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| tos_link | string | - | | -| privacy_link | string | - | | -| help_link | string | - | | - - - - -### UpdateCustomPrivacyPolicyResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateGoogleProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.max_len: 200
| -| client_id | string | - | string.min_len: 1
string.max_len: 200
| -| client_secret | string | client_secret will only be updated if provided | string.max_len: 200
| -| scopes | repeated string | - | repeated.max_items: 20
repeated.items.string.min_len: 1
repeated.items.string.max_len: 100
| -| provider_options | zitadel.idp.v1.Options | - | | - - - - -### UpdateGoogleProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateHumanEmailRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| email | string | - | string.email: true
| -| is_email_verified | bool | - | | - - - - -### UpdateHumanEmailResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateHumanPhoneRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| phone | string | - | string.min_len: 1
string.max_len: 50
string.prefix: +
| -| is_phone_verified | bool | - | | - - - - -### UpdateHumanPhoneResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateHumanProfileRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| first_name | string | - | string.min_len: 1
string.max_len: 200
| -| last_name | string | - | string.min_len: 1
string.max_len: 200
| -| nick_name | string | - | string.max_len: 200
| -| display_name | string | - | string.min_len: 1
string.max_len: 200
| -| preferred_language | string | - | string.max_len: 10
| -| gender | zitadel.user.v1.Gender | - | | - - - - -### UpdateHumanProfileResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateLDAPProviderRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.min_len: 1
string.max_len: 200
| -| host | string | - | string.min_len: 1
string.max_len: 200
| -| port | string | - | string.max_len: 5
| -| tls | bool | - | | -| base_dn | string | - | string.min_len: 1
string.max_len: 200
| -| user_object_class | string | - | string.min_len: 1
string.max_len: 200
| -| user_unique_attribute | string | - | string.min_len: 1
string.max_len: 200
| -| admin | string | - | string.min_len: 1
string.max_len: 200
| -| password | string | - | string.max_len: 200
| -| attributes | zitadel.idp.v1.LDAPAttributes | - | | -| provider_options | zitadel.idp.v1.Options | - | | - - - - -### UpdateLDAPProviderResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateMachineRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| name | string | - | string.min_len: 1
string.max_len: 200
| -| access_token_type | zitadel.user.v1.AccessTokenType | - | enum.defined_only: true
| - - - - -### UpdateMachineResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateOIDCAppConfigRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| -| redirect_uris | repeated string | - | | -| response_types | repeated zitadel.app.v1.OIDCResponseType | - | | -| grant_types | repeated zitadel.app.v1.OIDCGrantType | - | | -| app_type | zitadel.app.v1.OIDCAppType | - | enum.defined_only: true
| -| auth_method_type | zitadel.app.v1.OIDCAuthMethodType | - | enum.defined_only: true
| -| post_logout_redirect_uris | repeated string | - | | -| dev_mode | bool | - | | -| access_token_type | zitadel.app.v1.OIDCTokenType | - | enum.defined_only: true
| -| access_token_role_assertion | bool | - | | -| id_token_role_assertion | bool | - | | -| id_token_userinfo_assertion | bool | - | | -| clock_skew | google.protobuf.Duration | - | duration.lte.seconds: 5
duration.lte.nanos: 0
duration.gte.seconds: 0
duration.gte.nanos: 0
| -| additional_origins | repeated string | - | | - - - - -### UpdateOIDCAppConfigResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateOrgIDPJWTConfigRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| -| jwt_endpoint | string | - | string.min_len: 1
string.max_len: 200
| -| issuer | string | - | string.min_len: 1
string.max_len: 200
| -| keys_endpoint | string | - | string.min_len: 1
string.max_len: 200
| -| header_name | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### UpdateOrgIDPJWTConfigResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateOrgIDPOIDCConfigRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| -| client_id | string | - | string.min_len: 1
string.max_len: 200
| -| client_secret | string | - | string.max_len: 200
| -| issuer | string | - | string.min_len: 1
string.max_len: 200
| -| scopes | repeated string | - | | -| display_name_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true
| -| username_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true
| - - - - -### UpdateOrgIDPOIDCConfigResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateOrgIDPRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.min_len: 1
string.max_len: 200
| -| styling_type | zitadel.idp.v1.IDPStylingType | - | enum.defined_only: true
| -| auto_register | bool | - | | - - - - -### UpdateOrgIDPResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateOrgMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| roles | repeated string | - | | - - - - -### UpdateOrgMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateOrgRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### UpdateOrgResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateProjectGrantMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| roles | repeated string | - | | - - - - -### UpdateProjectGrantMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateProjectGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| -| role_keys | repeated string | - | | - - - - -### UpdateProjectGrantResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateProjectMemberRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| roles | repeated string | - | | - - - - -### UpdateProjectMemberResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateProjectRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | string.min_len: 1
string.max_len: 200
| -| name | string | - | string.min_len: 1
string.max_len: 200
| -| project_role_assertion | bool | - | | -| project_role_check | bool | - | | -| has_project_check | bool | - | | -| private_labeling_setting | zitadel.project.v1.PrivateLabelingSetting | - | enum.defined_only: true
| - - - - -### UpdateProjectResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateProjectRoleRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| role_key | string | - | string.min_len: 1
string.max_len: 200
| -| display_name | string | - | string.min_len: 1
string.max_len: 200
| -| group | string | - | string.max_len: 200
| - - - - -### UpdateProjectRoleResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateSAMLAppConfigRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.min_len: 1
string.max_len: 200
| -| app_id | string | - | string.min_len: 1
string.max_len: 200
| -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) metadata.metadata_xml | bytes | - | bytes.max_len: 500000
| -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) metadata.metadata_url | string | - | string.max_len: 200
| - - - - -### UpdateSAMLAppConfigResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateUserGrantRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| grant_id | string | - | string.min_len: 1
string.max_len: 200
| -| role_keys | repeated string | - | | - - - - -### UpdateUserGrantResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateUserNameRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_name | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### UpdateUserNameResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ValidateOrgDomainRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| domain | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ValidateOrgDomainResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - - - diff --git a/docs/docs/apis/proto/member.md b/docs/docs/apis/proto/member.md deleted file mode 100644 index 3d5bfe5ea..000000000 --- a/docs/docs/apis/proto/member.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: zitadel/member.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### EmailQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| email | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### FirstNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| first_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### LastNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| last_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### Member - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| roles | repeated string | - | | -| preferred_login_name | string | - | | -| email | string | - | | -| first_name | string | - | | -| last_name | string | - | | -| display_name | string | - | | -| avatar_url | string | - | | - - - - -### SearchQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.first_name_query | FirstNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.last_name_query | LastNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.email_query | EmailQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.user_id_query | UserIDQuery | - | | - - - - -### UserIDQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.max_len: 200
| - - - - - - diff --git a/docs/docs/apis/proto/message.md b/docs/docs/apis/proto/message.md deleted file mode 100644 index 98909286e..000000000 --- a/docs/docs/apis/proto/message.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: zitadel/message.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### ErrorDetail - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| message | string | - | | - - - - -### LocalizedMessage - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | | -| localized_message | string | - | | - - - - - - diff --git a/docs/docs/apis/proto/metadata.md b/docs/docs/apis/proto/metadata.md deleted file mode 100644 index d98216162..000000000 --- a/docs/docs/apis/proto/metadata.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: zitadel/metadata.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### Metadata - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| key | string | - | | -| value | bytes | - | | - - - - -### MetadataKeyQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### MetadataQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.key_query | MetadataKeyQuery | - | | - - - - - - diff --git a/docs/docs/apis/proto/object.md b/docs/docs/apis/proto/object.md deleted file mode 100644 index 1f925fe37..000000000 --- a/docs/docs/apis/proto/object.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: zitadel/object.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### ListDetails - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| total_result | uint64 | - | | -| processed_sequence | uint64 | - | | -| view_timestamp | google.protobuf.Timestamp | - | | - - - - -### ListQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| offset | uint64 | - | | -| limit | uint32 | - | | -| asc | bool | - | | - - - - -### ObjectDetails - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| sequence | uint64 | sequence represents the order of events. It's always upcounting - -on read: the sequence of the last event reduced by the projection - -on manipulation: the timestamp of the event(s) added by the manipulation | | -| creation_date | google.protobuf.Timestamp | creation_date is the timestamp where the first operation on the object was made - -on read: the timestamp of the first event of the object - -on create: the timestamp of the event(s) added by the manipulation | | -| change_date | google.protobuf.Timestamp | change_date is the timestamp when the object was changed - -on read: the timestamp of the last event reduced by the projection - -on manipulation: the | | -| resource_owner | string | resource_owner is the organisation an object belongs to | | - - - - - - -## Enums - - -### ListQueryMethod {#listquerymethod} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| LIST_QUERY_METHOD_IN | 0 | - | - - - - -### TextQueryMethod {#textquerymethod} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| TEXT_QUERY_METHOD_EQUALS | 0 | - | -| TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE | 1 | - | -| TEXT_QUERY_METHOD_STARTS_WITH | 2 | - | -| TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE | 3 | - | -| TEXT_QUERY_METHOD_CONTAINS | 4 | - | -| TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE | 5 | - | -| TEXT_QUERY_METHOD_ENDS_WITH | 6 | - | -| TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE | 7 | - | - - - - diff --git a/docs/docs/apis/proto/options.md b/docs/docs/apis/proto/options.md deleted file mode 100644 index 4270bc94d..000000000 --- a/docs/docs/apis/proto/options.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: zitadel/options.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### AuthOption - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| permission | string | - | | -| check_field_name | string | - | | - - - - - - diff --git a/docs/docs/apis/proto/org.md b/docs/docs/apis/proto/org.md deleted file mode 100644 index ba28470de..000000000 --- a/docs/docs/apis/proto/org.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: zitadel/org.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### Domain - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| domain_name | string | - | | -| is_verified | bool | - | | -| is_primary | bool | - | | -| validation_type | DomainValidationType | - | | - - - - -### DomainNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### DomainSearchQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.domain_name_query | DomainNameQuery | - | | - - - - -### Org - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| state | OrgState | - | | -| name | string | - | | -| primary_domain | string | - | | - - - - -### OrgDomainQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| domain | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### OrgNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### OrgQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.name_query | OrgNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.domain_query | OrgDomainQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.state_query | OrgStateQuery | - | | - - - - -### OrgStateQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| state | OrgState | - | enum.defined_only: true
| - - - - - - -## Enums - - -### DomainValidationType {#domainvalidationtype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| DOMAIN_VALIDATION_TYPE_UNSPECIFIED | 0 | - | -| DOMAIN_VALIDATION_TYPE_HTTP | 1 | - | -| DOMAIN_VALIDATION_TYPE_DNS | 2 | - | - - - - -### OrgFieldName {#orgfieldname} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| ORG_FIELD_NAME_UNSPECIFIED | 0 | - | -| ORG_FIELD_NAME_NAME | 1 | - | - - - - -### OrgState {#orgstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| ORG_STATE_UNSPECIFIED | 0 | - | -| ORG_STATE_ACTIVE | 1 | - | -| ORG_STATE_INACTIVE | 2 | - | -| ORG_STATE_REMOVED | 3 | - | - - - - diff --git a/docs/docs/apis/proto/policy.md b/docs/docs/apis/proto/policy.md deleted file mode 100644 index ff5b6fb04..000000000 --- a/docs/docs/apis/proto/policy.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -title: zitadel/policy.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### DomainPolicy - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| user_login_must_be_domain | bool | - | | -| is_default | bool | - | | -| validate_org_domains | bool | - | | -| smtp_sender_address_matches_instance_domain | bool | - | | - - - - -### LabelPolicy - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| primary_color | string | hex value for primary color | | -| is_default | bool | defines if the organisation's admin changed the policy | | -| hide_login_name_suffix | bool | hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set | | -| warn_color | string | hex value for secondary color | | -| background_color | string | hex value for background color | | -| font_color | string | hex value for font color | | -| primary_color_dark | string | hex value for primary color dark theme | | -| background_color_dark | string | hex value for background color dark theme | | -| warn_color_dark | string | hex value for warn color dark theme | | -| font_color_dark | string | hex value for font color dark theme | | -| disable_watermark | bool | - | | -| logo_url | string | - | | -| icon_url | string | - | | -| logo_url_dark | string | - | | -| icon_url_dark | string | - | | -| font_url | string | - | | - - - - -### LockoutPolicy - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| max_password_attempts | uint64 | - | | -| is_default | bool | - | | - - - - -### LoginPolicy - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| allow_username_password | bool | - | | -| allow_register | bool | - | | -| allow_external_idp | bool | - | | -| force_mfa | bool | - | | -| passwordless_type | PasswordlessType | - | | -| is_default | bool | - | | -| hide_password_reset | bool | - | | -| ignore_unknown_usernames | bool | - | | -| default_redirect_uri | string | - | | -| password_check_lifetime | google.protobuf.Duration | - | | -| external_login_check_lifetime | google.protobuf.Duration | - | | -| mfa_init_skip_lifetime | google.protobuf.Duration | - | | -| second_factor_check_lifetime | google.protobuf.Duration | - | | -| multi_factor_check_lifetime | google.protobuf.Duration | - | | -| second_factors | repeated SecondFactorType | - | | -| multi_factors | repeated MultiFactorType | - | | -| idps | repeated zitadel.idp.v1.IDPLoginPolicyLink | - | | -| allow_domain_discovery | bool | If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success. | | -| disable_login_with_email | bool | - | | -| disable_login_with_phone | bool | - | | - - - - -### NotificationPolicy - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| is_default | bool | - | | -| password_change | bool | - | | - - - - -### OrgIAMPolicy -deprecated: please use DomainPolicy instead - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| user_login_must_be_domain | bool | - | | -| is_default | bool | - | | - - - - -### PasswordAgePolicy - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| max_age_days | uint64 | - | | -| expire_warn_days | uint64 | - | | -| is_default | bool | - | | - - - - -### PasswordComplexityPolicy - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| min_length | uint64 | - | | -| has_uppercase | bool | - | | -| has_lowercase | bool | - | | -| has_number | bool | - | | -| has_symbol | bool | - | | -| is_default | bool | - | | - - - - -### PrivacyPolicy - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| tos_link | string | - | | -| privacy_link | string | - | | -| is_default | bool | - | | -| help_link | string | - | | - - - - - - -## Enums - - -### MultiFactorType {#multifactortype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| MULTI_FACTOR_TYPE_UNSPECIFIED | 0 | - | -| MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION | 1 | - | - - - - -### PasswordlessType {#passwordlesstype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| PASSWORDLESS_TYPE_NOT_ALLOWED | 0 | - | -| PASSWORDLESS_TYPE_ALLOWED | 1 | PLANNED: PASSWORDLESS_TYPE_WITH_CERT | - - - - -### SecondFactorType {#secondfactortype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| SECOND_FACTOR_TYPE_UNSPECIFIED | 0 | - | -| SECOND_FACTOR_TYPE_OTP | 1 | - | -| SECOND_FACTOR_TYPE_U2F | 2 | - | - - - - diff --git a/docs/docs/apis/proto/project.md b/docs/docs/apis/proto/project.md deleted file mode 100644 index c5d89e072..000000000 --- a/docs/docs/apis/proto/project.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -title: zitadel/project.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### AllProjectGrantQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_name_query | GrantProjectNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.role_key_query | GrantRoleKeyQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_id_query | ProjectIDQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.granted_org_id_query | GrantedOrgIDQuery | - | | - - - - -### GrantProjectNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### GrantRoleKeyQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| role_key | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### GrantedOrgIDQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| granted_org_id | string | - | string.max_len: 200
| - - - - -### GrantedProject - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| grant_id | string | - | | -| granted_org_id | string | - | | -| granted_org_name | string | - | | -| granted_role_keys | repeated string | - | | -| state | ProjectGrantState | - | | -| project_id | string | - | | -| project_name | string | - | | -| project_owner_id | string | - | | -| project_owner_name | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### Project - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| name | string | - | | -| state | ProjectState | - | | -| project_role_assertion | bool | describes if roles of user should be added in token | | -| project_role_check | bool | ZITADEL checks if the user has at least one on this project | | -| has_project_check | bool | ZITADEL checks if the org of the user has permission to this project | | -| private_labeling_setting | PrivateLabelingSetting | Defines from where the private labeling should be triggered | | - - - - -### ProjectGrantQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_name_query | GrantProjectNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.role_key_query | GrantRoleKeyQuery | - | | - - - - -### ProjectIDQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.max_len: 200
| - - - - -### ProjectNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### ProjectQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.name_query | ProjectNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_resource_owner_query | ProjectResourceOwnerQuery | - | | - - - - -### ProjectResourceOwnerQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| resource_owner | string | - | string.max_len: 200
| - - - - -### Role - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| display_name | string | - | | -| group | string | - | | - - - - -### RoleDisplayNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| display_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### RoleKeyQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### RoleQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.key_query | RoleKeyQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.display_name_query | RoleDisplayNameQuery | - | | - - - - - - -## Enums - - -### PrivateLabelingSetting {#privatelabelingsetting} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| PRIVATE_LABELING_SETTING_UNSPECIFIED | 0 | - | -| PRIVATE_LABELING_SETTING_ENFORCE_PROJECT_RESOURCE_OWNER_POLICY | 1 | - | -| PRIVATE_LABELING_SETTING_ALLOW_LOGIN_USER_RESOURCE_OWNER_POLICY | 2 | - | - - - - -### ProjectGrantState {#projectgrantstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| PROJECT_GRANT_STATE_UNSPECIFIED | 0 | - | -| PROJECT_GRANT_STATE_ACTIVE | 1 | - | -| PROJECT_GRANT_STATE_INACTIVE | 2 | - | - - - - -### ProjectState {#projectstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| PROJECT_STATE_UNSPECIFIED | 0 | - | -| PROJECT_STATE_ACTIVE | 1 | - | -| PROJECT_STATE_INACTIVE | 2 | - | - - - - diff --git a/docs/docs/apis/proto/settings.md b/docs/docs/apis/proto/settings.md deleted file mode 100644 index c4aa2962c..000000000 --- a/docs/docs/apis/proto/settings.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -title: zitadel/settings.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### DebugNotificationProvider - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| compact | bool | - | | - - - - -### OIDCSettings - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| access_token_lifetime | google.protobuf.Duration | - | | -| id_token_lifetime | google.protobuf.Duration | - | | -| refresh_token_idle_expiration | google.protobuf.Duration | - | | -| refresh_token_expiration | google.protobuf.Duration | - | | - - - - -### SMSProvider - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| id | string | - | | -| state | SMSProviderConfigState | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.twilio | TwilioConfig | - | | - - - - -### SMTPConfig - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| sender_address | string | - | | -| sender_name | string | - | | -| tls | bool | - | | -| host | string | - | | -| user | string | - | | - - - - -### SecretGenerator - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| generator_type | SecretGeneratorType | - | | -| details | zitadel.v1.ObjectDetails | - | | -| length | uint32 | - | | -| expiry | google.protobuf.Duration | - | | -| include_lower_letters | bool | - | | -| include_upper_letters | bool | - | | -| include_digits | bool | - | | -| include_symbols | bool | - | | - - - - -### SecretGeneratorQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.type_query | SecretGeneratorTypeQuery | - | | - - - - -### SecretGeneratorTypeQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| generator_type | SecretGeneratorType | - | | - - - - -### SecurityPolicy - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| enable_iframe_embedding | bool | states if iframe embedding is enabled or disabled | | -| allowed_origins | repeated string | origins allowed to load ZITADEL in an iframe if enable_iframe_embedding is true | | - - - - -### TwilioConfig - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| sid | string | - | | -| sender_number | string | - | | - - - - - - -## Enums - - -### SMSProviderConfigState {#smsproviderconfigstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED | 0 | - | -| SMS_PROVIDER_CONFIG_ACTIVE | 1 | - | -| SMS_PROVIDER_CONFIG_INACTIVE | 2 | - | - - - - -### SecretGeneratorType {#secretgeneratortype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| SECRET_GENERATOR_TYPE_UNSPECIFIED | 0 | - | -| SECRET_GENERATOR_TYPE_INIT_CODE | 1 | - | -| SECRET_GENERATOR_TYPE_VERIFY_EMAIL_CODE | 2 | - | -| SECRET_GENERATOR_TYPE_VERIFY_PHONE_CODE | 3 | - | -| SECRET_GENERATOR_TYPE_PASSWORD_RESET_CODE | 4 | - | -| SECRET_GENERATOR_TYPE_PASSWORDLESS_INIT_CODE | 5 | - | -| SECRET_GENERATOR_TYPE_APP_SECRET | 6 | - | - - - - diff --git a/docs/docs/apis/proto/system.md b/docs/docs/apis/proto/system.md deleted file mode 100644 index d95e2f1b3..000000000 --- a/docs/docs/apis/proto/system.md +++ /dev/null @@ -1,888 +0,0 @@ ---- -title: zitadel/system.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - -## SystemService {#zitadelsystemv1systemservice} - - -### Healthz - -> **rpc** Healthz([HealthzRequest](#healthzrequest)) -[HealthzResponse](#healthzresponse) - -Indicates if ZITADEL is running. -It respondes as soon as ZITADEL started - - - - GET: /healthz - - -### ListInstances - -> **rpc** ListInstances([ListInstancesRequest](#listinstancesrequest)) -[ListInstancesResponse](#listinstancesresponse) - -Returns a list of ZITADEL instances - - - - POST: /instances/_search - - -### GetInstance - -> **rpc** GetInstance([GetInstanceRequest](#getinstancerequest)) -[GetInstanceResponse](#getinstanceresponse) - -Returns the detail of an instance - - - - GET: /instances/{instance_id} - - -### AddInstance - -> **rpc** AddInstance([AddInstanceRequest](#addinstancerequest)) -[AddInstanceResponse](#addinstanceresponse) - -Deprecated: Use CreateInstance instead -Creates a new instance with all needed setup data -This might take some time - - - - POST: /instances - - -### UpdateInstance - -> **rpc** UpdateInstance([UpdateInstanceRequest](#updateinstancerequest)) -[UpdateInstanceResponse](#updateinstanceresponse) - -Updates name of an existing instance - - - - PUT: /instances/{instance_id} - - -### CreateInstance - -> **rpc** CreateInstance([CreateInstanceRequest](#createinstancerequest)) -[CreateInstanceResponse](#createinstanceresponse) - -Creates a new instance with all needed setup data -This might take some time - - - - POST: /instances/_create - - -### RemoveInstance - -> **rpc** RemoveInstance([RemoveInstanceRequest](#removeinstancerequest)) -[RemoveInstanceResponse](#removeinstanceresponse) - -Removes an instance -This might take some time - - - - DELETE: /instances/{instance_id} - - -### ListIAMMembers - -> **rpc** ListIAMMembers([ListIAMMembersRequest](#listiammembersrequest)) -[ListIAMMembersResponse](#listiammembersresponse) - -Returns all instance members matching the request -all queries need to match (ANDed) - - - - POST: /instances/{instance_id}/members/_search - - -### ExistsDomain - -> **rpc** ExistsDomain([ExistsDomainRequest](#existsdomainrequest)) -[ExistsDomainResponse](#existsdomainresponse) - -Checks if a domain exists - - - - POST: /domains/{domain}/_exists - - -### ListDomains - -> **rpc** ListDomains([ListDomainsRequest](#listdomainsrequest)) -[ListDomainsResponse](#listdomainsresponse) - -Returns the custom domains of an instance - - - - POST: /instances/{instance_id}/domains/_search - - -### AddDomain - -> **rpc** AddDomain([AddDomainRequest](#adddomainrequest)) -[AddDomainResponse](#adddomainresponse) - -Returns the domain of an instance - - - - POST: /instances/{instance_id}/domains - - -### RemoveDomain - -> **rpc** RemoveDomain([RemoveDomainRequest](#removedomainrequest)) -[RemoveDomainResponse](#removedomainresponse) - -Returns the domain of an instance - - - - DELETE: /instances/{instance_id}/domains/{domain} - - -### SetPrimaryDomain - -> **rpc** SetPrimaryDomain([SetPrimaryDomainRequest](#setprimarydomainrequest)) -[SetPrimaryDomainResponse](#setprimarydomainresponse) - -Returns the domain of an instance - - - - POST: /instances/{instance_id}/domains/_set_primary - - -### ListViews - -> **rpc** ListViews([ListViewsRequest](#listviewsrequest)) -[ListViewsResponse](#listviewsresponse) - -Returns all stored read models of ZITADEL -views are used for search optimisation and optimise request latencies -they represent the delta of the event happend on the objects - - - - POST: /views/_search - - -### ClearView - -> **rpc** ClearView([ClearViewRequest](#clearviewrequest)) -[ClearViewResponse](#clearviewresponse) - -Truncates the delta of the change stream -be carefull with this function because ZITADEL has to -recompute the deltas after they got cleared. -Search requests will return wrong results until all deltas are recomputed - - - - POST: /views/{database}/{view_name} - - -### ListFailedEvents - -> **rpc** ListFailedEvents([ListFailedEventsRequest](#listfailedeventsrequest)) -[ListFailedEventsResponse](#listfailedeventsresponse) - -Returns event descriptions which cannot be processed. -It's possible that some events need some retries. -For example if the SMTP-API wasn't able to send an email at the first time - - - - POST: /failedevents/_search - - -### RemoveFailedEvent - -> **rpc** RemoveFailedEvent([RemoveFailedEventRequest](#removefailedeventrequest)) -[RemoveFailedEventResponse](#removefailedeventresponse) - -Deletes the event from failed events view. -the event is not removed from the change stream -This call is usefull if the system was able to process the event later. -e.g. if the second try of sending an email was successful. the first try produced a -failed event. You can find out if it worked on the `failure_count` - - - - DELETE: /failedevents/{database}/{view_name}/{failed_sequence} - - -### AddQuota - -> **rpc** AddQuota([AddQuotaRequest](#addquotarequest)) -[AddQuotaResponse](#addquotaresponse) - -Creates a new quota - - - - POST: /instances/{instance_id}/quotas - - -### RemoveQuota - -> **rpc** RemoveQuota([RemoveQuotaRequest](#removequotarequest)) -[RemoveQuotaResponse](#removequotaresponse) - -Removes a quota - - - - DELETE: /instances/{instance_id}/quotas/{unit} - - - - - - - -## Messages - - -### AddDomainRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | - | string.min_len: 1
string.max_len: 200
| -| domain | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### AddDomainResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddInstanceRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_name | string | - | string.min_len: 1
string.max_len: 200
| -| first_org_name | string | - | string.max_len: 200
| -| custom_domain | string | - | string.max_len: 200
| -| owner_user_name | string | - | string.max_len: 200
| -| owner_email | AddInstanceRequest.Email | - | message.required: true
| -| owner_profile | AddInstanceRequest.Profile | - | message.required: false
| -| owner_password | AddInstanceRequest.Password | - | message.required: false
| -| default_language | string | - | string.max_len: 10
| - - - - -### AddInstanceRequest.Email - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| email | string | - | string.min_len: 1
string.max_len: 200
| -| is_email_verified | bool | - | | - - - - -### AddInstanceRequest.Password - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| password | string | - | string.max_len: 200
| -| password_change_required | bool | - | | - - - - -### AddInstanceRequest.Profile - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| first_name | string | - | string.max_len: 200
| -| last_name | string | - | string.max_len: 200
| -| preferred_language | string | - | string.max_len: 10
| - - - - -### AddInstanceResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### AddQuotaRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | - | string.min_len: 1
string.max_len: 200
| -| unit | zitadel.quota.v1.Unit | the unit a quota should be imposed on | enum.defined_only: true
enum.not_in: [0]
| -| from | google.protobuf.Timestamp | the starting time from which the current quota period is calculated from. This is relevant for querying the current usage. | timestamp.required: true
| -| reset_interval | google.protobuf.Duration | the quota periods duration | duration.required: true
| -| amount | uint64 | the quota amount of units | uint64.gt: 0
| -| limit | bool | whether ZITADEL should block further usage when the configured amount is used | | -| notifications | repeated zitadel.quota.v1.Notification | the handlers, ZITADEL executes when certain quota percentages are reached | | - - - - -### AddQuotaResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ChangeSubscriptionRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| domain | string | - | string.min_len: 1
string.max_len: 200
| -| subscription_name | string | - | string.min_len: 1
string.max_len: 200
| -| request_limit | uint64 | - | | -| action_mins_limit | uint64 | - | | - - - - -### ChangeSubscriptionResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### ClearViewRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| database | string | - | string.min_len: 1
string.max_len: 200
| -| view_name | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ClearViewResponse -This is an empty response - - - - -### CreateInstanceRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_name | string | - | string.min_len: 1
string.max_len: 200
| -| first_org_name | string | - | string.max_len: 200
| -| custom_domain | string | - | string.max_len: 200
| -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) owner.human | CreateInstanceRequest.Human | oneof field for the user managing the instance | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) owner.machine | CreateInstanceRequest.Machine | - | | -| default_language | string | - | string.max_len: 10
| - - - - -### CreateInstanceRequest.Email - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| email | string | - | string.min_len: 1
string.max_len: 200
string.email: true
| -| is_email_verified | bool | - | | - - - - -### CreateInstanceRequest.Human - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_name | string | - | string.max_len: 200
| -| email | CreateInstanceRequest.Email | - | message.required: true
| -| profile | CreateInstanceRequest.Profile | - | message.required: false
| -| password | CreateInstanceRequest.Password | - | message.required: false
| - - - - -### CreateInstanceRequest.Machine - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_name | string | - | string.max_len: 200
| -| name | string | - | string.max_len: 200
| -| personal_access_token | CreateInstanceRequest.PersonalAccessToken | - | | -| machine_key | CreateInstanceRequest.MachineKey | - | | - - - - -### CreateInstanceRequest.MachineKey - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | zitadel.authn.v1.KeyType | - | enum.defined_only: true
enum.not_in: [0]
| -| expiration_date | google.protobuf.Timestamp | - | | - - - - -### CreateInstanceRequest.Password - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| password | string | - | string.max_len: 200
| -| password_change_required | bool | - | | - - - - -### CreateInstanceRequest.PersonalAccessToken - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| expiration_date | google.protobuf.Timestamp | - | | - - - - -### CreateInstanceRequest.Profile - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| first_name | string | - | string.max_len: 200
| -| last_name | string | - | string.max_len: 200
| -| preferred_language | string | - | string.max_len: 10
| - - - - -### CreateInstanceResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| pat | string | - | | -| machine_key | bytes | - | | - - - - -### ExistsDomainRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| domain | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### ExistsDomainResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| exists | bool | - | | - - - - -### FailedEvent - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| database | string | - | | -| view_name | string | - | | -| failed_sequence | uint64 | - | | -| failure_count | uint64 | - | | -| error_message | string | - | | -| last_failed | google.protobuf.Timestamp | - | | - - - - -### GetInstanceRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### GetInstanceResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance | zitadel.instance.v1.InstanceDetail | - | | - - - - -### GetUsageRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### HealthzRequest -This is an empty request - - - - -### HealthzResponse -This is an empty response - - - - -### ListDomainsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | list limitations and ordering | string.min_len: 1
string.max_len: 200
| -| query | zitadel.v1.ListQuery | - | | -| sorting_column | zitadel.instance.v1.DomainFieldName | the field the result is sorted | | -| queries | repeated zitadel.instance.v1.DomainSearchQuery | criterias the client is looking for | | - - - - -### ListDomainsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| sorting_column | zitadel.instance.v1.DomainFieldName | - | | -| result | repeated zitadel.instance.v1.Domain | - | | - - - - -### ListFailedEventsRequest -This is an empty request - - - - -### ListFailedEventsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated FailedEvent | TODO: list details | | - - - - -### ListIAMMembersRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | - | | -| instance_id | string | - | | -| queries | repeated zitadel.member.v1.SearchQuery | - | | - - - - -### ListIAMMembersResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| result | repeated zitadel.member.v1.Member | - | | - - - - -### ListInstancesRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| query | zitadel.v1.ListQuery | list limitations and ordering | | -| sorting_column | zitadel.instance.v1.FieldName | the field the result is sorted | | -| queries | repeated zitadel.instance.v1.Query | criterias the client is looking for | | - - - - -### ListInstancesResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ListDetails | - | | -| sorting_column | zitadel.instance.v1.FieldName | - | | -| result | repeated zitadel.instance.v1.Instance | - | | - - - - -### ListViewsRequest -This is an empty request - - - - -### ListViewsResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| result | repeated View | TODO: list details | | - - - - -### RemoveDomainRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | - | string.min_len: 1
string.max_len: 200
| -| domain | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveDomainResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveFailedEventRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| database | string | - | string.min_len: 1
string.max_len: 200
| -| view_name | string | - | string.min_len: 1
string.max_len: 200
| -| failed_sequence | uint64 | - | | -| instance_id | string | - | | - - - - -### RemoveFailedEventResponse -This is an empty response - - - - -### RemoveInstanceRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### RemoveInstanceResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### RemoveQuotaRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | - | string.min_len: 1
string.max_len: 200
| -| unit | zitadel.quota.v1.Unit | - | | - - - - -### RemoveQuotaResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### SetPrimaryDomainRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | - | string.min_len: 1
string.max_len: 200
| -| domain | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### SetPrimaryDomainResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### UpdateInstanceRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| instance_id | string | - | | -| instance_name | string | - | string.min_len: 1
string.max_len: 200
| - - - - -### UpdateInstanceResponse - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | - - - - -### View - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| database | string | - | | -| view_name | string | - | | -| processed_sequence | uint64 | - | | -| event_timestamp | google.protobuf.Timestamp | The timestamp the event occured | | -| last_successful_spooler_run | google.protobuf.Timestamp | - | | -| instance | string | - | | - - - - - - diff --git a/docs/docs/apis/proto/text.md b/docs/docs/apis/proto/text.md deleted file mode 100644 index 6c7121881..000000000 --- a/docs/docs/apis/proto/text.md +++ /dev/null @@ -1,637 +0,0 @@ ---- -title: zitadel/text.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### EmailVerificationDoneScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| next_button_text | string | - | string.max_len: 100
| -| cancel_button_text | string | - | string.max_len: 100
| -| login_button_text | string | - | string.max_len: 100
| - - - - -### EmailVerificationScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| code_label | string | - | string.max_len: 200
| -| next_button_text | string | - | string.max_len: 100
| -| resend_button_text | string | - | string.max_len: 100
| - - - - -### ExternalRegistrationUserOverviewScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| email_label | string | - | string.max_len: 200
| -| username_label | string | - | string.max_len: 200
| -| firstname_label | string | - | string.max_len: 200
| -| lastname_label | string | - | string.max_len: 200
| -| nickname_label | string | - | string.max_len: 200
| -| language_label | string | - | string.max_len: 200
| -| phone_label | string | - | string.max_len: 200
| -| tos_and_privacy_label | string | - | string.max_len: 200
| -| tos_confirm | string | - | string.max_len: 200
| -| tos_link_text | string | - | string.max_len: 200
| -| privacy_link_text | string | - | string.max_len: 200
| -| back_button_text | string | - | string.max_len: 200
| -| next_button_text | string | - | string.max_len: 200
| -| privacy_confirm | string | - | string.max_len: 200
| - - - - -### ExternalUserNotFoundScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| link_button_text | string | - | string.max_len: 100
| -| auto_register_button_text | string | - | string.max_len: 100
| -| tos_and_privacy_label | string | - | string.max_len: 200
| -| tos_confirm | string | - | string.max_len: 200
| -| tos_link_text | string | - | string.max_len: 200
| -| privacy_link_text | string | - | string.max_len: 200
| -| privacy_confirm | string | - | string.max_len: 200
| - - - - -### FooterText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| tos | string | - | string.max_len: 200
| -| privacy_policy | string | - | string.max_len: 200
| -| help | string | - | string.max_len: 200
| - - - - -### InitMFADoneScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| cancel_button_text | string | - | string.max_len: 100
| -| next_button_text | string | - | string.max_len: 100
| - - - - -### InitMFAOTPScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| description_otp | string | - | string.max_len: 500
| -| secret_label | string | - | string.max_len: 200
| -| code_label | string | - | string.max_len: 200
| -| next_button_text | string | - | string.max_len: 100
| -| cancel_button_text | string | - | string.max_len: 100
| - - - - -### InitMFAPromptScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| otp_option | string | - | string.max_len: 200
| -| u2f_option | string | - | string.max_len: 200
| -| skip_button_text | string | - | string.max_len: 100
| -| next_button_text | string | - | string.max_len: 100
| - - - - -### InitMFAU2FScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| token_name_label | string | - | string.max_len: 200
| -| not_supported | string | - | string.max_len: 500
| -| register_token_button_text | string | - | string.max_len: 100
| -| error_retry | string | - | string.max_len: 500
| - - - - -### InitPasswordDoneScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| next_button_text | string | - | string.max_len: 100
| -| cancel_button_text | string | - | string.max_len: 100
| - - - - -### InitPasswordScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| code_label | string | - | string.max_len: 200
| -| new_password_label | string | - | string.max_len: 200
| -| new_password_confirm_label | string | - | string.max_len: 200
| -| next_button_text | string | - | string.max_len: 100
| -| resend_button_text | string | - | string.max_len: 100
| - - - - -### InitializeUserDoneScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| cancel_button_text | string | - | string.max_len: 100
| -| next_button_text | string | - | string.max_len: 100
| - - - - -### InitializeUserScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| code_label | string | - | string.max_len: 200
| -| new_password_label | string | - | string.max_len: 200
| -| new_password_confirm_label | string | - | string.max_len: 200
| -| resend_button_text | string | - | string.max_len: 100
| -| next_button_text | string | - | string.max_len: 100
| - - - - -### LinkingUserDoneScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| cancel_button_text | string | - | string.max_len: 100
| -| next_button_text | string | - | string.max_len: 100
| - - - - -### LoginCustomText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| select_account_text | SelectAccountScreenText | - | | -| login_text | LoginScreenText | - | | -| password_text | PasswordScreenText | - | | -| username_change_text | UsernameChangeScreenText | - | | -| username_change_done_text | UsernameChangeDoneScreenText | - | | -| init_password_text | InitPasswordScreenText | - | | -| init_password_done_text | InitPasswordDoneScreenText | - | | -| email_verification_text | EmailVerificationScreenText | - | | -| email_verification_done_text | EmailVerificationDoneScreenText | - | | -| initialize_user_text | InitializeUserScreenText | - | | -| initialize_done_text | InitializeUserDoneScreenText | - | | -| init_mfa_prompt_text | InitMFAPromptScreenText | - | | -| init_mfa_otp_text | InitMFAOTPScreenText | - | | -| init_mfa_u2f_text | InitMFAU2FScreenText | - | | -| init_mfa_done_text | InitMFADoneScreenText | - | | -| mfa_providers_text | MFAProvidersText | - | | -| verify_mfa_otp_text | VerifyMFAOTPScreenText | - | | -| verify_mfa_u2f_text | VerifyMFAU2FScreenText | - | | -| passwordless_text | PasswordlessScreenText | - | | -| password_change_text | PasswordChangeScreenText | - | | -| password_change_done_text | PasswordChangeDoneScreenText | - | | -| password_reset_done_text | PasswordResetDoneScreenText | - | | -| registration_option_text | RegistrationOptionScreenText | - | | -| registration_user_text | RegistrationUserScreenText | - | | -| registration_org_text | RegistrationOrgScreenText | - | | -| linking_user_done_text | LinkingUserDoneScreenText | - | | -| external_user_not_found_text | ExternalUserNotFoundScreenText | - | | -| success_login_text | SuccessLoginScreenText | - | | -| logout_text | LogoutDoneScreenText | - | | -| footer_text | FooterText | - | | -| passwordless_prompt_text | PasswordlessPromptScreenText | - | | -| passwordless_registration_text | PasswordlessRegistrationScreenText | - | | -| passwordless_registration_done_text | PasswordlessRegistrationDoneScreenText | - | | -| external_registration_user_overview_text | ExternalRegistrationUserOverviewScreenText | - | | -| is_default | bool | - | | - - - - -### LoginScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| title_linking_process | string | - | string.max_len: 200
| -| description_linking_process | string | - | string.max_len: 500
| -| user_must_be_member_of_org | string | - | string.max_len: 500
| -| login_name_label | string | - | string.max_len: 200
| -| register_button_text | string | - | string.max_len: 100
| -| next_button_text | string | - | string.max_len: 100
| -| external_user_description | string | - | string.max_len: 500
| -| user_name_placeholder | string | - | string.max_len: 200
| -| login_name_placeholder | string | - | string.max_len: 200
| - - - - -### LogoutDoneScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| login_button_text | string | - | string.max_len: 200
| - - - - -### MFAProvidersText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| choose_other | string | - | string.max_len: 500
| -| otp | string | - | string.max_len: 200
| -| u2f | string | - | string.max_len: 200
| - - - - -### MessageCustomText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| details | zitadel.v1.ObjectDetails | - | | -| title | string | - | | -| pre_header | string | - | | -| subject | string | - | | -| greeting | string | - | | -| text | string | - | | -| button_text | string | - | | -| footer_text | string | - | | -| is_default | bool | - | | - - - - -### PasswordChangeDoneScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| next_button_text | string | - | string.max_len: 100
| - - - - -### PasswordChangeScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| old_password_label | string | - | string.max_len: 200
| -| new_password_label | string | - | string.max_len: 200
| -| new_password_confirm_label | string | - | string.max_len: 200
| -| cancel_button_text | string | - | string.max_len: 100
| -| next_button_text | string | - | string.max_len: 100
| - - - - -### PasswordResetDoneScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| next_button_text | string | - | string.max_len: 100
| - - - - -### PasswordScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| password_label | string | - | string.max_len: 200
| -| reset_link_text | string | - | string.max_len: 100
| -| back_button_text | string | - | string.max_len: 100
| -| next_button_text | string | - | string.max_len: 100
| -| min_length | string | - | string.max_len: 100
| -| has_uppercase | string | - | string.max_len: 100
| -| has_lowercase | string | - | string.max_len: 100
| -| has_number | string | - | string.max_len: 100
| -| has_symbol | string | - | string.max_len: 100
| -| confirmation | string | - | string.max_len: 100
| - - - - -### PasswordlessPromptScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| description_init | string | - | string.max_len: 500
| -| passwordless_button_text | string | - | string.max_len: 100
| -| next_button_text | string | - | string.max_len: 100
| -| skip_button_text | string | - | string.max_len: 100
| - - - - -### PasswordlessRegistrationDoneScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| next_button_text | string | - | string.max_len: 100
| -| cancel_button_text | string | - | string.max_len: 100
| -| description_close | string | - | string.max_len: 100
| - - - - -### PasswordlessRegistrationScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| token_name_label | string | - | string.max_len: 200
| -| not_supported | string | - | string.max_len: 500
| -| register_token_button_text | string | - | string.max_len: 100
| -| error_retry | string | - | string.max_len: 500
| - - - - -### PasswordlessScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| login_with_pw_button_text | string | - | string.max_len: 100
| -| validate_token_button_text | string | - | string.max_len: 200
| -| not_supported | string | - | string.max_len: 500
| -| error_retry | string | - | string.max_len: 500
| - - - - -### RegistrationOptionScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| user_name_button_text | string | - | string.max_len: 200
| -| external_login_description | string | - | string.max_len: 500
| -| login_button_text | string | - | string.max_len: 200
| - - - - -### RegistrationOrgScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| orgname_label | string | - | string.max_len: 200
| -| firstname_label | string | - | string.max_len: 200
| -| lastname_label | string | - | string.max_len: 200
| -| username_label | string | - | string.max_len: 200
| -| email_label | string | - | string.max_len: 200
| -| password_label | string | - | string.max_len: 200
| -| password_confirm_label | string | - | string.max_len: 200
| -| tos_and_privacy_label | string | - | string.max_len: 200
| -| tos_confirm | string | - | string.max_len: 200
| -| tos_link_text | string | - | string.max_len: 200
| -| privacy_confirm | string | - | string.max_len: 200
| -| privacy_link_text | string | - | string.max_len: 200
| -| save_button_text | string | - | string.max_len: 200
| - - - - -### RegistrationUserScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| description_org_register | string | - | string.max_len: 500
| -| firstname_label | string | - | string.max_len: 200
| -| lastname_label | string | - | string.max_len: 200
| -| email_label | string | - | string.max_len: 200
| -| username_label | string | - | string.max_len: 200
| -| language_label | string | - | string.max_len: 200
| -| gender_label | string | - | string.max_len: 200
| -| password_label | string | - | string.max_len: 200
| -| password_confirm_label | string | - | string.max_len: 200
| -| tos_and_privacy_label | string | - | string.max_len: 200
| -| tos_confirm | string | - | string.max_len: 200
| -| tos_link_text | string | - | string.max_len: 200
| -| privacy_confirm | string | - | string.max_len: 200
| -| privacy_link_text | string | - | string.max_len: 200
| -| next_button_text | string | - | string.max_len: 200
| -| back_button_text | string | - | string.max_len: 200
| - - - - -### SelectAccountScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| title_linking_process | string | - | string.max_len: 200
| -| description_linking_process | string | - | string.max_len: 500
| -| other_user | string | - | string.max_len: 500
| -| session_state_active | string | - | string.max_len: 100
| -| session_state_inactive | string | - | string.max_len: 100
| -| user_must_be_member_of_org | string | - | string.max_len: 500
| - - - - -### SuccessLoginScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| auto_redirect_description | string | Text to describe that auto redirect should happen after successful login | string.max_len: 500
| -| redirected_description | string | Text to describe that the window can be closed after redirect | string.max_len: 100
| -| next_button_text | string | - | string.max_len: 200
| - - - - -### UsernameChangeDoneScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| next_button_text | string | - | string.max_len: 100
| - - - - -### UsernameChangeScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| username_label | string | - | string.max_len: 200
| -| cancel_button_text | string | - | string.max_len: 100
| -| next_button_text | string | - | string.max_len: 100
| - - - - -### VerifyMFAOTPScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| code_label | string | - | string.max_len: 200
| -| next_button_text | string | - | string.max_len: 100
| - - - - -### VerifyMFAU2FScreenText - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| title | string | - | string.max_len: 200
| -| description | string | - | string.max_len: 500
| -| validate_token_text | string | - | string.max_len: 500
| -| not_supported | string | - | string.max_len: 500
| -| error_retry | string | - | string.max_len: 500
| - - - - - - diff --git a/docs/docs/apis/proto/user.md b/docs/docs/apis/proto/user.md deleted file mode 100644 index 725a9c70d..000000000 --- a/docs/docs/apis/proto/user.md +++ /dev/null @@ -1,744 +0,0 @@ ---- -title: zitadel/user.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### AuthFactor - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| state | AuthFactorState | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.otp | AuthFactorOTP | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.u2f | AuthFactorU2F | - | | - - - - -### AuthFactorOTP - - - - - -### AuthFactorU2F - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| name | string | - | | - - - - -### DisplayNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| display_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### Email - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| email | string | - | | -| is_email_verified | bool | - | | - - - - -### EmailQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| email_address | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### FirstNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| first_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### Human - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| profile | Profile | - | | -| email | Email | - | | -| phone | Phone | - | | - - - - -### LastNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| last_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### LoginNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| login_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### Machine - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| name | string | - | | -| description | string | - | | -| has_secret | bool | - | | -| access_token_type | AccessTokenType | - | | - - - - -### Membership - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| roles | repeated string | - | | -| display_name | string | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.iam | bool | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.org_id | string | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.project_id | string | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.project_grant_id | string | - | | - - - - -### MembershipIAMQuery -this query is always equals - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| iam | bool | - | | - - - - -### MembershipOrgQuery -this query is always equals - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.max_len: 200
| - - - - -### MembershipProjectGrantQuery -this query is always equals - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_grant_id | string | - | string.max_len: 200
| - - - - -### MembershipProjectQuery -this query is always equals - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.max_len: 200
| - - - - -### MembershipQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.org_query | MembershipOrgQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_query | MembershipProjectQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_grant_query | MembershipProjectGrantQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.iam_query | MembershipIAMQuery | - | | - - - - -### NickNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| nick_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### PersonalAccessToken - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| expiration_date | google.protobuf.Timestamp | - | | -| scopes | repeated string | - | | - - - - -### Phone - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| phone | string | - | | -| is_phone_verified | bool | - | | - - - - -### Profile - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| first_name | string | - | | -| last_name | string | - | | -| nick_name | string | - | | -| display_name | string | - | | -| preferred_language | string | - | | -| gender | Gender | - | | -| avatar_url | string | - | | - - - - -### RefreshToken - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| client_id | string | - | | -| auth_time | google.protobuf.Timestamp | - | | -| idle_expiration | google.protobuf.Timestamp | - | | -| expiration | google.protobuf.Timestamp | - | | -| scopes | repeated string | - | | -| audience | repeated string | - | | - - - - -### SearchQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.user_name_query | UserNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.first_name_query | FirstNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.last_name_query | LastNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.nick_name_query | NickNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.display_name_query | DisplayNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.email_query | EmailQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.state_query | StateQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.type_query | TypeQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.login_name_query | LoginNameQuery | - | | - - - - -### Session - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| session_id | string | - | | -| agent_id | string | - | | -| auth_state | SessionState | - | | -| user_id | string | - | | -| user_name | string | - | | -| login_name | string | - | | -| display_name | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| avatar_url | string | - | | - - - - -### StateQuery -UserStateQuery is always equals - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| state | UserState | - | enum.defined_only: true
| - - - - -### TypeQuery -UserTypeQuery is always equals - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | Type | - | enum.defined_only: true
| - - - - -### User - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| state | UserState | - | | -| user_name | string | - | | -| login_names | repeated string | - | | -| preferred_login_name | string | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.human | Human | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.machine | Machine | - | | - - - - -### UserGrant - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| details | zitadel.v1.ObjectDetails | - | | -| role_keys | repeated string | - | | -| state | UserGrantState | - | | -| user_id | string | - | | -| user_name | string | - | | -| first_name | string | - | | -| last_name | string | - | | -| email | string | - | string.email: true
| -| display_name | string | - | string.max_len: 200
| -| org_id | string | - | | -| org_name | string | - | | -| org_domain | string | - | | -| project_id | string | - | | -| project_name | string | - | | -| project_grant_id | string | - | | -| avatar_url | string | - | | -| preferred_login_name | string | - | | - - - - -### UserGrantDisplayNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| display_name | string | - | | -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### UserGrantEmailQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| email | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### UserGrantFirstNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| first_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### UserGrantLastNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| last_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### UserGrantOrgDomainQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_domain | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### UserGrantOrgNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### UserGrantProjectGrantIDQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_grant_id | string | - | string.max_len: 200
| - - - - -### UserGrantProjectIDQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | string.max_len: 200
| - - - - -### UserGrantProjectNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### UserGrantQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_id_query | UserGrantProjectIDQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.user_id_query | UserGrantUserIDQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.with_granted_query | UserGrantWithGrantedQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.role_key_query | UserGrantRoleKeyQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_grant_id_query | UserGrantProjectGrantIDQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.user_name_query | UserGrantUserNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.first_name_query | UserGrantFirstNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.last_name_query | UserGrantLastNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.email_query | UserGrantEmailQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.org_name_query | UserGrantOrgNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.org_domain_query | UserGrantOrgDomainQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_name_query | UserGrantProjectNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.display_name_query | UserGrantDisplayNameQuery | - | | -| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.user_type_query | UserGrantUserTypeQuery | - | | - - - - -### UserGrantRoleKeyQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| role_key | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### UserGrantUserIDQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | string.max_len: 200
| - - - - -### UserGrantUserNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### UserGrantUserTypeQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| type | Type | - | | - - - - -### UserGrantWithGrantedQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| with_granted | bool | - | | - - - - -### UserNameQuery - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_name | string | - | string.max_len: 200
| -| method | zitadel.v1.TextQueryMethod | - | enum.defined_only: true
| - - - - -### WebAuthNKey - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| public_key | bytes | - | | - - - - -### WebAuthNToken - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| state | AuthFactorState | - | | -| name | string | - | | - - - - -### WebAuthNVerification - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| public_key_credential | bytes | - | bytes.min_len: 55
| -| token_name | string | - | string.min_len: 1
string.max_len: 200
| - - - - - - -## Enums - - -### AccessTokenType {#accesstokentype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| ACCESS_TOKEN_TYPE_BEARER | 0 | - | -| ACCESS_TOKEN_TYPE_JWT | 1 | - | - - - - -### AuthFactorState {#authfactorstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| AUTH_FACTOR_STATE_UNSPECIFIED | 0 | - | -| AUTH_FACTOR_STATE_NOT_READY | 1 | - | -| AUTH_FACTOR_STATE_READY | 2 | - | -| AUTH_FACTOR_STATE_REMOVED | 3 | - | - - - - -### Gender {#gender} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| GENDER_UNSPECIFIED | 0 | - | -| GENDER_FEMALE | 1 | - | -| GENDER_MALE | 2 | - | -| GENDER_DIVERSE | 3 | - | - - - - -### SessionState {#sessionstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| SESSION_STATE_UNSPECIFIED | 0 | - | -| SESSION_STATE_ACTIVE | 1 | - | -| SESSION_STATE_TERMINATED | 2 | - | - - - - -### Type {#type} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| TYPE_UNSPECIFIED | 0 | - | -| TYPE_HUMAN | 1 | - | -| TYPE_MACHINE | 2 | - | - - - - -### UserFieldName {#userfieldname} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| USER_FIELD_NAME_UNSPECIFIED | 0 | - | -| USER_FIELD_NAME_USER_NAME | 1 | - | -| USER_FIELD_NAME_FIRST_NAME | 2 | - | -| USER_FIELD_NAME_LAST_NAME | 3 | - | -| USER_FIELD_NAME_NICK_NAME | 4 | - | -| USER_FIELD_NAME_DISPLAY_NAME | 5 | - | -| USER_FIELD_NAME_EMAIL | 6 | - | -| USER_FIELD_NAME_STATE | 7 | - | -| USER_FIELD_NAME_TYPE | 8 | - | -| USER_FIELD_NAME_CREATION_DATE | 9 | - | - - - - -### UserGrantState {#usergrantstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| USER_GRANT_STATE_UNSPECIFIED | 0 | - | -| USER_GRANT_STATE_ACTIVE | 1 | - | -| USER_GRANT_STATE_INACTIVE | 2 | - | - - - - -### UserState {#userstate} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| USER_STATE_UNSPECIFIED | 0 | - | -| USER_STATE_ACTIVE | 1 | - | -| USER_STATE_INACTIVE | 2 | - | -| USER_STATE_DELETED | 3 | - | -| USER_STATE_LOCKED | 4 | - | -| USER_STATE_SUSPEND | 5 | - | -| USER_STATE_INITIAL | 6 | - | - - - - diff --git a/docs/docs/apis/proto/v1.md b/docs/docs/apis/proto/v1.md deleted file mode 100644 index b50f994b7..000000000 --- a/docs/docs/apis/proto/v1.md +++ /dev/null @@ -1,335 +0,0 @@ ---- -title: zitadel/v1.proto ---- -> This document reflects the state from API 1.0 (available from 20.04.2021) - - - - -## Messages - - -### AddCustomOrgIAMPolicyRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | string.min_len: 1
string.max_len: 200
| -| user_login_must_be_domain | bool | the username has to end with the domain of it's organisation (uniqueness is organisation based) | | - - - - -### DataAPIApplication - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| app_id | string | - | | -| app | zitadel.management.v1.AddAPIAppRequest | - | | - - - - -### DataAction - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| action_id | string | - | | -| action | zitadel.management.v1.CreateActionRequest | - | | - - - - -### DataAppKey - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| id | string | - | | -| project_id | string | - | | -| app_id | string | - | | -| client_id | string | - | | -| type | zitadel.authn.v1.KeyType | - | | -| expiration_date | google.protobuf.Timestamp | - | | -| public_key | bytes | - | | - - - - -### DataHumanUser - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | | -| user | zitadel.management.v1.ImportHumanUserRequest | - | | - - - - -### DataJWTIDP - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | | -| idp | zitadel.management.v1.AddOrgJWTIDPRequest | - | | - - - - -### DataMachineKey - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| key_id | string | - | | -| user_id | string | - | | -| type | zitadel.authn.v1.KeyType | - | | -| expiration_date | google.protobuf.Timestamp | - | | -| public_key | bytes | - | | - - - - -### DataMachineUser - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_id | string | - | | -| user | zitadel.management.v1.AddMachineUserRequest | - | | - - - - -### DataOIDCApplication - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| app_id | string | - | | -| app | zitadel.management.v1.AddOIDCAppRequest | - | | - - - - -### DataOIDCIDP - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| idp_id | string | - | | -| idp | zitadel.management.v1.AddOrgOIDCIDPRequest | - | | - - - - -### DataOrg - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| org_id | string | - | | -| org | zitadel.management.v1.AddOrgRequest | - | | -| iam_policy | AddCustomOrgIAMPolicyRequest | - | | -| label_policy | zitadel.management.v1.AddCustomLabelPolicyRequest | - | | -| lockout_policy | zitadel.management.v1.AddCustomLockoutPolicyRequest | - | | -| login_policy | zitadel.management.v1.AddCustomLoginPolicyRequest | - | | -| password_complexity_policy | zitadel.management.v1.AddCustomPasswordComplexityPolicyRequest | - | | -| privacy_policy | zitadel.management.v1.AddCustomPrivacyPolicyRequest | - | | -| projects | repeated DataProject | - | | -| project_roles | repeated zitadel.management.v1.AddProjectRoleRequest | - | | -| api_apps | repeated DataAPIApplication | - | | -| oidc_apps | repeated DataOIDCApplication | - | | -| human_users | repeated DataHumanUser | - | | -| machine_users | repeated DataMachineUser | - | | -| trigger_actions | repeated SetTriggerActionsRequest | - | | -| actions | repeated DataAction | - | | -| project_grants | repeated DataProjectGrant | - | | -| user_grants | repeated zitadel.management.v1.AddUserGrantRequest | - | | -| org_members | repeated zitadel.management.v1.AddOrgMemberRequest | - | | -| project_members | repeated zitadel.management.v1.AddProjectMemberRequest | - | | -| project_grant_members | repeated zitadel.management.v1.AddProjectGrantMemberRequest | - | | -| user_metadata | repeated zitadel.management.v1.SetUserMetadataRequest | - | | -| login_texts | repeated zitadel.management.v1.SetCustomLoginTextsRequest | - | | -| init_messages | repeated zitadel.management.v1.SetCustomInitMessageTextRequest | - | | -| password_reset_messages | repeated zitadel.management.v1.SetCustomPasswordResetMessageTextRequest | - | | -| verify_email_messages | repeated zitadel.management.v1.SetCustomVerifyEmailMessageTextRequest | - | | -| verify_phone_messages | repeated zitadel.management.v1.SetCustomVerifyPhoneMessageTextRequest | - | | -| domain_claimed_messages | repeated zitadel.management.v1.SetCustomDomainClaimedMessageTextRequest | - | | -| passwordless_registration_messages | repeated zitadel.management.v1.SetCustomPasswordlessRegistrationMessageTextRequest | - | | -| oidc_idps | repeated DataOIDCIDP | - | | -| jwt_idps | repeated DataJWTIDP | - | | -| second_factors | repeated zitadel.management.v1.AddSecondFactorToLoginPolicyRequest | - | | -| multi_factors | repeated zitadel.management.v1.AddMultiFactorToLoginPolicyRequest | - | | -| idps | repeated zitadel.management.v1.AddIDPToLoginPolicyRequest | - | | -| user_links | repeated zitadel.idp.v1.IDPUserLink | - | | -| domains | repeated zitadel.org.v1.Domain | - | | -| app_keys | repeated DataAppKey | - | | -| machine_keys | repeated DataMachineKey | - | | - - - - -### DataProject - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| project_id | string | - | | -| project | zitadel.management.v1.AddProjectRequest | - | | - - - - -### DataProjectGrant - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| grant_id | string | - | | -| project_grant | zitadel.management.v1.AddProjectGrantRequest | - | | - - - - -### ExportHumanUser - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| user_name | string | - | string.min_len: 1
string.max_len: 200
| -| profile | ExportHumanUser.Profile | - | message.required: true
| -| email | ExportHumanUser.Email | - | message.required: true
| -| phone | ExportHumanUser.Phone | - | | -| password | string | - | | -| hashed_password | ExportHumanUser.HashedPassword | - | | -| password_change_required | bool | - | | -| request_passwordless_registration | bool | - | | -| otp_code | string | - | | - - - - -### ExportHumanUser.Email - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| email | string | TODO: check if no value is allowed | string.email: true
| -| is_email_verified | bool | - | | - - - - -### ExportHumanUser.HashedPassword - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| value | string | - | | -| algorithm | string | - | | - - - - -### ExportHumanUser.Phone - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| phone | string | has to be a global number | string.min_len: 1
string.max_len: 50
string.prefix: +
| -| is_phone_verified | bool | - | | - - - - -### ExportHumanUser.Profile - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| first_name | string | - | string.min_len: 1
string.max_len: 200
| -| last_name | string | - | string.min_len: 1
string.max_len: 200
| -| nick_name | string | - | string.max_len: 200
| -| display_name | string | - | string.max_len: 200
| -| preferred_language | string | - | string.max_len: 10
| -| gender | zitadel.user.v1.Gender | - | | - - - - -### ImportDataOrg - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| orgs | repeated DataOrg | - | | - - - - -### SetTriggerActionsRequest - - - -| Field | Type | Description | Validation | -| ----- | ---- | ----------- | ----------- | -| flow_type | FlowType | - | | -| trigger_type | TriggerType | - | | -| action_ids | repeated string | - | | - - - - - - -## Enums - - -### FlowType {#flowtype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| FLOW_TYPE_UNSPECIFIED | 0 | - | -| FLOW_TYPE_EXTERNAL_AUTHENTICATION | 1 | - | - - - - -### TriggerType {#triggertype} - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| TRIGGER_TYPE_UNSPECIFIED | 0 | - | -| TRIGGER_TYPE_POST_AUTHENTICATION | 1 | - | -| TRIGGER_TYPE_PRE_CREATION | 2 | - | -| TRIGGER_TYPE_POST_CREATION | 3 | - | - - - - diff --git a/docs/docs/apis/statuscodes.mdx b/docs/docs/apis/statuscodes.mdx index c2c034225..d4f588002 100644 --- a/docs/docs/apis/statuscodes.mdx +++ b/docs/docs/apis/statuscodes.mdx @@ -1,5 +1,5 @@ --- -title: Status Codes +title: GRPC Status Codes --- | GRPC Number | GRPC Code | HTTP Status Code | HTTP Status Text |Description | diff --git a/docs/docs/concepts/structure/instance.mdx b/docs/docs/concepts/structure/instance.mdx index 3d525ad99..825af63be 100644 --- a/docs/docs/concepts/structure/instance.mdx +++ b/docs/docs/concepts/structure/instance.mdx @@ -18,7 +18,7 @@ Read more about how to configure your instance in our [instance guide](/guides/m ZITADEL has the concept of virtual instances. When installing ZITADEL from scratch, one instance is always automatically created for you. -Nevertheless, you can add more virtual instances via the [system API](/apis/proto/system#addinstance). +Nevertheless, you can add more virtual instances via the [system API](/apis/system). This is useful if you have business customers, which in turn have their business customers with self service and custom domain demands. By providing a virtual ZITADEL instances, your customers have all the customization options available in ZITADEL. Scaling ZITADEL instances virtually enables you to easily distribute your limited compute resources to all your customers. diff --git a/docs/docs/guides/integrate/access-zitadel-system-api.md b/docs/docs/guides/integrate/access-zitadel-system-api.md index 262a98161..e049d3b16 100644 --- a/docs/docs/guides/integrate/access-zitadel-system-api.md +++ b/docs/docs/guides/integrate/access-zitadel-system-api.md @@ -145,7 +145,7 @@ You should get a successful response with a `totalResult` number of 1 and the de } ``` -With this token you are allowed to access the whole [ZITADEL System API](../../apis/proto/system). +With this token you are allowed to access the whole [ZITADEL System API](../../apis/system). ## Summary diff --git a/docs/docs/guides/integrate/event-api.md b/docs/docs/guides/integrate/event-api.md index 244643d9b..afb131107 100644 --- a/docs/docs/guides/integrate/event-api.md +++ b/docs/docs/guides/integrate/event-api.md @@ -11,7 +11,7 @@ You need to give a user the [manager role](https://zitadel.com/docs/guides/manag If you like to know more about eventsourcing/eventstore and how this works in ZITADEL, head over to our [concepts](../../concepts/eventstore/overview). ## Request Events -Call the [ListEvents](../../apis/proto/admin#listevents) enpoint in the Administration API to get all the events you need. +Call the [ListEvents](../../apis/admin) enpoint in the Administration API to get all the events you need. To further restrict your result you can add the following filters: - sequence - editor user id @@ -29,7 +29,7 @@ curl --request POST \ ## Get event types -To be able to filter for the different event types ZITADEL knows, you can request the [EventTypesList](../../apis/proto/admin#listeventtypes) +To be able to filter for the different event types ZITADEL knows, you can request the [EventTypesList](../../apis/admin) ```bash curl --request POST \ @@ -65,7 +65,7 @@ The following example shows you the event types for a password check (failed/suc ## Get aggregate types -To be able to filter for the different aggregate types (resources) ZITADEL knows, you can request the [AggregateTypesList](../../apis/proto/admin#listaggregatetypes) +To be able to filter for the different aggregate types (resources) ZITADEL knows, you can request the [AggregateTypesList](../../apis/admin) ```bash curl --request POST \ diff --git a/docs/docs/guides/manage/user/reg-create-user.md b/docs/docs/guides/manage/user/reg-create-user.md index e1458b35b..3da64e457 100644 --- a/docs/docs/guides/manage/user/reg-create-user.md +++ b/docs/docs/guides/manage/user/reg-create-user.md @@ -5,7 +5,7 @@ title: Register and Create User The ZITADEL API has different possibilities to create users. This can be used, if you are building your own registration page. -[Import Human User](../../../apis/proto/management#importhumanuser) +[Import Human User](../../../apis/mgmt) ## With Username and Password @@ -28,9 +28,9 @@ If nothing is requested, the type will not be restricted and all possibilities o ### Add passwordless to existing user -If you already have a user in ZITADEL, it is possible to add passworless later. +If you already have a user in ZITADEL, it is possible to add passwordless later. -[Add Passwordless Registration ](../../../apis/proto/management#addpasswordlessregistration) +[Add Passwordless Registration ](../../../apis/mgmt) Send the user_id in the request and you will get a link and an expiration as response. You can then customize the link the same as described above in the creation process. @@ -38,6 +38,4 @@ You can then customize the link the same as described above in the creation proc The second possibility is to send the link directly to the user per email. Use the following request in that case: -[Send Passwordless Registration ](../../../apis/proto/management#sendpasswordlessregistration) - - +[Send Passwordless Registration ](../../../apis/mgmt) diff --git a/docs/docs/guides/solution-scenarios/b2c.mdx b/docs/docs/guides/solution-scenarios/b2c.mdx index 2745dc80c..14cdf06f8 100644 --- a/docs/docs/guides/solution-scenarios/b2c.mdx +++ b/docs/docs/guides/solution-scenarios/b2c.mdx @@ -29,7 +29,7 @@ You can read more about how ZITADEL handles usernames [here](../manage/console/o ZITADEL gives you a basic storage for users and manages phone and email addresses. It also allows you to store your own application data such as preferences or external identifiers to the metadata of a user. If you are migrating an existing project and you already have an external identity store you can consider bulk importing your user datasets. -Read our [Management API definitions](../../apis/proto/management#importhumanuser) for more info. If the users email is not verified or no password is set, a initialization mail will be send. +Read our [Management API definitions](../../apis/mgmt) for more info. If the users email is not verified or no password is set, a initialization mail will be send. :::info Requests to the management API are rate limited. Read our [Rate limit Policy](../../legal/rate-limit-policy) for more info. diff --git a/docs/docs/self-hosting/manage/quotas.md b/docs/docs/self-hosting/manage/quotas.md index 8e78bc9de..1d0d48702 100644 --- a/docs/docs/self-hosting/manage/quotas.md +++ b/docs/docs/self-hosting/manage/quotas.md @@ -6,7 +6,7 @@ Quotas is an enterprise feature that is relevant if you want to host ZITADEL as It enables you to limit usage and/or register webhooks that trigger on configurable usage levels for certain units. For example, you might want to report usage to an external billing tool and notify users when 80 percent of a quota is exhausted. Quotas are currently supported [for the instance level only](/concepts/structure/instance). -Please refer to the [system API docs](/apis/proto/system#addquota) for detailed explanations about how to use the quotas feature. +Please refer to the [system API docs](/apis/system) for detailed explanations about how to use the quotas feature. ZITADEL supports limiting authenticated requests and action run seconds diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 8438f8ad3..4acfa8c8a 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -3,7 +3,7 @@ module.exports = { title: "ZITADEL Docs", trailingSlash: false, url: "https://zitadel.com", - baseUrl: "/docs/", + baseUrl: "/docs", onBrokenLinks: "throw", onBrokenMarkdownLinks: "warn", favicon: "img/favicon.ico", @@ -204,10 +204,28 @@ module.exports = { respectPrefersColorScheme: true, }, }, + webpack: { + jsLoader: (isServer) => ({ + loader: require.resolve('swc-loader'), + options: { + jsc: { + parser: { + syntax: 'typescript', + tsx: true, + }, + target: 'es2017', + }, + module: { + type: isServer ? 'commonjs' : 'es6', + }, + }, + }), + }, presets: [ [ - "@docusaurus/preset-classic", - { + "classic", + /** @type {import('@docusaurus/preset-classic').Options} */ + ({ docs: { routeBasePath: "/", sidebarPath: require.resolve("./sidebars.js"), @@ -215,14 +233,54 @@ module.exports = { showLastUpdateTime: true, editUrl: "https://github.com/zitadel/zitadel/edit/main/docs/", remarkPlugins: [require("mdx-mermaid")], + docLayoutComponent: "@theme/DocPage", + docItemComponent: '@theme/ApiItem' }, theme: { customCss: require.resolve("./src/css/custom.css"), }, - }, + }) ], + ], plugins: [ + [ + 'docusaurus-plugin-openapi-docs', + { + id: "apiDocs", + docsPluginId: "classic", + config: { + auth: { + specPath: ".artifacts/openapi/zitadel/auth.swagger.json", + outputDir: "docs/apis/auth", + sidebarOptions: { + groupPathsBy: "tag", + }, + }, + mgmt: { + specPath: ".artifacts/openapi/zitadel/management.swagger.json", + outputDir: "docs/apis/mgmt", + sidebarOptions: { + groupPathsBy: "tag", + }, + }, + admin: { + specPath: ".artifacts/openapi/zitadel/admin.swagger.json", + outputDir: "docs/apis/admin", + sidebarOptions: { + groupPathsBy: "tag", + }, + }, + system: { + specPath: ".artifacts/openapi/zitadel/system.swagger.json", + outputDir: "docs/apis/system", + sidebarOptions: { + groupPathsBy: "tag", + }, + } + } + }, + ], require.resolve("docusaurus-plugin-image-zoom"), async function myPlugin(context, options) { return { @@ -236,5 +294,5 @@ module.exports = { }; }, ], - themes: ["@saucelabs/theme-github-codeblock"], + themes: ["@saucelabs/theme-github-codeblock", "docusaurus-theme-openapi-docs"], }; diff --git a/docs/nginx.conf b/docs/nginx.conf new file mode 100644 index 000000000..1af667f38 --- /dev/null +++ b/docs/nginx.conf @@ -0,0 +1,56 @@ +events { + worker_connections 1024; ## Default: 1024 +} + +http { + + include /etc/nginx/mime.types; + + server { + + listen 8080; + + location / { + return 301 /docs; + } + + location /docs { + root /usr/share/nginx/html; + index /docs/index.html; + try_files $uri $uri/ /docs/index.html?q=$query_string; + } + + location = /docs/proxy/js/script.js { + proxy_pass https://plausible.io/js/script.js; + proxy_set_header Host plausible.io; + } + + location = /docs/proxy/api/event { + proxy_pass https://plausible.io/api/event; + proxy_set_header Host plausible.io; + proxy_buffering on; + proxy_http_version 1.1; + + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Forwarded-Host $host; + } + } + + ## enable gzip compression + gzip on; + gzip_vary on; + gzip_min_length 256; + gzip_proxied any; + + gzip_types + ## text/html is always compressed : https://nginx.org/en/docs/http/ngx_http_gzip_module.html + text/plain + text/css + text/javascript + application/javascript + application/x-javascript + application/xml + application/json + application/ld+json; +} \ No newline at end of file diff --git a/docs/package.json b/docs/package.json index 30fb57f41..5aa8ae953 100644 --- a/docs/package.json +++ b/docs/package.json @@ -4,14 +4,17 @@ "private": true, "scripts": { "docusaurus": "docusaurus", - "start": "docusaurus start", - "build": "docusaurus build", + "start": "yarn generate && docusaurus start", + "build": "yarn generate && docusaurus build --no-minify", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", "clear": "docusaurus clear", "serve": "docusaurus serve", "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids" + "write-heading-ids": "docusaurus write-heading-ids", + "generate": "yarn generate:grpc && yarn generate:apidocs", + "generate:grpc": "buf generate ../proto", + "generate:apidocs": "docusaurus clean-api-docs all && docusaurus gen-api-docs all" }, "dependencies": { "@algolia/autocomplete-core": "1.5.2", @@ -33,20 +36,21 @@ "@babel/preset-react": "7.16.7", "@babel/preset-typescript": "7.16.7", "@babel/runtime-corejs3": "7.17.9", + "@bufbuild/buf": "^1.14.0", "@colors/colors": "1.5.0", "@docsearch/css": "3.0.0", "@docsearch/react": "3.0.0", - "@docusaurus/core": "^2.1.0", - "@docusaurus/cssnano-preset": "^2.1.0", - "@docusaurus/module-type-aliases": "^2.1.0", - "@docusaurus/plugin-debug": "^2.1.0", - "@docusaurus/plugin-google-analytics": "^2.1.0", - "@docusaurus/plugin-google-gtag": "^2.1.0", - "@docusaurus/plugin-sitemap": "^2.1.0", - "@docusaurus/preset-classic": "^2.1.0", - "@docusaurus/theme-classic": "^2.1.0", - "@docusaurus/theme-search-algolia": "^2.1.0", - "@docusaurus/types": "^2.1.0", + "@docusaurus/core": "2.2.0", + "@docusaurus/cssnano-preset": "2.2.0", + "@docusaurus/module-type-aliases": "2.2.0", + "@docusaurus/plugin-debug": "2.2.0", + "@docusaurus/plugin-google-analytics": "2.2.0", + "@docusaurus/plugin-google-gtag": "2.2.0", + "@docusaurus/plugin-sitemap": "2.2.0", + "@docusaurus/preset-classic": "2.2.0", + "@docusaurus/theme-classic": "2.2.0", + "@docusaurus/theme-search-algolia": "2.2.0", + "@docusaurus/types": "2.2.0", "@headlessui/react": "^1.7.4", "@heroicons/react": "^2.0.13", "@jridgewell/resolve-uri": "3.0.7", @@ -60,6 +64,7 @@ "@svgr/core": "6.2.1", "@svgr/hast-util-to-babel-ast": "6.2.1", "@svgr/plugin-svgo": "6.2.0", + "@swc/core": "^1.3.36", "@types/eslint-scope": "3.7.3", "@types/http-proxy": "1.17.9", "@types/react-router-config": "5.0.6", @@ -87,7 +92,9 @@ "cssnano-preset-advanced": "5.3.3", "dns-packet": "5.3.1", "docusaurus-plugin-image-zoom": "^0.1.1", + "docusaurus-plugin-openapi-docs": "1.5.2", "docusaurus-plugin-plausible": "^0.0.5", + "docusaurus-theme-openapi-docs": "1.5.2", "eastasianwidth": "0.2.0", "enhanced-resolve": "5.9.3", "eval": "0.1.8", @@ -162,6 +169,7 @@ "sitemap": "7.1.1", "source-map-js": "1.0.2", "stylehacks": "5.1.0", + "swc-loader": "^0.2.3", "terser-webpack-plugin": "5.3.1", "type-fest": "2.12.2", "url": "^0.11.0", @@ -172,6 +180,10 @@ "widest-line": "4.0.1", "wrap-ansi": "8.0.1" }, + "resolutions": { + "@docusaurus/theme-common": "2.2.0", + "@paloaltonetworks/postman-code-generators": "1.1.13" + }, "browserslist": { "production": [ ">0.5%", diff --git a/docs/sidebars.js b/docs/sidebars.js index 540368669..80345e145 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -170,63 +170,94 @@ module.exports = { "apis/introduction", { type: "category", - label: "API Definition", + label: "Core Resources", collapsed: false, items: [ - "apis/statuscodes", { type: "category", - label: "Proto", + label: "Authenticated User", + link: { + type: "generated-index", + title: "Auth API", + slug: "/apis/auth", + description: + "The authentication API (aka Auth API) is used for all operations on the currently logged in user. The user id is taken from the sub claim in the token.", + + }, + items: require("./docs/apis/auth/sidebar.js"), + }, + { + type: "category", + label: "Organization Objects", + link: { + type: "generated-index", + title: "Management API", + slug: "/apis/mgmt", + description: + "The management API is as the name states the interface where systems can mutate IAM objects like, organizations, projects, clients, users and so on if they have the necessary access rights. To identify the current organization you can send a header x-zitadel-orgid or if no header is set, the organization of the authenticated user is set.", + }, + items: require("./docs/apis/mgmt/sidebar.js"), + }, + { + type: "category", + label: "Instance Objects", + link: { + type: "generated-index", + title: "Admin API", + slug: "/apis/admin", + description: + "This API is intended to configure and manage one ZITADEL instance itself.", + }, + items: require("./docs/apis/admin/sidebar.js"), + }, + { + type: "category", + label: "Instance Lifecycle", + link: { + type: "generated-index", + title: "System API", + slug: "/apis/system", + description: + "This API is intended to manage the different ZITADEL instances within the system.\n" + + "\n" + + "Checkout the guide how to access the ZITADEL System API.", + }, + items: require("./docs/apis/system/sidebar.js"), + }, + { + type: "category", + label: "Assets", + collapsed: true, + items: ["apis/assets/assets"], + }, + ] + }, + { + type: "category", + label: "Sign In Users ", + collapsed: false, + items: [ + { + type: "category", + label: "OpenID Connect & OAuth", collapsed: true, items: [ - "apis/proto/auth", - "apis/proto/management", - "apis/proto/admin", - "apis/proto/system", - "apis/proto/instance", - "apis/proto/org", - "apis/proto/user", - "apis/proto/app", - "apis/proto/policy", - "apis/proto/auth_n_key", - "apis/proto/change", - "apis/proto/idp", - "apis/proto/member", - "apis/proto/metadata", - "apis/proto/message", - "apis/proto/text", - "apis/proto/action", - "apis/proto/object", - "apis/proto/options", + "apis/openidoauth/endpoints", + "apis/openidoauth/authrequest", + "apis/openidoauth/scopes", + "apis/openidoauth/claims", + "apis/openidoauth/authn-methods", + "apis/openidoauth/grant-types", ], }, { type: "category", - label: "Assets API", + label: "SAML 2.0", collapsed: true, - items: ["apis/assets/assets"], + items: ["apis/saml/endpoints"], }, ], }, - { - type: "category", - label: "OpenID Connect & OAuth", - collapsed: false, - items: [ - "apis/openidoauth/endpoints", - "apis/openidoauth/authrequest", - "apis/openidoauth/scopes", - "apis/openidoauth/claims", - "apis/openidoauth/authn-methods", - "apis/openidoauth/grant-types", - ], - }, - { - type: "category", - label: "SAML", - collapsed: false, - items: ["apis/saml/endpoints"], - }, { type: "category", label: "Actions", @@ -240,6 +271,11 @@ module.exports = { "apis/actions/objects", ] }, + { + type: "doc", + label: "gRPC Status Codes", + id: "apis/statuscodes" + }, { type: "category", label: "Observability", diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 75a374a0a..13dd57f7f 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -499,3 +499,66 @@ a { p strong { color: var(--font-color-strong); } + +/* Sidebar Method labels */ +.api-method > .menu__link { + align-items: center; + justify-content: start; +} + +.api-method > .menu__link::before { + width: 50px; + height: 20px; + font-size: 12px; + line-height: 20px; + text-transform: uppercase; + font-weight: 600; + border-radius: 0.25rem; + border: 1px solid; + border-inline-start-width: 5px; + margin-right: var(--ifm-spacing-horizontal); + text-align: center; + flex-shrink: 0; +} + +.get > .menu__link::before { + content: "get"; + background-color: var(--ifm-color-info-contrast-background); + color: var(--ifm-color-info-contrast-foreground); + border-color: var(--ifm-color-info-dark); +} + +.post > .menu__link::before { + content: "post"; + background-color: var(--ifm-color-success-contrast-background); + color: var(--ifm-color-success-contrast-foreground); + border-color: var(--ifm-color-success-dark); +} + +.delete > .menu__link::before { + content: "del"; + background-color: var(--ifm-color-danger-contrast-background); + color: var(--ifm-color-danger-contrast-foreground); + border-color: var(--ifm-color-danger-dark); +} + +.put > .menu__link::before { + content: "put"; + background-color: var(--ifm-color-warning-contrast-background); + color: var(--ifm-color-warning-contrast-foreground); + border-color: var(--ifm-color-warning-dark); +} + +.patch > .menu__link::before { + content: "patch"; + background-color: var(--ifm-color-success-contrast-background); + color: var(--ifm-color-success-contrast-foreground); + border-color: var(--ifm-color-success-dark); +} + +.head > .menu__link::before { + content: "head"; + background-color: var(--ifm-color-secondary-contrast-background); + color: var(--ifm-color-secondary-contrast-foreground); + border-color: var(--ifm-color-secondary-dark); +} \ No newline at end of file diff --git a/docs/yarn.lock b/docs/yarn.lock index ecab09e82..c52e63626 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -9,12 +9,12 @@ dependencies: "@algolia/autocomplete-shared" "1.5.2" -"@algolia/autocomplete-core@1.7.2": - version "1.7.2" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.7.2.tgz#8abbed88082f611997538760dffcb43b33b1fd1d" - integrity sha512-eclwUDC6qfApNnEfu1uWcL/rudQsn59tjEoUYZYE2JSXZrHLRjBUGMxiCoknobU2Pva8ejb0eRxpIYDtVVqdsw== +"@algolia/autocomplete-core@1.7.4": + version "1.7.4" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.7.4.tgz#85ff36b2673654a393c8c505345eaedd6eaa4f70" + integrity sha512-daoLpQ3ps/VTMRZDEBfU8ixXd+amZcNJ4QSP3IERGyzqnL5Ch8uSRFt/4G8pUvW9c3o6GA4vtVv4I4lmnkdXyg== dependencies: - "@algolia/autocomplete-shared" "1.7.2" + "@algolia/autocomplete-shared" "1.7.4" "@algolia/autocomplete-preset-algolia@1.5.2": version "1.5.2" @@ -23,133 +23,133 @@ dependencies: "@algolia/autocomplete-shared" "1.5.2" -"@algolia/autocomplete-preset-algolia@1.7.2": - version "1.7.2" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.7.2.tgz#9cd4f64b3d64399657ee2dc2b7e0a939e0713a26" - integrity sha512-+RYEG6B0QiGGfRb2G3MtPfyrl0dALF3cQNTWBzBX6p5o01vCCGTTinAm2UKG3tfc2CnOMAtnPLkzNZyJUpnVJw== +"@algolia/autocomplete-preset-algolia@1.7.4": + version "1.7.4" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.7.4.tgz#610ee1d887962f230b987cba2fd6556478000bc3" + integrity sha512-s37hrvLEIfcmKY8VU9LsAXgm2yfmkdHT3DnA3SgHaY93yjZ2qL57wzb5QweVkYuEBZkT2PIREvRoLXC2sxTbpQ== dependencies: - "@algolia/autocomplete-shared" "1.7.2" + "@algolia/autocomplete-shared" "1.7.4" "@algolia/autocomplete-shared@1.5.2": version "1.5.2" resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.5.2.tgz#e157f9ad624ab8fd940ff28bd2094cdf199cdd79" integrity sha512-ylQAYv5H0YKMfHgVWX0j0NmL8XBcAeeeVQUmppnnMtzDbDnca6CzhKj3Q8eF9cHCgcdTDdb5K+3aKyGWA0obug== -"@algolia/autocomplete-shared@1.7.2": - version "1.7.2" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.7.2.tgz#daa23280e78d3b42ae9564d12470ae034db51a89" - integrity sha512-QCckjiC7xXHIUaIL3ektBtjJ0w7tTA3iqKcAE/Hjn1lZ5omp7i3Y4e09rAr9ZybqirL7AbxCLLq0Ra5DDPKeug== +"@algolia/autocomplete-shared@1.7.4": + version "1.7.4" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.7.4.tgz#78aea1140a50c4d193e1f06a13b7f12c5e2cbeea" + integrity sha512-2VGCk7I9tA9Ge73Km99+Qg87w0wzW4tgUruvWAn/gfey1ZXgmxZtyIRBebk35R1O8TbK77wujVtCnpsGpRy1kg== -"@algolia/cache-browser-local-storage@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/cache-browser-local-storage/-/cache-browser-local-storage-4.14.2.tgz#d5b1b90130ca87c6321de876e167df9ec6524936" - integrity sha512-FRweBkK/ywO+GKYfAWbrepewQsPTIEirhi1BdykX9mxvBPtGNKccYAxvGdDCumU1jL4r3cayio4psfzKMejBlA== +"@algolia/cache-browser-local-storage@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/cache-browser-local-storage/-/cache-browser-local-storage-4.14.3.tgz#b9e0da012b2f124f785134a4d468ee0841b2399d" + integrity sha512-hWH1yCxgG3+R/xZIscmUrWAIBnmBFHH5j30fY/+aPkEZWt90wYILfAHIOZ1/Wxhho5SkPfwFmT7ooX2d9JeQBw== dependencies: - "@algolia/cache-common" "4.14.2" + "@algolia/cache-common" "4.14.3" -"@algolia/cache-common@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/cache-common/-/cache-common-4.14.2.tgz#b946b6103c922f0c06006fb6929163ed2c67d598" - integrity sha512-SbvAlG9VqNanCErr44q6lEKD2qoK4XtFNx9Qn8FK26ePCI8I9yU7pYB+eM/cZdS9SzQCRJBbHUumVr4bsQ4uxg== +"@algolia/cache-common@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/cache-common/-/cache-common-4.14.3.tgz#a78e9faee3dfec018eab7b0996e918e06b476ac7" + integrity sha512-oZJofOoD9FQOwiGTzyRnmzvh3ZP8WVTNPBLH5xU5JNF7drDbRT0ocVT0h/xB2rPHYzOeXRrLaQQBwRT/CKom0Q== -"@algolia/cache-in-memory@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/cache-in-memory/-/cache-in-memory-4.14.2.tgz#88e4a21474f9ac05331c2fa3ceb929684a395a24" - integrity sha512-HrOukWoop9XB/VFojPv1R5SVXowgI56T9pmezd/djh2JnVN/vXswhXV51RKy4nCpqxyHt/aGFSq2qkDvj6KiuQ== +"@algolia/cache-in-memory@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/cache-in-memory/-/cache-in-memory-4.14.3.tgz#96cefb942aeb80e51e6a7e29f25f4f7f3439b736" + integrity sha512-ES0hHQnzWjeioLQf5Nq+x1AWdZJ50znNPSH3puB/Y4Xsg4Av1bvLmTJe7SY2uqONaeMTvL0OaVcoVtQgJVw0vg== dependencies: - "@algolia/cache-common" "4.14.2" + "@algolia/cache-common" "4.14.3" -"@algolia/client-account@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/client-account/-/client-account-4.14.2.tgz#b76ac1ba9ea71e8c3f77a1805b48350dc0728a16" - integrity sha512-WHtriQqGyibbb/Rx71YY43T0cXqyelEU0lB2QMBRXvD2X0iyeGl4qMxocgEIcbHyK7uqE7hKgjT8aBrHqhgc1w== +"@algolia/client-account@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/client-account/-/client-account-4.14.3.tgz#6d7d032a65c600339ce066505c77013d9a9e4966" + integrity sha512-PBcPb0+f5Xbh5UfLZNx2Ow589OdP8WYjB4CnvupfYBrl9JyC1sdH4jcq/ri8osO/mCZYjZrQsKAPIqW/gQmizQ== dependencies: - "@algolia/client-common" "4.14.2" - "@algolia/client-search" "4.14.2" - "@algolia/transporter" "4.14.2" + "@algolia/client-common" "4.14.3" + "@algolia/client-search" "4.14.3" + "@algolia/transporter" "4.14.3" -"@algolia/client-analytics@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-4.14.2.tgz#ca04dcaf9a78ee5c92c5cb5e9c74cf031eb2f1fb" - integrity sha512-yBvBv2mw+HX5a+aeR0dkvUbFZsiC4FKSnfqk9rrfX+QrlNOKEhCG0tJzjiOggRW4EcNqRmaTULIYvIzQVL2KYQ== +"@algolia/client-analytics@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-4.14.3.tgz#ca409d00a8fff98fdcc215dc96731039900055dc" + integrity sha512-eAwQq0Hb/aauv9NhCH5Dp3Nm29oFx28sayFN2fdOWemwSeJHIl7TmcsxVlRsO50fsD8CtPcDhtGeD3AIFLNvqw== dependencies: - "@algolia/client-common" "4.14.2" - "@algolia/client-search" "4.14.2" - "@algolia/requester-common" "4.14.2" - "@algolia/transporter" "4.14.2" + "@algolia/client-common" "4.14.3" + "@algolia/client-search" "4.14.3" + "@algolia/requester-common" "4.14.3" + "@algolia/transporter" "4.14.3" -"@algolia/client-common@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-4.14.2.tgz#e1324e167ffa8af60f3e8bcd122110fd0bfd1300" - integrity sha512-43o4fslNLcktgtDMVaT5XwlzsDPzlqvqesRi4MjQz2x4/Sxm7zYg5LRYFol1BIhG6EwxKvSUq8HcC/KxJu3J0Q== +"@algolia/client-common@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-4.14.3.tgz#c44e48652b2121a20d7a40cfd68d095ebb4191a8" + integrity sha512-jkPPDZdi63IK64Yg4WccdCsAP4pHxSkr4usplkUZM5C1l1oEpZXsy2c579LQ0rvwCs5JFmwfNG4ahOszidfWPw== dependencies: - "@algolia/requester-common" "4.14.2" - "@algolia/transporter" "4.14.2" + "@algolia/requester-common" "4.14.3" + "@algolia/transporter" "4.14.3" -"@algolia/client-personalization@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-4.14.2.tgz#656bbb6157a3dd1a4be7de65e457fda136c404ec" - integrity sha512-ACCoLi0cL8CBZ1W/2juehSltrw2iqsQBnfiu/Rbl9W2yE6o2ZUb97+sqN/jBqYNQBS+o0ekTMKNkQjHHAcEXNw== +"@algolia/client-personalization@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-4.14.3.tgz#8f71325035aa2a5fa7d1d567575235cf1d6c654f" + integrity sha512-UCX1MtkVNgaOL9f0e22x6tC9e2H3unZQlSUdnVaSKpZ+hdSChXGaRjp2UIT7pxmPqNCyv51F597KEX5WT60jNg== dependencies: - "@algolia/client-common" "4.14.2" - "@algolia/requester-common" "4.14.2" - "@algolia/transporter" "4.14.2" + "@algolia/client-common" "4.14.3" + "@algolia/requester-common" "4.14.3" + "@algolia/transporter" "4.14.3" -"@algolia/client-search@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-4.14.2.tgz#357bdb7e640163f0e33bad231dfcc21f67dc2e92" - integrity sha512-L5zScdOmcZ6NGiVbLKTvP02UbxZ0njd5Vq9nJAmPFtjffUSOGEp11BmD2oMJ5QvARgx2XbX4KzTTNS5ECYIMWw== +"@algolia/client-search@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-4.14.3.tgz#cf1e77549f5c3e73408ffe6441ede985fde69da0" + integrity sha512-I2U7xBx5OPFdPLA8AXKUPPxGY3HDxZ4r7+mlZ8ZpLbI8/ri6fnu6B4z3wcL7sgHhDYMwnAE8Xr0AB0h3Hnkp4A== dependencies: - "@algolia/client-common" "4.14.2" - "@algolia/requester-common" "4.14.2" - "@algolia/transporter" "4.14.2" + "@algolia/client-common" "4.14.3" + "@algolia/requester-common" "4.14.3" + "@algolia/transporter" "4.14.3" "@algolia/events@^4.0.1": version "4.0.1" resolved "https://registry.yarnpkg.com/@algolia/events/-/events-4.0.1.tgz#fd39e7477e7bc703d7f893b556f676c032af3950" integrity sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ== -"@algolia/logger-common@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/logger-common/-/logger-common-4.14.2.tgz#b74b3a92431f92665519d95942c246793ec390ee" - integrity sha512-/JGlYvdV++IcMHBnVFsqEisTiOeEr6cUJtpjz8zc0A9c31JrtLm318Njc72p14Pnkw3A/5lHHh+QxpJ6WFTmsA== +"@algolia/logger-common@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/logger-common/-/logger-common-4.14.3.tgz#87d4725e7f56ea5a39b605771b7149fff62032a7" + integrity sha512-kUEAZaBt/J3RjYi8MEBT2QEexJR2kAE2mtLmezsmqMQZTV502TkHCxYzTwY2dE7OKcUTxi4OFlMuS4GId9CWPw== -"@algolia/logger-console@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/logger-console/-/logger-console-4.14.2.tgz#ec49cb47408f5811d4792598683923a800abce7b" - integrity sha512-8S2PlpdshbkwlLCSAB5f8c91xyc84VM9Ar9EdfE9UmX+NrKNYnWR1maXXVDQQoto07G1Ol/tYFnFVhUZq0xV/g== +"@algolia/logger-console@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/logger-console/-/logger-console-4.14.3.tgz#1f19f8f0a5ef11f01d1f9545290eb6a89b71fb8a" + integrity sha512-ZWqAlUITktiMN2EiFpQIFCJS10N96A++yrexqC2Z+3hgF/JcKrOxOdT4nSCQoEPvU4Ki9QKbpzbebRDemZt/hw== dependencies: - "@algolia/logger-common" "4.14.2" + "@algolia/logger-common" "4.14.3" -"@algolia/requester-browser-xhr@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-4.14.2.tgz#a2cd4d9d8d90d53109cc7f3682dc6ebf20f798f2" - integrity sha512-CEh//xYz/WfxHFh7pcMjQNWgpl4wFB85lUMRyVwaDPibNzQRVcV33YS+63fShFWc2+42YEipFGH2iPzlpszmDw== +"@algolia/requester-browser-xhr@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-4.14.3.tgz#bcf55cba20f58fd9bc95ee55793b5219f3ce8888" + integrity sha512-AZeg2T08WLUPvDncl2XLX2O67W5wIO8MNaT7z5ii5LgBTuk/rU4CikTjCe2xsUleIZeFl++QrPAi4Bdxws6r/Q== dependencies: - "@algolia/requester-common" "4.14.2" + "@algolia/requester-common" "4.14.3" -"@algolia/requester-common@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/requester-common/-/requester-common-4.14.2.tgz#bc4e9e5ee16c953c0ecacbfb334a33c30c28b1a1" - integrity sha512-73YQsBOKa5fvVV3My7iZHu1sUqmjjfs9TteFWwPwDmnad7T0VTCopttcsM3OjLxZFtBnX61Xxl2T2gmG2O4ehg== +"@algolia/requester-common@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/requester-common/-/requester-common-4.14.3.tgz#2d02fbe01afb7ae5651ae8dfe62d6c089f103714" + integrity sha512-RrRzqNyKFDP7IkTuV3XvYGF9cDPn9h6qEDl595lXva3YUk9YSS8+MGZnnkOMHvjkrSCKfoLeLbm/T4tmoIeclw== -"@algolia/requester-node-http@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-4.14.2.tgz#7c1223a1785decaab1def64c83dade6bea45e115" - integrity sha512-oDbb02kd1o5GTEld4pETlPZLY0e+gOSWjWMJHWTgDXbv9rm/o2cF7japO6Vj1ENnrqWvLBmW1OzV9g6FUFhFXg== +"@algolia/requester-node-http@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-4.14.3.tgz#72389e1c2e5d964702451e75e368eefe85a09d8f" + integrity sha512-O5wnPxtDRPuW2U0EaOz9rMMWdlhwP0J0eSL1Z7TtXF8xnUeeUyNJrdhV5uy2CAp6RbhM1VuC3sOJcIR6Av+vbA== dependencies: - "@algolia/requester-common" "4.14.2" + "@algolia/requester-common" "4.14.3" -"@algolia/transporter@4.14.2": - version "4.14.2" - resolved "https://registry.yarnpkg.com/@algolia/transporter/-/transporter-4.14.2.tgz#77c069047fb1a4359ee6a51f51829508e44a1e3d" - integrity sha512-t89dfQb2T9MFQHidjHcfhh6iGMNwvuKUvojAj+JsrHAGbuSy7yE4BylhLX6R0Q1xYRoC4Vvv+O5qIw/LdnQfsQ== +"@algolia/transporter@4.14.3": + version "4.14.3" + resolved "https://registry.yarnpkg.com/@algolia/transporter/-/transporter-4.14.3.tgz#5593036bd9cf2adfd077fdc3e81d2e6118660a7a" + integrity sha512-2qlKlKsnGJ008exFRb5RTeTOqhLZj0bkMCMVskxoqWejs2Q2QtWmsiH98hDfpw0fmnyhzHEt0Z7lqxBYp8bW2w== dependencies: - "@algolia/cache-common" "4.14.2" - "@algolia/logger-common" "4.14.2" - "@algolia/requester-common" "4.14.2" + "@algolia/cache-common" "4.14.3" + "@algolia/logger-common" "4.14.3" + "@algolia/requester-common" "4.14.3" -"@ampproject/remapping@2.2.0", "@ampproject/remapping@^2.1.0": +"@ampproject/remapping@2.2.0", "@ampproject/remapping@^2.1.0", "@ampproject/remapping@^2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@ampproject/remapping/-/remapping-2.2.0.tgz#56c133824780de3174aed5ab6834f3026790154d" integrity sha512-qRmjj8nj9qmLTQXXmaR1cck3UXSRMPrbsLJAasZpF+t3riI71BXed5ebIOYwQntykeZuhjsdweEc9BxH5Jc26w== @@ -157,6 +157,16 @@ "@jridgewell/gen-mapping" "^0.1.0" "@jridgewell/trace-mapping" "^0.3.9" +"@apidevtools/json-schema-ref-parser@^9.0.9": + version "9.1.2" + resolved "https://registry.yarnpkg.com/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.1.2.tgz#8ff5386b365d4c9faa7c8b566ff16a46a577d9b8" + integrity sha512-r1w81DpR+KyRWd3f+rk6TNqMgedmAxZP5v5KWlXQWlgMUUtyEJch0DKEci1SorPMiSeM8XPl7MZ3miJ60JIpQg== + dependencies: + "@jsdevtools/ono" "^7.1.3" + "@types/json-schema" "^7.0.6" + call-me-maybe "^1.0.1" + js-yaml "^4.1.0" + "@babel/code-frame@^7.0.0", "@babel/code-frame@^7.10.4", "@babel/code-frame@^7.16.0", "@babel/code-frame@^7.16.7", "@babel/code-frame@^7.18.6", "@babel/code-frame@^7.8.3": version "7.18.6" resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.18.6.tgz#3b25d38c89600baa2dcc219edfa88a74eb2c427a" @@ -164,10 +174,10 @@ dependencies: "@babel/highlight" "^7.18.6" -"@babel/compat-data@^7.17.0", "@babel/compat-data@^7.17.10", "@babel/compat-data@^7.17.7", "@babel/compat-data@^7.19.4", "@babel/compat-data@^7.20.0": - version "7.20.1" - resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.20.1.tgz#f2e6ef7790d8c8dbf03d379502dcc246dcce0b30" - integrity sha512-EWZ4mE2diW3QALKvDMiXnbZpRvlj+nayZ112nK93SnhqOtpdsbVD4W+2tEoT3YNBAG9RBR0ISY758ZkOgsn6pQ== +"@babel/compat-data@^7.17.0", "@babel/compat-data@^7.17.10", "@babel/compat-data@^7.17.7", "@babel/compat-data@^7.20.1", "@babel/compat-data@^7.20.5": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.21.0.tgz#c241dc454e5b5917e40d37e525e2f4530c399298" + integrity sha512-gMuZsmsgxk/ENC3O/fRw5QY8A9/uxQbbCEypnLIiYYc/qVJtEV7ouxC3EllIIwNzMqAQee5tanFabWsUOutS7g== "@babel/core@7.12.9": version "7.12.9" @@ -213,33 +223,34 @@ semver "^6.3.0" "@babel/core@^7.18.6", "@babel/core@^7.19.6": - version "7.19.6" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.19.6.tgz#7122ae4f5c5a37c0946c066149abd8e75f81540f" - integrity sha512-D2Ue4KHpc6Ys2+AxpIx1BZ8+UegLLLE2p3KJEuJRKmokHOtl49jQ5ny1773KsGLZs8MQvBidAF6yWUJxRqtKtg== + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.21.0.tgz#1341aefdcc14ccc7553fcc688dd8986a2daffc13" + integrity sha512-PuxUbxcW6ZYe656yL3EAhpy7qXKq0DmYsrJLpbB8XrsCP9Nm+XCg9XFMb5vIDliPD7+U/+M+QJlH17XOcB7eXA== dependencies: - "@ampproject/remapping" "^2.1.0" + "@ampproject/remapping" "^2.2.0" "@babel/code-frame" "^7.18.6" - "@babel/generator" "^7.19.6" - "@babel/helper-compilation-targets" "^7.19.3" - "@babel/helper-module-transforms" "^7.19.6" - "@babel/helpers" "^7.19.4" - "@babel/parser" "^7.19.6" - "@babel/template" "^7.18.10" - "@babel/traverse" "^7.19.6" - "@babel/types" "^7.19.4" + "@babel/generator" "^7.21.0" + "@babel/helper-compilation-targets" "^7.20.7" + "@babel/helper-module-transforms" "^7.21.0" + "@babel/helpers" "^7.21.0" + "@babel/parser" "^7.21.0" + "@babel/template" "^7.20.7" + "@babel/traverse" "^7.21.0" + "@babel/types" "^7.21.0" convert-source-map "^1.7.0" debug "^4.1.0" gensync "^1.0.0-beta.2" - json5 "^2.2.1" + json5 "^2.2.2" semver "^6.3.0" -"@babel/generator@^7.12.5", "@babel/generator@^7.17.10", "@babel/generator@^7.18.7", "@babel/generator@^7.19.6", "@babel/generator@^7.20.1": - version "7.20.1" - resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.20.1.tgz#ef32ecd426222624cbd94871a7024639cf61a9fa" - integrity sha512-u1dMdBUmA7Z0rBB97xh8pIhviK7oItYOkjbsCxTWMknyvbQRBwX7/gn4JXurRdirWMFh+ZtYARqkA6ydogVZpg== +"@babel/generator@^7.12.5", "@babel/generator@^7.17.10", "@babel/generator@^7.18.7", "@babel/generator@^7.21.0": + version "7.21.1" + resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.21.1.tgz#951cc626057bc0af2c35cd23e9c64d384dea83dd" + integrity sha512-1lT45bAYlQhFn/BHivJs43AiW2rg3/UbLyShGfF3C0KmHvO5fSghWd5kBJy30kpRRucGzXStvnnCFniCR2kXAA== dependencies: - "@babel/types" "^7.20.0" + "@babel/types" "^7.21.0" "@jridgewell/gen-mapping" "^0.3.2" + "@jridgewell/trace-mapping" "^0.3.17" jsesc "^2.5.1" "@babel/helper-annotate-as-pure@^7.18.6": @@ -257,36 +268,38 @@ "@babel/helper-explode-assignable-expression" "^7.18.6" "@babel/types" "^7.18.9" -"@babel/helper-compilation-targets@^7.16.7", "@babel/helper-compilation-targets@^7.17.10", "@babel/helper-compilation-targets@^7.17.7", "@babel/helper-compilation-targets@^7.18.9", "@babel/helper-compilation-targets@^7.19.0", "@babel/helper-compilation-targets@^7.19.3": - version "7.20.0" - resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.20.0.tgz#6bf5374d424e1b3922822f1d9bdaa43b1a139d0a" - integrity sha512-0jp//vDGp9e8hZzBc6N/KwA5ZK3Wsm/pfm4CrY7vzegkVxc65SgSn6wYOnwHe9Js9HRQ1YTCKLGPzDtaS3RoLQ== +"@babel/helper-compilation-targets@^7.16.7", "@babel/helper-compilation-targets@^7.17.10", "@babel/helper-compilation-targets@^7.17.7", "@babel/helper-compilation-targets@^7.18.9", "@babel/helper-compilation-targets@^7.20.0", "@babel/helper-compilation-targets@^7.20.7": + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.20.7.tgz#a6cd33e93629f5eb473b021aac05df62c4cd09bb" + integrity sha512-4tGORmfQcrc+bvrjb5y3dG9Mx1IOZjsHqQVUz7XCNHO+iTmqxWnVg3KRygjGmpRLJGdQSKuvFinbIb0CnZwHAQ== dependencies: - "@babel/compat-data" "^7.20.0" + "@babel/compat-data" "^7.20.5" "@babel/helper-validator-option" "^7.18.6" browserslist "^4.21.3" + lru-cache "^5.1.1" semver "^6.3.0" -"@babel/helper-create-class-features-plugin@^7.16.10", "@babel/helper-create-class-features-plugin@^7.17.6", "@babel/helper-create-class-features-plugin@^7.18.6", "@babel/helper-create-class-features-plugin@^7.19.0": - version "7.19.0" - resolved "https://registry.yarnpkg.com/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.19.0.tgz#bfd6904620df4e46470bae4850d66be1054c404b" - integrity sha512-NRz8DwF4jT3UfrmUoZjd0Uph9HQnP30t7Ash+weACcyNkiYTywpIjDBgReJMKgr+n86sn2nPVVmJ28Dm053Kqw== +"@babel/helper-create-class-features-plugin@^7.16.10", "@babel/helper-create-class-features-plugin@^7.17.6", "@babel/helper-create-class-features-plugin@^7.18.6", "@babel/helper-create-class-features-plugin@^7.21.0": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.21.0.tgz#64f49ecb0020532f19b1d014b03bccaa1ab85fb9" + integrity sha512-Q8wNiMIdwsv5la5SPxNYzzkPnjgC0Sy0i7jLkVOCdllu/xcVNkr3TeZzbHBJrj+XXRqzX5uCyCoV9eu6xUG7KQ== dependencies: "@babel/helper-annotate-as-pure" "^7.18.6" "@babel/helper-environment-visitor" "^7.18.9" - "@babel/helper-function-name" "^7.19.0" - "@babel/helper-member-expression-to-functions" "^7.18.9" + "@babel/helper-function-name" "^7.21.0" + "@babel/helper-member-expression-to-functions" "^7.21.0" "@babel/helper-optimise-call-expression" "^7.18.6" - "@babel/helper-replace-supers" "^7.18.9" + "@babel/helper-replace-supers" "^7.20.7" + "@babel/helper-skip-transparent-expression-wrappers" "^7.20.0" "@babel/helper-split-export-declaration" "^7.18.6" -"@babel/helper-create-regexp-features-plugin@^7.17.0", "@babel/helper-create-regexp-features-plugin@^7.18.6", "@babel/helper-create-regexp-features-plugin@^7.19.0": - version "7.19.0" - resolved "https://registry.yarnpkg.com/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.19.0.tgz#7976aca61c0984202baca73d84e2337a5424a41b" - integrity sha512-htnV+mHX32DF81amCDrwIDr8nrp1PTm+3wfBN9/v8QJOLEioOCOG7qNyq0nHeFiWbT3Eb7gsPwEmV64UCQ1jzw== +"@babel/helper-create-regexp-features-plugin@^7.17.0", "@babel/helper-create-regexp-features-plugin@^7.18.6", "@babel/helper-create-regexp-features-plugin@^7.20.5": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.21.0.tgz#53ff78472e5ce10a52664272a239787107603ebb" + integrity sha512-N+LaFW/auRSWdx7SHD/HiARwXQju1vXTW4fKr4u5SgBUTm51OKEjKgj+cs00ggW3kEvNqwErnlwuq7Y3xBe4eg== dependencies: "@babel/helper-annotate-as-pure" "^7.18.6" - regexpu-core "^5.1.0" + regexpu-core "^5.3.1" "@babel/helper-define-polyfill-provider@^0.3.1", "@babel/helper-define-polyfill-provider@^0.3.2", "@babel/helper-define-polyfill-provider@^0.3.3": version "0.3.3" @@ -312,13 +325,13 @@ dependencies: "@babel/types" "^7.18.6" -"@babel/helper-function-name@^7.18.9", "@babel/helper-function-name@^7.19.0": - version "7.19.0" - resolved "https://registry.yarnpkg.com/@babel/helper-function-name/-/helper-function-name-7.19.0.tgz#941574ed5390682e872e52d3f38ce9d1bef4648c" - integrity sha512-WAwHBINyrpqywkUH0nTnNgI5ina5TFn85HKS0pbPDfxFfhyR/aNQEn4hGi1P1JyT//I0t4OgXUlofzWILRvS5w== +"@babel/helper-function-name@^7.18.9", "@babel/helper-function-name@^7.19.0", "@babel/helper-function-name@^7.21.0": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/helper-function-name/-/helper-function-name-7.21.0.tgz#d552829b10ea9f120969304023cd0645fa00b1b4" + integrity sha512-HfK1aMRanKHpxemaY2gqBmL04iAPOPRj7DxtNbiDOrJK+gdwkiNRVpCpUJYbUT+aZyemKN8brqTOxzCaG6ExRg== dependencies: - "@babel/template" "^7.18.10" - "@babel/types" "^7.19.0" + "@babel/template" "^7.20.7" + "@babel/types" "^7.21.0" "@babel/helper-hoist-variables@^7.16.7", "@babel/helper-hoist-variables@^7.18.6": version "7.18.6" @@ -327,12 +340,12 @@ dependencies: "@babel/types" "^7.18.6" -"@babel/helper-member-expression-to-functions@^7.18.9": - version "7.18.9" - resolved "https://registry.yarnpkg.com/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.18.9.tgz#1531661e8375af843ad37ac692c132841e2fd815" - integrity sha512-RxifAh2ZoVU67PyKIO4AMi1wTenGfMR/O/ae0CCRqwgBAt5v7xjdtRw7UoSbsreKrQn5t7r89eruK/9JjYHuDg== +"@babel/helper-member-expression-to-functions@^7.20.7", "@babel/helper-member-expression-to-functions@^7.21.0": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.21.0.tgz#319c6a940431a133897148515877d2f3269c3ba5" + integrity sha512-Muu8cdZwNN6mRRNG6lAYErJ5X3bRevgYR2O8wN0yn7jJSnGDu6eG59RfT29JHxGUovyfrh6Pj0XzmR7drNVL3Q== dependencies: - "@babel/types" "^7.18.9" + "@babel/types" "^7.21.0" "@babel/helper-module-imports@^7.16.7", "@babel/helper-module-imports@^7.18.6": version "7.18.6" @@ -341,19 +354,19 @@ dependencies: "@babel/types" "^7.18.6" -"@babel/helper-module-transforms@^7.12.1", "@babel/helper-module-transforms@^7.17.7", "@babel/helper-module-transforms@^7.18.6", "@babel/helper-module-transforms@^7.19.6": - version "7.19.6" - resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.19.6.tgz#6c52cc3ac63b70952d33ee987cbee1c9368b533f" - integrity sha512-fCmcfQo/KYr/VXXDIyd3CBGZ6AFhPFy1TfSEJ+PilGVlQT6jcbqtHAM4C1EciRqMza7/TpOUZliuSH+U6HAhJw== +"@babel/helper-module-transforms@^7.12.1", "@babel/helper-module-transforms@^7.17.7", "@babel/helper-module-transforms@^7.18.6", "@babel/helper-module-transforms@^7.20.11", "@babel/helper-module-transforms@^7.21.0": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.21.0.tgz#89a8f86ad748870e3d024e470b2e8405e869db67" + integrity sha512-eD/JQ21IG2i1FraJnTMbUarAUkA7G988ofehG5MDCRXaUU91rEBJuCeSoou2Sk1y4RbLYXzqEg1QLwEmRU4qcQ== dependencies: "@babel/helper-environment-visitor" "^7.18.9" "@babel/helper-module-imports" "^7.18.6" - "@babel/helper-simple-access" "^7.19.4" + "@babel/helper-simple-access" "^7.20.2" "@babel/helper-split-export-declaration" "^7.18.6" "@babel/helper-validator-identifier" "^7.19.1" - "@babel/template" "^7.18.10" - "@babel/traverse" "^7.19.6" - "@babel/types" "^7.19.4" + "@babel/template" "^7.20.7" + "@babel/traverse" "^7.21.0" + "@babel/types" "^7.21.0" "@babel/helper-optimise-call-expression@^7.18.6": version "7.18.6" @@ -367,12 +380,12 @@ resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.10.4.tgz#2f75a831269d4f677de49986dff59927533cf375" integrity sha512-O4KCvQA6lLiMU9l2eawBPMf1xPP8xPfB3iEQw150hOVTqj/rfXz0ThTb4HEzqQfs2Bmo5Ay8BzxfzVtBrr9dVg== -"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.10.4", "@babel/helper-plugin-utils@^7.12.13", "@babel/helper-plugin-utils@^7.14.5", "@babel/helper-plugin-utils@^7.16.7", "@babel/helper-plugin-utils@^7.18.6", "@babel/helper-plugin-utils@^7.18.9", "@babel/helper-plugin-utils@^7.19.0", "@babel/helper-plugin-utils@^7.8.0", "@babel/helper-plugin-utils@^7.8.3": - version "7.19.0" - resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.19.0.tgz#4796bb14961521f0f8715990bee2fb6e51ce21bf" - integrity sha512-40Ryx7I8mT+0gaNxm8JGTZFUITNqdLAgdg0hXzeVZxVD6nFsdhQvip6v8dqkRHzsz1VFpFAaOCHNn0vKBL7Czw== +"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.10.4", "@babel/helper-plugin-utils@^7.12.13", "@babel/helper-plugin-utils@^7.14.5", "@babel/helper-plugin-utils@^7.16.7", "@babel/helper-plugin-utils@^7.18.6", "@babel/helper-plugin-utils@^7.18.9", "@babel/helper-plugin-utils@^7.19.0", "@babel/helper-plugin-utils@^7.20.2", "@babel/helper-plugin-utils@^7.8.0", "@babel/helper-plugin-utils@^7.8.3": + version "7.20.2" + resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.20.2.tgz#d1b9000752b18d0877cff85a5c376ce5c3121629" + integrity sha512-8RvlJG2mj4huQ4pZ+rU9lqKi9ZKiRmuvGuM2HlWmkmgOhbs6zEAw6IEiJ5cQqGbDzGZOhwuOQNtZMi/ENLjZoQ== -"@babel/helper-remap-async-to-generator@^7.16.8", "@babel/helper-remap-async-to-generator@^7.18.6", "@babel/helper-remap-async-to-generator@^7.18.9": +"@babel/helper-remap-async-to-generator@^7.16.8", "@babel/helper-remap-async-to-generator@^7.18.9": version "7.18.9" resolved "https://registry.yarnpkg.com/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.18.9.tgz#997458a0e3357080e54e1d79ec347f8a8cd28519" integrity sha512-dI7q50YKd8BAv3VEfgg7PS7yD3Rtbi2J1XMXaalXO0W0164hYLnh8zpjRS0mte9MfVp/tltvr/cfdXPvJr1opA== @@ -382,25 +395,26 @@ "@babel/helper-wrap-function" "^7.18.9" "@babel/types" "^7.18.9" -"@babel/helper-replace-supers@^7.18.6", "@babel/helper-replace-supers@^7.18.9": - version "7.19.1" - resolved "https://registry.yarnpkg.com/@babel/helper-replace-supers/-/helper-replace-supers-7.19.1.tgz#e1592a9b4b368aa6bdb8784a711e0bcbf0612b78" - integrity sha512-T7ahH7wV0Hfs46SFh5Jz3s0B6+o8g3c+7TMxu7xKfmHikg7EAZ3I2Qk9LFhjxXq8sL7UkP5JflezNwoZa8WvWw== +"@babel/helper-replace-supers@^7.18.6", "@babel/helper-replace-supers@^7.20.7": + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/helper-replace-supers/-/helper-replace-supers-7.20.7.tgz#243ecd2724d2071532b2c8ad2f0f9f083bcae331" + integrity sha512-vujDMtB6LVfNW13jhlCrp48QNslK6JXi7lQG736HVbHz/mbf4Dc7tIRh1Xf5C0rF7BP8iiSxGMCmY6Ci1ven3A== dependencies: "@babel/helper-environment-visitor" "^7.18.9" - "@babel/helper-member-expression-to-functions" "^7.18.9" + "@babel/helper-member-expression-to-functions" "^7.20.7" "@babel/helper-optimise-call-expression" "^7.18.6" - "@babel/traverse" "^7.19.1" - "@babel/types" "^7.19.0" + "@babel/template" "^7.20.7" + "@babel/traverse" "^7.20.7" + "@babel/types" "^7.20.7" -"@babel/helper-simple-access@^7.17.7", "@babel/helper-simple-access@^7.19.4": - version "7.19.4" - resolved "https://registry.yarnpkg.com/@babel/helper-simple-access/-/helper-simple-access-7.19.4.tgz#be553f4951ac6352df2567f7daa19a0ee15668e7" - integrity sha512-f9Xq6WqBFqaDfbCzn2w85hwklswz5qsKlh7f08w4Y9yhJHpnNC0QemtSkK5YyOY8kPGvyiwdzZksGUhnGdaUIg== +"@babel/helper-simple-access@^7.17.7", "@babel/helper-simple-access@^7.20.2": + version "7.20.2" + resolved "https://registry.yarnpkg.com/@babel/helper-simple-access/-/helper-simple-access-7.20.2.tgz#0ab452687fe0c2cfb1e2b9e0015de07fc2d62dd9" + integrity sha512-+0woI/WPq59IrqDYbVGfshjT5Dmk/nnbdpcF8SnMhhXObpTq2KNBdLFRFrkVdbDOyUmHBCxzm5FHV1rACIkIbA== dependencies: - "@babel/types" "^7.19.4" + "@babel/types" "^7.20.2" -"@babel/helper-skip-transparent-expression-wrappers@^7.18.9": +"@babel/helper-skip-transparent-expression-wrappers@^7.20.0": version "7.20.0" resolved "https://registry.yarnpkg.com/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.20.0.tgz#fbe4c52f60518cab8140d77101f0e63a8a230684" integrity sha512-5y1JYeNKfvnT8sZcK9DVRtpTbGiomYIHviSP3OQWmDPU3DeH4a1ZlT/N2lyQ5P8egjcRaT/Y9aNqUxK0WsnIIg== @@ -424,29 +438,29 @@ resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.19.1.tgz#7eea834cf32901ffdc1a7ee555e2f9c27e249ca2" integrity sha512-awrNfaMtnHUr653GgGEs++LlAvW6w+DcPrOliSMXWCKo597CwL5Acf/wWdNkf/tfEQE3mjkeD1YOVZOUV/od1w== -"@babel/helper-validator-option@^7.16.7", "@babel/helper-validator-option@^7.18.6": - version "7.18.6" - resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.18.6.tgz#bf0d2b5a509b1f336099e4ff36e1a63aa5db4db8" - integrity sha512-XO7gESt5ouv/LRJdrVjkShckw6STTaB7l9BrpBaAHDeF5YZT+01PCwmR0SJHnkW6i8OwW/EVWRShfi4j2x+KQw== +"@babel/helper-validator-option@^7.16.7", "@babel/helper-validator-option@^7.18.6", "@babel/helper-validator-option@^7.21.0": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.21.0.tgz#8224c7e13ace4bafdc4004da2cf064ef42673180" + integrity sha512-rmL/B8/f0mKS2baE9ZpyTcTavvEuWhTTW8amjzXNvYG4AwBsqTLikfXsEofsJEfKHf+HQVQbFOHy6o+4cnC/fQ== "@babel/helper-wrap-function@^7.18.9": - version "7.19.0" - resolved "https://registry.yarnpkg.com/@babel/helper-wrap-function/-/helper-wrap-function-7.19.0.tgz#89f18335cff1152373222f76a4b37799636ae8b1" - integrity sha512-txX8aN8CZyYGTwcLhlk87KRqncAzhh5TpQamZUa0/u3an36NtDpUP6bQgBCBcLeBs09R/OwQu3OjK0k/HwfNDg== + version "7.20.5" + resolved "https://registry.yarnpkg.com/@babel/helper-wrap-function/-/helper-wrap-function-7.20.5.tgz#75e2d84d499a0ab3b31c33bcfe59d6b8a45f62e3" + integrity sha512-bYMxIWK5mh+TgXGVqAtnu5Yn1un+v8DDZtqyzKRLUzrh70Eal2O3aZ7aPYiMADO4uKlkzOiRiZ6GX5q3qxvW9Q== dependencies: "@babel/helper-function-name" "^7.19.0" "@babel/template" "^7.18.10" - "@babel/traverse" "^7.19.0" - "@babel/types" "^7.19.0" + "@babel/traverse" "^7.20.5" + "@babel/types" "^7.20.5" -"@babel/helpers@^7.12.5", "@babel/helpers@^7.17.9", "@babel/helpers@^7.19.4": - version "7.20.1" - resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.20.1.tgz#2ab7a0fcb0a03b5bf76629196ed63c2d7311f4c9" - integrity sha512-J77mUVaDTUJFZ5BpP6mMn6OIl3rEWymk2ZxDBQJUG3P+PbmyMcF3bYWvz0ma69Af1oobDqT/iAsvzhB58xhQUg== +"@babel/helpers@^7.12.5", "@babel/helpers@^7.17.9", "@babel/helpers@^7.21.0": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.21.0.tgz#9dd184fb5599862037917cdc9eecb84577dc4e7e" + integrity sha512-XXve0CBtOW0pd7MRzzmoyuSj0e3SEzj8pgyFxnTT1NJZL38BD1MK7yYrm8yefRPIDvNNe14xR4FdbHwpInD4rA== dependencies: - "@babel/template" "^7.18.10" - "@babel/traverse" "^7.20.1" - "@babel/types" "^7.20.0" + "@babel/template" "^7.20.7" + "@babel/traverse" "^7.21.0" + "@babel/types" "^7.21.0" "@babel/highlight@^7.18.6": version "7.18.6" @@ -457,10 +471,10 @@ chalk "^2.0.0" js-tokens "^4.0.0" -"@babel/parser@^7.12.7", "@babel/parser@^7.17.10", "@babel/parser@^7.18.10", "@babel/parser@^7.18.8", "@babel/parser@^7.19.6", "@babel/parser@^7.20.1": - version "7.20.1" - resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.20.1.tgz#3e045a92f7b4623cafc2425eddcb8cf2e54f9cc5" - integrity sha512-hp0AYxaZJhxULfM1zyp7Wgr+pSUKBcP3M+PHnSzWGdXOzg/kHWIgiUWARvubhUKGOEw3xqY4x+lyZ9ytBVcELw== +"@babel/parser@^7.12.7", "@babel/parser@^7.17.10", "@babel/parser@^7.18.8", "@babel/parser@^7.20.7", "@babel/parser@^7.21.0": + version "7.21.1" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.21.1.tgz#a8f81ee2fe872af23faea4b17a08fcc869de7bcc" + integrity sha512-JzhBFpkuhBNYUY7qs+wTzNmyCWUHEaAFpQQD2YfU1rPL38/L43Wvid0fFkiOCnHvsGncRZgEPyGnltABLcVDTg== "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@^7.16.7", "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@^7.18.6": version "7.18.6" @@ -470,13 +484,13 @@ "@babel/helper-plugin-utils" "^7.18.6" "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@^7.16.7", "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@^7.18.9": - version "7.18.9" - resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.18.9.tgz#a11af19aa373d68d561f08e0a57242350ed0ec50" - integrity sha512-AHrP9jadvH7qlOj6PINbgSuphjQUAK7AOT7DPjBo9EHoLhQTnnK5u45e1Hd4DbSQEO9nqPWtQ89r+XEOWFScKg== + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.20.7.tgz#d9c85589258539a22a901033853101a6198d4ef1" + integrity sha512-sbr9+wNE5aXMBBFBICk01tt7sBf2Oc9ikRFEcem/ZORup9IMUdNhW7/wVLEbbtlWOsEubJet46mHAL2C8+2jKQ== dependencies: - "@babel/helper-plugin-utils" "^7.18.9" - "@babel/helper-skip-transparent-expression-wrappers" "^7.18.9" - "@babel/plugin-proposal-optional-chaining" "^7.18.9" + "@babel/helper-plugin-utils" "^7.20.2" + "@babel/helper-skip-transparent-expression-wrappers" "^7.20.0" + "@babel/plugin-proposal-optional-chaining" "^7.20.7" "@babel/plugin-proposal-async-generator-functions@7.16.8": version "7.16.8" @@ -487,13 +501,13 @@ "@babel/helper-remap-async-to-generator" "^7.16.8" "@babel/plugin-syntax-async-generators" "^7.8.4" -"@babel/plugin-proposal-async-generator-functions@^7.16.8", "@babel/plugin-proposal-async-generator-functions@^7.19.1": - version "7.20.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-async-generator-functions/-/plugin-proposal-async-generator-functions-7.20.1.tgz#352f02baa5d69f4e7529bdac39aaa02d41146af9" - integrity sha512-Gh5rchzSwE4kC+o/6T8waD0WHEQIsDmjltY8WnWRXHUdH8axZhuH86Ov9M72YhJfDrZseQwuuWaaIT/TmePp3g== +"@babel/plugin-proposal-async-generator-functions@^7.16.8", "@babel/plugin-proposal-async-generator-functions@^7.20.1": + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-async-generator-functions/-/plugin-proposal-async-generator-functions-7.20.7.tgz#bfb7276d2d573cb67ba379984a2334e262ba5326" + integrity sha512-xMbiLsn/8RK7Wq7VeVytytS2L6qE69bXPB10YCmMdDZbKF4okCqY74pI/jJQ/8U0b/F6NrT2+14b8/P9/3AMGA== dependencies: "@babel/helper-environment-visitor" "^7.18.9" - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/helper-remap-async-to-generator" "^7.18.9" "@babel/plugin-syntax-async-generators" "^7.8.4" @@ -515,12 +529,12 @@ "@babel/plugin-syntax-class-static-block" "^7.14.5" "@babel/plugin-proposal-class-static-block@^7.17.6", "@babel/plugin-proposal-class-static-block@^7.18.6": - version "7.18.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-class-static-block/-/plugin-proposal-class-static-block-7.18.6.tgz#8aa81d403ab72d3962fc06c26e222dacfc9b9020" - integrity sha512-+I3oIiNxrCpup3Gi8n5IGMwj0gOCAjcJUSQEcotNnCCPMEnixawOQ+KeJPlgfjzx+FKQ1QSyZOWe7wmoJp7vhw== + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-class-static-block/-/plugin-proposal-class-static-block-7.21.0.tgz#77bdd66fb7b605f3a61302d224bdfacf5547977d" + integrity sha512-XP5G9MWNUskFuP30IfFSEFB0Z6HzLIUcjYM4bYOPHXl7eiJ9HFv8tWj6TXTN5QODiEhDZAeI4hLok2iHFFV4hw== dependencies: - "@babel/helper-create-class-features-plugin" "^7.18.6" - "@babel/helper-plugin-utils" "^7.18.6" + "@babel/helper-create-class-features-plugin" "^7.21.0" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-syntax-class-static-block" "^7.14.5" "@babel/plugin-proposal-dynamic-import@^7.16.7", "@babel/plugin-proposal-dynamic-import@^7.18.6": @@ -548,11 +562,11 @@ "@babel/plugin-syntax-json-strings" "^7.8.3" "@babel/plugin-proposal-logical-assignment-operators@^7.16.7", "@babel/plugin-proposal-logical-assignment-operators@^7.18.9": - version "7.18.9" - resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-logical-assignment-operators/-/plugin-proposal-logical-assignment-operators-7.18.9.tgz#8148cbb350483bf6220af06fa6db3690e14b2e23" - integrity sha512-128YbMpjCrP35IOExw2Fq+x55LMP42DzhOhX2aNNIdI9avSWl2PI0yuBWarr3RYpZBSPtabfadkH2yeRiMD61Q== + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-logical-assignment-operators/-/plugin-proposal-logical-assignment-operators-7.20.7.tgz#dfbcaa8f7b4d37b51e8bfb46d94a5aea2bb89d83" + integrity sha512-y7C7cZgpMIjWlKE5T7eJwp+tnRYM89HmRvWM5EQuB5BoHEONjmQ8lSNmBUwOyy/GFRsohJED51YBF79hE1djug== dependencies: - "@babel/helper-plugin-utils" "^7.18.9" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-syntax-logical-assignment-operators" "^7.10.4" "@babel/plugin-proposal-nullish-coalescing-operator@^7.16.7", "@babel/plugin-proposal-nullish-coalescing-operator@^7.18.6": @@ -591,16 +605,16 @@ "@babel/plugin-syntax-object-rest-spread" "^7.8.3" "@babel/plugin-transform-parameters" "^7.16.7" -"@babel/plugin-proposal-object-rest-spread@^7.17.3", "@babel/plugin-proposal-object-rest-spread@^7.19.4": - version "7.19.4" - resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-object-rest-spread/-/plugin-proposal-object-rest-spread-7.19.4.tgz#a8fc86e8180ff57290c91a75d83fe658189b642d" - integrity sha512-wHmj6LDxVDnL+3WhXteUBaoM1aVILZODAUjg11kHqG4cOlfgMQGxw6aCgvrXrmaJR3Bn14oZhImyCPZzRpC93Q== +"@babel/plugin-proposal-object-rest-spread@^7.17.3", "@babel/plugin-proposal-object-rest-spread@^7.20.2": + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-object-rest-spread/-/plugin-proposal-object-rest-spread-7.20.7.tgz#aa662940ef425779c75534a5c41e9d936edc390a" + integrity sha512-d2S98yCiLxDVmBmE8UjGcfPvNEUbA1U5q5WxaWFUGRzJSVAZqm5W6MbPct0jxnegUZ0niLeNX+IOzEs7wYg9Dg== dependencies: - "@babel/compat-data" "^7.19.4" - "@babel/helper-compilation-targets" "^7.19.3" - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/compat-data" "^7.20.5" + "@babel/helper-compilation-targets" "^7.20.7" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-syntax-object-rest-spread" "^7.8.3" - "@babel/plugin-transform-parameters" "^7.18.8" + "@babel/plugin-transform-parameters" "^7.20.7" "@babel/plugin-proposal-optional-catch-binding@^7.16.7", "@babel/plugin-proposal-optional-catch-binding@^7.18.6": version "7.18.6" @@ -610,13 +624,13 @@ "@babel/helper-plugin-utils" "^7.18.6" "@babel/plugin-syntax-optional-catch-binding" "^7.8.3" -"@babel/plugin-proposal-optional-chaining@^7.16.7", "@babel/plugin-proposal-optional-chaining@^7.18.9": - version "7.18.9" - resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-optional-chaining/-/plugin-proposal-optional-chaining-7.18.9.tgz#e8e8fe0723f2563960e4bf5e9690933691915993" - integrity sha512-v5nwt4IqBXihxGsW2QmCWMDS3B3bzGIk/EQVZz2ei7f3NJl8NzAJVvUmpDW5q1CRNY+Beb/k58UAH1Km1N411w== +"@babel/plugin-proposal-optional-chaining@^7.16.7", "@babel/plugin-proposal-optional-chaining@^7.18.9", "@babel/plugin-proposal-optional-chaining@^7.20.7": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-optional-chaining/-/plugin-proposal-optional-chaining-7.21.0.tgz#886f5c8978deb7d30f678b2e24346b287234d3ea" + integrity sha512-p4zeefM72gpmEe2fkUr/OnOXpWEf8nAgk7ZYVqqfFiyIG7oFfVZcCrU64hWn5xp4tQ9LkV4bTIa5rD0KANpKNA== dependencies: - "@babel/helper-plugin-utils" "^7.18.9" - "@babel/helper-skip-transparent-expression-wrappers" "^7.18.9" + "@babel/helper-plugin-utils" "^7.20.2" + "@babel/helper-skip-transparent-expression-wrappers" "^7.20.0" "@babel/plugin-syntax-optional-chaining" "^7.8.3" "@babel/plugin-proposal-private-methods@7.16.11": @@ -636,13 +650,13 @@ "@babel/helper-plugin-utils" "^7.18.6" "@babel/plugin-proposal-private-property-in-object@^7.16.7", "@babel/plugin-proposal-private-property-in-object@^7.18.6": - version "7.18.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.18.6.tgz#a64137b232f0aca3733a67eb1a144c192389c503" - integrity sha512-9Rysx7FOctvT5ouj5JODjAFAkgGoudQuLPamZb0v1TGLpapdNaftzifU8NTWQm0IRjqoYypdrSmyWgkocDQ8Dw== + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0.tgz#19496bd9883dd83c23c7d7fc45dcd9ad02dfa1dc" + integrity sha512-ha4zfehbJjc5MmXBlHec1igel5TJXXLDDRbuJ4+XT2TJcyD9/V1919BA8gMvsdHcNMBy4WBUBiRb3nw/EQUtBw== dependencies: "@babel/helper-annotate-as-pure" "^7.18.6" - "@babel/helper-create-class-features-plugin" "^7.18.6" - "@babel/helper-plugin-utils" "^7.18.6" + "@babel/helper-create-class-features-plugin" "^7.21.0" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-syntax-private-property-in-object" "^7.14.5" "@babel/plugin-proposal-unicode-property-regex@^7.16.7", "@babel/plugin-proposal-unicode-property-regex@^7.18.6", "@babel/plugin-proposal-unicode-property-regex@^7.4.4": @@ -688,7 +702,7 @@ dependencies: "@babel/helper-plugin-utils" "^7.8.3" -"@babel/plugin-syntax-import-assertions@^7.18.6": +"@babel/plugin-syntax-import-assertions@^7.20.0": version "7.20.0" resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.20.0.tgz#bb50e0d4bea0957235390641209394e87bdb9cc4" integrity sha512-IUh1vakzNoWalR8ch/areW7qFopR2AEw03JlG7BbrDqmQ4X3q9uuipQwSGrUn7oGiemKjtSLDhNtQHzMHr1JdQ== @@ -780,11 +794,11 @@ "@babel/helper-plugin-utils" "^7.19.0" "@babel/plugin-transform-arrow-functions@^7.16.7", "@babel/plugin-transform-arrow-functions@^7.18.6": - version "7.18.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.18.6.tgz#19063fcf8771ec7b31d742339dac62433d0611fe" - integrity sha512-9S9X9RUefzrsHZmKMbDXxweEH+YlE8JJEuat9FdvW9Qh1cw7W64jELCtWNkPBPX5En45uy28KGvA/AySqUh8CQ== + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.20.7.tgz#bea332b0e8b2dab3dafe55a163d8227531ab0551" + integrity sha512-3poA5E7dzDomxj9WXWwuD6A5F3kc7VXwIJO+E+J8qtDtS+pXPAhrgEyh+9GBwBgPq1Z+bB+/JD60lp5jsN7JPQ== dependencies: - "@babel/helper-plugin-utils" "^7.18.6" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-transform-async-to-generator@7.16.8": version "7.16.8" @@ -796,13 +810,13 @@ "@babel/helper-remap-async-to-generator" "^7.16.8" "@babel/plugin-transform-async-to-generator@^7.16.8", "@babel/plugin-transform-async-to-generator@^7.18.6": - version "7.18.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.18.6.tgz#ccda3d1ab9d5ced5265fdb13f1882d5476c71615" - integrity sha512-ARE5wZLKnTgPW7/1ftQmSi1CmkqqHo2DNmtztFhvgtOWSDfq0Cq9/9L+KnZNYSNrydBekhW3rwShduf59RoXag== + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.20.7.tgz#dfee18623c8cb31deb796aa3ca84dda9cea94354" + integrity sha512-Uo5gwHPT9vgnSXQxqGtpdufUiWp96gk7yiP4Mp5bm1QMkEmLXBO7PAGYbKoJ6DhAwiNkcHFBol/x5zZZkL/t0Q== dependencies: "@babel/helper-module-imports" "^7.18.6" - "@babel/helper-plugin-utils" "^7.18.6" - "@babel/helper-remap-async-to-generator" "^7.18.6" + "@babel/helper-plugin-utils" "^7.20.2" + "@babel/helper-remap-async-to-generator" "^7.18.9" "@babel/plugin-transform-block-scoped-functions@^7.16.7", "@babel/plugin-transform-block-scoped-functions@^7.18.6": version "7.18.6" @@ -811,34 +825,35 @@ dependencies: "@babel/helper-plugin-utils" "^7.18.6" -"@babel/plugin-transform-block-scoping@^7.16.7", "@babel/plugin-transform-block-scoping@^7.19.4": - version "7.20.0" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.20.0.tgz#91fe5e6ffc9ba13cb6c95ed7f0b1204f68c988c5" - integrity sha512-sXOohbpHZSk7GjxK9b3dKB7CfqUD5DwOH+DggKzOQ7TXYP+RCSbRykfjQmn/zq+rBjycVRtLf9pYhAaEJA786w== +"@babel/plugin-transform-block-scoping@^7.16.7", "@babel/plugin-transform-block-scoping@^7.20.2": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.21.0.tgz#e737b91037e5186ee16b76e7ae093358a5634f02" + integrity sha512-Mdrbunoh9SxwFZapeHVrwFmri16+oYotcZysSzhNIVDwIAb1UV+kvnxULSYq9J3/q5MDG+4X6w8QVgD1zhBXNQ== dependencies: - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/helper-plugin-utils" "^7.20.2" -"@babel/plugin-transform-classes@^7.16.7", "@babel/plugin-transform-classes@^7.19.0": - version "7.19.0" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-classes/-/plugin-transform-classes-7.19.0.tgz#0e61ec257fba409c41372175e7c1e606dc79bb20" - integrity sha512-YfeEE9kCjqTS9IitkgfJuxjcEtLUHMqa8yUJ6zdz8vR7hKuo6mOy2C05P0F1tdMmDCeuyidKnlrw/iTppHcr2A== +"@babel/plugin-transform-classes@^7.16.7", "@babel/plugin-transform-classes@^7.20.2": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-classes/-/plugin-transform-classes-7.21.0.tgz#f469d0b07a4c5a7dbb21afad9e27e57b47031665" + integrity sha512-RZhbYTCEUAe6ntPehC4hlslPWosNHDox+vAs4On/mCLRLfoDVHf6hVEd7kuxr1RnHwJmxFfUM3cZiZRmPxJPXQ== dependencies: "@babel/helper-annotate-as-pure" "^7.18.6" - "@babel/helper-compilation-targets" "^7.19.0" + "@babel/helper-compilation-targets" "^7.20.7" "@babel/helper-environment-visitor" "^7.18.9" - "@babel/helper-function-name" "^7.19.0" + "@babel/helper-function-name" "^7.21.0" "@babel/helper-optimise-call-expression" "^7.18.6" - "@babel/helper-plugin-utils" "^7.19.0" - "@babel/helper-replace-supers" "^7.18.9" + "@babel/helper-plugin-utils" "^7.20.2" + "@babel/helper-replace-supers" "^7.20.7" "@babel/helper-split-export-declaration" "^7.18.6" globals "^11.1.0" "@babel/plugin-transform-computed-properties@^7.16.7", "@babel/plugin-transform-computed-properties@^7.18.9": - version "7.18.9" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.18.9.tgz#2357a8224d402dad623caf6259b611e56aec746e" - integrity sha512-+i0ZU1bCDymKakLxn5srGHrsAPRELC2WIbzwjLhHW9SIE1cPYkLCL0NlnXMZaM1vhfgA2+M7hySk42VBvrkBRw== + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.20.7.tgz#704cc2fd155d1c996551db8276d55b9d46e4d0aa" + integrity sha512-Lz7MvBK6DTjElHAmfu6bfANzKcxpyNPeYBGEafyA6E5HtRpjpZwU+u7Qrgz/2OR0z+5TvKYbPdphfSaAcZBrYQ== dependencies: - "@babel/helper-plugin-utils" "^7.18.9" + "@babel/helper-plugin-utils" "^7.20.2" + "@babel/template" "^7.20.7" "@babel/plugin-transform-destructuring@7.17.7": version "7.17.7" @@ -847,12 +862,12 @@ dependencies: "@babel/helper-plugin-utils" "^7.16.7" -"@babel/plugin-transform-destructuring@^7.17.7", "@babel/plugin-transform-destructuring@^7.19.4": - version "7.20.0" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.20.0.tgz#712829ef4825d9cc04bb379de316f981e9a6f648" - integrity sha512-1dIhvZfkDVx/zn2S1aFwlruspTt4189j7fEkH0Y0VyuDM6bQt7bD6kLcz3l4IlLG+e5OReaBz9ROAbttRtUHqA== +"@babel/plugin-transform-destructuring@^7.17.7", "@babel/plugin-transform-destructuring@^7.20.2": + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.20.7.tgz#8bda578f71620c7de7c93af590154ba331415454" + integrity sha512-Xwg403sRrZb81IVB79ZPqNQME23yhugYVqgTxAhT99h485F4f+GMELFhhOsscDUB7HCswepKeCKLn/GZvUKoBA== dependencies: - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-transform-dotall-regex@^7.16.7", "@babel/plugin-transform-dotall-regex@^7.18.6", "@babel/plugin-transform-dotall-regex@^7.4.4": version "7.18.6" @@ -878,11 +893,11 @@ "@babel/helper-plugin-utils" "^7.18.6" "@babel/plugin-transform-for-of@^7.16.7", "@babel/plugin-transform-for-of@^7.18.8": - version "7.18.8" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.18.8.tgz#6ef8a50b244eb6a0bdbad0c7c61877e4e30097c1" - integrity sha512-yEfTRnjuskWYo0k1mHUqrVWaZwrdq8AYbfrpqULOJOaucGSp4mNMVps+YtA8byoevxS/urwU75vyhQIxcCgiBQ== + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.21.0.tgz#964108c9988de1a60b4be2354a7d7e245f36e86e" + integrity sha512-LlUYlydgDkKpIY7mcBWvyPPmMcOphEyYA27Ef4xpbh1IiDNLr0kZsos2nf92vz3IccvJI25QUwp86Eo5s6HmBQ== dependencies: - "@babel/helper-plugin-utils" "^7.18.6" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-transform-function-name@^7.16.7", "@babel/plugin-transform-function-name@^7.18.9": version "7.18.9" @@ -907,13 +922,13 @@ dependencies: "@babel/helper-plugin-utils" "^7.18.6" -"@babel/plugin-transform-modules-amd@^7.16.7", "@babel/plugin-transform-modules-amd@^7.18.6": - version "7.19.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.19.6.tgz#aca391801ae55d19c4d8d2ebfeaa33df5f2a2cbd" - integrity sha512-uG3od2mXvAtIFQIh0xrpLH6r5fpSQN04gIVovl+ODLdUMANokxQLZnPBHcjmv3GxRjnqwLuHvppjjcelqUFZvg== +"@babel/plugin-transform-modules-amd@^7.16.7", "@babel/plugin-transform-modules-amd@^7.19.6": + version "7.20.11" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.20.11.tgz#3daccca8e4cc309f03c3a0c4b41dc4b26f55214a" + integrity sha512-NuzCt5IIYOW0O30UvqktzHYR2ud5bOWbY0yaxWZ6G+aFzOMJvrs5YHNikrbdaT15+KNO31nPOy5Fim3ku6Zb5g== dependencies: - "@babel/helper-module-transforms" "^7.19.6" - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/helper-module-transforms" "^7.20.11" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-transform-modules-commonjs@7.17.9": version "7.17.9" @@ -925,14 +940,14 @@ "@babel/helper-simple-access" "^7.17.7" babel-plugin-dynamic-import-node "^2.3.3" -"@babel/plugin-transform-modules-commonjs@^7.17.9", "@babel/plugin-transform-modules-commonjs@^7.18.6": - version "7.19.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.19.6.tgz#25b32feef24df8038fc1ec56038917eacb0b730c" - integrity sha512-8PIa1ym4XRTKuSsOUXqDG0YaOlEuTVvHMe5JCfgBMOtHvJKw/4NGovEGN33viISshG/rZNVrACiBmPQLvWN8xQ== +"@babel/plugin-transform-modules-commonjs@^7.17.9", "@babel/plugin-transform-modules-commonjs@^7.19.6": + version "7.20.11" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.20.11.tgz#8cb23010869bf7669fd4b3098598b6b2be6dc607" + integrity sha512-S8e1f7WQ7cimJQ51JkAaDrEtohVEitXjgCGAS2N8S31Y42E+kWwfSz83LYz57QdBm7q9diARVqanIaH2oVgQnw== dependencies: - "@babel/helper-module-transforms" "^7.19.6" - "@babel/helper-plugin-utils" "^7.19.0" - "@babel/helper-simple-access" "^7.19.4" + "@babel/helper-module-transforms" "^7.20.11" + "@babel/helper-plugin-utils" "^7.20.2" + "@babel/helper-simple-access" "^7.20.2" "@babel/plugin-transform-modules-systemjs@7.17.8": version "7.17.8" @@ -945,14 +960,14 @@ "@babel/helper-validator-identifier" "^7.16.7" babel-plugin-dynamic-import-node "^2.3.3" -"@babel/plugin-transform-modules-systemjs@^7.17.8", "@babel/plugin-transform-modules-systemjs@^7.19.0": - version "7.19.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.19.6.tgz#59e2a84064b5736a4471b1aa7b13d4431d327e0d" - integrity sha512-fqGLBepcc3kErfR9R3DnVpURmckXP7gj7bAlrTQyBxrigFqszZCkFkcoxzCp2v32XmwXLvbw+8Yq9/b+QqksjQ== +"@babel/plugin-transform-modules-systemjs@^7.17.8", "@babel/plugin-transform-modules-systemjs@^7.19.6": + version "7.20.11" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.20.11.tgz#467ec6bba6b6a50634eea61c9c232654d8a4696e" + integrity sha512-vVu5g9BPQKSFEmvt2TA4Da5N+QVS66EX21d8uoOihC+OCpUoGvzVsXeqFdtAEfVa5BILAeFt+U7yVmLbQnAJmw== dependencies: "@babel/helper-hoist-variables" "^7.18.6" - "@babel/helper-module-transforms" "^7.19.6" - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/helper-module-transforms" "^7.20.11" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/helper-validator-identifier" "^7.19.1" "@babel/plugin-transform-modules-umd@^7.16.7", "@babel/plugin-transform-modules-umd@^7.18.6": @@ -971,12 +986,12 @@ "@babel/helper-create-regexp-features-plugin" "^7.17.0" "@babel/plugin-transform-named-capturing-groups-regex@^7.17.10", "@babel/plugin-transform-named-capturing-groups-regex@^7.19.1": - version "7.19.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.19.1.tgz#ec7455bab6cd8fb05c525a94876f435a48128888" - integrity sha512-oWk9l9WItWBQYS4FgXD4Uyy5kq898lvkXpXQxoJEY1RnvPk4R/Dvu2ebXU9q8lP+rlMwUQTFf2Ok6d78ODa0kw== + version "7.20.5" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.20.5.tgz#626298dd62ea51d452c3be58b285d23195ba69a8" + integrity sha512-mOW4tTzi5iTLnw+78iEq3gr8Aoq4WNRGpmSlrogqaiCBoR1HFhpU4JkpQFOHfeYx3ReVIFWOQJS4aZBRvuZ6mA== dependencies: - "@babel/helper-create-regexp-features-plugin" "^7.19.0" - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/helper-create-regexp-features-plugin" "^7.20.5" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-transform-new-target@^7.16.7", "@babel/plugin-transform-new-target@^7.18.6": version "7.18.6" @@ -993,12 +1008,12 @@ "@babel/helper-plugin-utils" "^7.18.6" "@babel/helper-replace-supers" "^7.18.6" -"@babel/plugin-transform-parameters@^7.12.1", "@babel/plugin-transform-parameters@^7.16.7", "@babel/plugin-transform-parameters@^7.18.8": - version "7.20.1" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.20.1.tgz#9a5aa370fdcce36f110455e9369db7afca0f9eeb" - integrity sha512-nDvKLrAvl+kf6BOy1UJ3MGwzzfTMgppxwiD2Jb4LO3xjYyZq30oQzDNJbCQpMdG9+j2IXHoiMrw5Cm/L6ZoxXQ== +"@babel/plugin-transform-parameters@^7.12.1", "@babel/plugin-transform-parameters@^7.16.7", "@babel/plugin-transform-parameters@^7.20.1", "@babel/plugin-transform-parameters@^7.20.7": + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.20.7.tgz#0ee349e9d1bc96e78e3b37a7af423a4078a7083f" + integrity sha512-WiWBIkeHKVOSYPO0pWkxGPfKeWrCJyD3NJ53+Lrp/QMSZbsVPovrVl2aWZ19D/LTVnaDv5Ap7GJ/B2CTOZdrfA== dependencies: - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-transform-property-literals@^7.16.7", "@babel/plugin-transform-property-literals@^7.18.6": version "7.18.6" @@ -1008,11 +1023,11 @@ "@babel/helper-plugin-utils" "^7.18.6" "@babel/plugin-transform-react-constant-elements@^7.18.12": - version "7.18.12" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-constant-elements/-/plugin-transform-react-constant-elements-7.18.12.tgz#edf3bec47eb98f14e84fa0af137fcc6aad8e0443" - integrity sha512-Q99U9/ttiu+LMnRU8psd23HhvwXmKWDQIpocm0JKaICcZHnw+mdQbHm6xnSy7dOl8I5PELakYtNBubNQlBXbZw== + version "7.20.2" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-constant-elements/-/plugin-transform-react-constant-elements-7.20.2.tgz#3f02c784e0b711970d7d8ccc96c4359d64e27ac7" + integrity sha512-KS/G8YI8uwMGKErLFOHS/ekhqdHhpEloxs43NecQHVgo2QuQSyJhGIY1fL8UGl9wy5ItVwwoUL4YxVqsplGq2g== dependencies: - "@babel/helper-plugin-utils" "^7.18.9" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-transform-react-display-name@^7.16.7", "@babel/plugin-transform-react-display-name@^7.18.6": version "7.18.6" @@ -1029,15 +1044,15 @@ "@babel/plugin-transform-react-jsx" "^7.18.6" "@babel/plugin-transform-react-jsx@^7.16.7", "@babel/plugin-transform-react-jsx@^7.18.6": - version "7.19.0" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.19.0.tgz#b3cbb7c3a00b92ec8ae1027910e331ba5c500eb9" - integrity sha512-UVEvX3tXie3Szm3emi1+G63jyw1w5IcMY0FSKM+CRnKRI5Mr1YbCNgsSTwoTwKphQEG9P+QqmuRFneJPZuHNhg== + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.21.0.tgz#656b42c2fdea0a6d8762075d58ef9d4e3c4ab8a2" + integrity sha512-6OAWljMvQrZjR2DaNhVfRz6dkCAVV+ymcLUmaf8bccGOHn2v5rHJK3tTpij0BuhdYWP4LLaqj5lwcdlpAAPuvg== dependencies: "@babel/helper-annotate-as-pure" "^7.18.6" "@babel/helper-module-imports" "^7.18.6" - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-syntax-jsx" "^7.18.6" - "@babel/types" "^7.19.0" + "@babel/types" "^7.21.0" "@babel/plugin-transform-react-pure-annotations@^7.16.7", "@babel/plugin-transform-react-pure-annotations@^7.18.6": version "7.18.6" @@ -1055,12 +1070,12 @@ regenerator-transform "^0.15.0" "@babel/plugin-transform-regenerator@^7.17.9", "@babel/plugin-transform-regenerator@^7.18.6": - version "7.18.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.18.6.tgz#585c66cb84d4b4bf72519a34cfce761b8676ca73" - integrity sha512-poqRI2+qiSdeldcz4wTSTXBRryoq3Gc70ye7m7UD5Ww0nE29IXqMl6r7Nd15WBgRd74vloEMlShtH6CKxVzfmQ== + version "7.20.5" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.20.5.tgz#57cda588c7ffb7f4f8483cc83bdcea02a907f04d" + integrity sha512-kW/oO7HPBtntbsahzQ0qSE3tFvkFwnbozz3NWFhLGqH75vLEg+sCGngLlhVkePlCs3Jv0dBBHDzCHxNiFAQKCQ== dependencies: - "@babel/helper-plugin-utils" "^7.18.6" - regenerator-transform "^0.15.0" + "@babel/helper-plugin-utils" "^7.20.2" + regenerator-transform "^0.15.1" "@babel/plugin-transform-reserved-words@^7.16.7", "@babel/plugin-transform-reserved-words@^7.18.6": version "7.18.6" @@ -1082,12 +1097,12 @@ semver "^6.3.0" "@babel/plugin-transform-runtime@^7.18.6": - version "7.19.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.19.6.tgz#9d2a9dbf4e12644d6f46e5e75bfbf02b5d6e9194" - integrity sha512-PRH37lz4JU156lYFW1p8OxE5i7d6Sl/zV58ooyr+q1J1lnQPyg5tIiXlIwNVhJaY4W3TmOtdc8jqdXQcB1v5Yw== + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.21.0.tgz#2a884f29556d0a68cd3d152dcc9e6c71dfb6eee8" + integrity sha512-ReY6pxwSzEU0b3r2/T/VhqMKg/AkceBT19X0UptA3/tYi5Pe2eXgEUH+NNMC5nok6c6XQz5tyVTUpuezRfSMSg== dependencies: "@babel/helper-module-imports" "^7.18.6" - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/helper-plugin-utils" "^7.20.2" babel-plugin-polyfill-corejs2 "^0.3.3" babel-plugin-polyfill-corejs3 "^0.6.0" babel-plugin-polyfill-regenerator "^0.4.1" @@ -1101,12 +1116,12 @@ "@babel/helper-plugin-utils" "^7.18.6" "@babel/plugin-transform-spread@^7.16.7", "@babel/plugin-transform-spread@^7.19.0": - version "7.19.0" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-spread/-/plugin-transform-spread-7.19.0.tgz#dd60b4620c2fec806d60cfaae364ec2188d593b6" - integrity sha512-RsuMk7j6n+r752EtzyScnWkQyuJdli6LdO5Klv8Yx0OfPVTcQkIUfS8clx5e9yHXzlnhOZF3CbQ8C2uP5j074w== + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-spread/-/plugin-transform-spread-7.20.7.tgz#c2d83e0b99d3bf83e07b11995ee24bf7ca09401e" + integrity sha512-ewBbHQ+1U/VnH1fxltbJqDeWBU1oNLG8Dj11uIv3xVf7nrQu0bPGe5Rf716r7K5Qz+SqtAOVswoVunoiBtGhxw== dependencies: - "@babel/helper-plugin-utils" "^7.19.0" - "@babel/helper-skip-transparent-expression-wrappers" "^7.18.9" + "@babel/helper-plugin-utils" "^7.20.2" + "@babel/helper-skip-transparent-expression-wrappers" "^7.20.0" "@babel/plugin-transform-sticky-regex@^7.16.7", "@babel/plugin-transform-sticky-regex@^7.18.6": version "7.18.6" @@ -1129,13 +1144,13 @@ dependencies: "@babel/helper-plugin-utils" "^7.18.9" -"@babel/plugin-transform-typescript@^7.16.7", "@babel/plugin-transform-typescript@^7.18.6": - version "7.20.0" - resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.20.0.tgz#2c7ec62b8bfc21482f3748789ba294a46a375169" - integrity sha512-xOAsAFaun3t9hCwZ13Qe7gq423UgMZ6zAgmLxeGGapFqlT/X3L5qT2btjiVLlFn7gWtMaVyceS5VxGAuKbgizw== +"@babel/plugin-transform-typescript@^7.16.7", "@babel/plugin-transform-typescript@^7.21.0": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.21.0.tgz#f0956a153679e3b377ae5b7f0143427151e4c848" + integrity sha512-xo///XTPp3mDzTtrqXoBlK9eiAYW3wv9JXglcn/u1bi60RW11dEUxIgA8cbnDhutS1zacjMRmAwxE0gMklLnZg== dependencies: - "@babel/helper-create-class-features-plugin" "^7.19.0" - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/helper-create-class-features-plugin" "^7.21.0" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/plugin-syntax-typescript" "^7.20.0" "@babel/plugin-transform-unicode-escapes@^7.16.7", "@babel/plugin-transform-unicode-escapes@^7.18.10": @@ -1234,17 +1249,17 @@ semver "^6.3.0" "@babel/preset-env@^7.18.6", "@babel/preset-env@^7.19.4": - version "7.19.4" - resolved "https://registry.yarnpkg.com/@babel/preset-env/-/preset-env-7.19.4.tgz#4c91ce2e1f994f717efb4237891c3ad2d808c94b" - integrity sha512-5QVOTXUdqTCjQuh2GGtdd7YEhoRXBMVGROAtsBeLGIbIz3obCBIfRMT1I3ZKkMgNzwkyCkftDXSSkHxnfVf4qg== + version "7.20.2" + resolved "https://registry.yarnpkg.com/@babel/preset-env/-/preset-env-7.20.2.tgz#9b1642aa47bb9f43a86f9630011780dab7f86506" + integrity sha512-1G0efQEWR1EHkKvKHqbG+IN/QdgwfByUpM5V5QroDzGV2t3S/WXNQd693cHiHTlCFMpr9B6FkPFXDA2lQcKoDg== dependencies: - "@babel/compat-data" "^7.19.4" - "@babel/helper-compilation-targets" "^7.19.3" - "@babel/helper-plugin-utils" "^7.19.0" + "@babel/compat-data" "^7.20.1" + "@babel/helper-compilation-targets" "^7.20.0" + "@babel/helper-plugin-utils" "^7.20.2" "@babel/helper-validator-option" "^7.18.6" "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression" "^7.18.6" "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining" "^7.18.9" - "@babel/plugin-proposal-async-generator-functions" "^7.19.1" + "@babel/plugin-proposal-async-generator-functions" "^7.20.1" "@babel/plugin-proposal-class-properties" "^7.18.6" "@babel/plugin-proposal-class-static-block" "^7.18.6" "@babel/plugin-proposal-dynamic-import" "^7.18.6" @@ -1253,7 +1268,7 @@ "@babel/plugin-proposal-logical-assignment-operators" "^7.18.9" "@babel/plugin-proposal-nullish-coalescing-operator" "^7.18.6" "@babel/plugin-proposal-numeric-separator" "^7.18.6" - "@babel/plugin-proposal-object-rest-spread" "^7.19.4" + "@babel/plugin-proposal-object-rest-spread" "^7.20.2" "@babel/plugin-proposal-optional-catch-binding" "^7.18.6" "@babel/plugin-proposal-optional-chaining" "^7.18.9" "@babel/plugin-proposal-private-methods" "^7.18.6" @@ -1264,7 +1279,7 @@ "@babel/plugin-syntax-class-static-block" "^7.14.5" "@babel/plugin-syntax-dynamic-import" "^7.8.3" "@babel/plugin-syntax-export-namespace-from" "^7.8.3" - "@babel/plugin-syntax-import-assertions" "^7.18.6" + "@babel/plugin-syntax-import-assertions" "^7.20.0" "@babel/plugin-syntax-json-strings" "^7.8.3" "@babel/plugin-syntax-logical-assignment-operators" "^7.10.4" "@babel/plugin-syntax-nullish-coalescing-operator" "^7.8.3" @@ -1277,10 +1292,10 @@ "@babel/plugin-transform-arrow-functions" "^7.18.6" "@babel/plugin-transform-async-to-generator" "^7.18.6" "@babel/plugin-transform-block-scoped-functions" "^7.18.6" - "@babel/plugin-transform-block-scoping" "^7.19.4" - "@babel/plugin-transform-classes" "^7.19.0" + "@babel/plugin-transform-block-scoping" "^7.20.2" + "@babel/plugin-transform-classes" "^7.20.2" "@babel/plugin-transform-computed-properties" "^7.18.9" - "@babel/plugin-transform-destructuring" "^7.19.4" + "@babel/plugin-transform-destructuring" "^7.20.2" "@babel/plugin-transform-dotall-regex" "^7.18.6" "@babel/plugin-transform-duplicate-keys" "^7.18.9" "@babel/plugin-transform-exponentiation-operator" "^7.18.6" @@ -1288,14 +1303,14 @@ "@babel/plugin-transform-function-name" "^7.18.9" "@babel/plugin-transform-literals" "^7.18.9" "@babel/plugin-transform-member-expression-literals" "^7.18.6" - "@babel/plugin-transform-modules-amd" "^7.18.6" - "@babel/plugin-transform-modules-commonjs" "^7.18.6" - "@babel/plugin-transform-modules-systemjs" "^7.19.0" + "@babel/plugin-transform-modules-amd" "^7.19.6" + "@babel/plugin-transform-modules-commonjs" "^7.19.6" + "@babel/plugin-transform-modules-systemjs" "^7.19.6" "@babel/plugin-transform-modules-umd" "^7.18.6" "@babel/plugin-transform-named-capturing-groups-regex" "^7.19.1" "@babel/plugin-transform-new-target" "^7.18.6" "@babel/plugin-transform-object-super" "^7.18.6" - "@babel/plugin-transform-parameters" "^7.18.8" + "@babel/plugin-transform-parameters" "^7.20.1" "@babel/plugin-transform-property-literals" "^7.18.6" "@babel/plugin-transform-regenerator" "^7.18.6" "@babel/plugin-transform-reserved-words" "^7.18.6" @@ -1307,7 +1322,7 @@ "@babel/plugin-transform-unicode-escapes" "^7.18.10" "@babel/plugin-transform-unicode-regex" "^7.18.6" "@babel/preset-modules" "^0.1.5" - "@babel/types" "^7.19.4" + "@babel/types" "^7.20.2" babel-plugin-polyfill-corejs2 "^0.3.3" babel-plugin-polyfill-corejs3 "^0.6.0" babel-plugin-polyfill-regenerator "^0.4.1" @@ -1359,13 +1374,18 @@ "@babel/plugin-transform-typescript" "^7.16.7" "@babel/preset-typescript@^7.18.6": - version "7.18.6" - resolved "https://registry.yarnpkg.com/@babel/preset-typescript/-/preset-typescript-7.18.6.tgz#ce64be3e63eddc44240c6358daefac17b3186399" - integrity sha512-s9ik86kXBAnD760aybBucdpnLsAt0jK1xqJn2juOn9lkOvSHV60os5hxoVJsPzMQxvnUJFAlkont2DvvaYEBtQ== + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/preset-typescript/-/preset-typescript-7.21.0.tgz#bcbbca513e8213691fe5d4b23d9251e01f00ebff" + integrity sha512-myc9mpoVA5m1rF8K8DgLEatOYFDpwC+RkMkjZ0Du6uI62YvDe8uxIEYVs/VCdSJ097nlALiU/yBC7//3nI+hNg== dependencies: - "@babel/helper-plugin-utils" "^7.18.6" - "@babel/helper-validator-option" "^7.18.6" - "@babel/plugin-transform-typescript" "^7.18.6" + "@babel/helper-plugin-utils" "^7.20.2" + "@babel/helper-validator-option" "^7.21.0" + "@babel/plugin-transform-typescript" "^7.21.0" + +"@babel/regjsgen@^0.8.0": + version "0.8.0" + resolved "https://registry.yarnpkg.com/@babel/regjsgen/-/regjsgen-0.8.0.tgz#f0ba69b075e1f05fb2825b7fad991e7adbb18310" + integrity sha512-x/rqGMdzj+fWZvCOYForTghzbtqPDZ5gPwaoNGHdgDfF2QA/XZbCBp4Moo5scrkAMPhB7z26XM/AaHuIJdgauA== "@babel/runtime-corejs3@7.17.9": version "7.17.9" @@ -1376,49 +1396,49 @@ regenerator-runtime "^0.13.4" "@babel/runtime-corejs3@^7.18.6": - version "7.20.1" - resolved "https://registry.yarnpkg.com/@babel/runtime-corejs3/-/runtime-corejs3-7.20.1.tgz#d0775a49bb5fba77e42cbb7276c9955c7b05af8d" - integrity sha512-CGulbEDcg/ND1Im7fUNRZdGXmX2MTWVVZacQi/6DiKE5HNwZ3aVTm5PV4lO8HHz0B2h8WQyvKKjbX5XgTtydsg== + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/runtime-corejs3/-/runtime-corejs3-7.21.0.tgz#6e4939d9d9789ff63e2dc58e88f13a3913a24eba" + integrity sha512-TDD4UJzos3JJtM+tHX+w2Uc+KWj7GV+VKKFdMVd2Rx8sdA19hcc3P3AHFYd5LVOw+pYuSd5lICC3gm52B6Rwxw== dependencies: core-js-pure "^3.25.1" - regenerator-runtime "^0.13.10" + regenerator-runtime "^0.13.11" -"@babel/runtime@^7.1.2", "@babel/runtime@^7.10.2", "@babel/runtime@^7.10.3", "@babel/runtime@^7.12.13", "@babel/runtime@^7.12.5", "@babel/runtime@^7.18.6", "@babel/runtime@^7.8.4": - version "7.20.1" - resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.20.1.tgz#1148bb33ab252b165a06698fde7576092a78b4a9" - integrity sha512-mrzLkl6U9YLF8qpqI7TB82PESyEGjm/0Ly91jG575eVxMMlb8fYfOXFZIJ8XfLrJZQbm7dlKry2bJmXBUEkdFg== +"@babel/runtime@^7.1.2", "@babel/runtime@^7.10.2", "@babel/runtime@^7.10.3", "@babel/runtime@^7.12.13", "@babel/runtime@^7.12.5", "@babel/runtime@^7.15.4", "@babel/runtime@^7.18.6", "@babel/runtime@^7.8.4", "@babel/runtime@^7.9.2": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.21.0.tgz#5b55c9d394e5fcf304909a8b00c07dc217b56673" + integrity sha512-xwII0//EObnq89Ji5AKYQaRYiW/nZ3llSv29d49IuxPhKbtJoLP+9QUUZ4nVragQVtaVGeZrpB+ZtG/Pdy/POw== dependencies: - regenerator-runtime "^0.13.10" + regenerator-runtime "^0.13.11" -"@babel/template@^7.12.7", "@babel/template@^7.16.7", "@babel/template@^7.18.10": - version "7.18.10" - resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.18.10.tgz#6f9134835970d1dbf0835c0d100c9f38de0c5e71" - integrity sha512-TI+rCtooWHr3QJ27kJxfjutghu44DLnasDMwpDqCXVTal9RLp3RSYNh4NdBrRP2cQAoG9A8juOQl6P6oZG4JxA== +"@babel/template@^7.12.7", "@babel/template@^7.16.7", "@babel/template@^7.18.10", "@babel/template@^7.20.7": + version "7.20.7" + resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.20.7.tgz#a15090c2839a83b02aa996c0b4994005841fd5a8" + integrity sha512-8SegXApWe6VoNw0r9JHpSteLKTpTiLZ4rMlGIm9JQ18KiCtyQiAMEazujAHrUS5flrcqYZa75ukev3P6QmUwUw== dependencies: "@babel/code-frame" "^7.18.6" - "@babel/parser" "^7.18.10" - "@babel/types" "^7.18.10" + "@babel/parser" "^7.20.7" + "@babel/types" "^7.20.7" -"@babel/traverse@^7.12.9", "@babel/traverse@^7.17.10", "@babel/traverse@^7.18.8", "@babel/traverse@^7.19.0", "@babel/traverse@^7.19.1", "@babel/traverse@^7.19.6", "@babel/traverse@^7.20.1": - version "7.20.1" - resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.20.1.tgz#9b15ccbf882f6d107eeeecf263fbcdd208777ec8" - integrity sha512-d3tN8fkVJwFLkHkBN479SOsw4DMZnz8cdbL/gvuDuzy3TS6Nfw80HuQqhw1pITbIruHyh7d1fMA47kWzmcUEGA== +"@babel/traverse@^7.12.9", "@babel/traverse@^7.17.10", "@babel/traverse@^7.18.8", "@babel/traverse@^7.20.5", "@babel/traverse@^7.20.7", "@babel/traverse@^7.21.0": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.21.0.tgz#0e1807abd5db98e6a19c204b80ed1e3f5bca0edc" + integrity sha512-Xdt2P1H4LKTO8ApPfnO1KmzYMFpp7D/EinoXzLYN/cHcBNrVCAkAtGUcXnHXrl/VGktureU6fkQrHSBE2URfoA== dependencies: "@babel/code-frame" "^7.18.6" - "@babel/generator" "^7.20.1" + "@babel/generator" "^7.21.0" "@babel/helper-environment-visitor" "^7.18.9" - "@babel/helper-function-name" "^7.19.0" + "@babel/helper-function-name" "^7.21.0" "@babel/helper-hoist-variables" "^7.18.6" "@babel/helper-split-export-declaration" "^7.18.6" - "@babel/parser" "^7.20.1" - "@babel/types" "^7.20.0" + "@babel/parser" "^7.21.0" + "@babel/types" "^7.21.0" debug "^4.1.0" globals "^11.1.0" -"@babel/types@^7.12.7", "@babel/types@^7.15.6", "@babel/types@^7.17.10", "@babel/types@^7.18.10", "@babel/types@^7.18.6", "@babel/types@^7.18.9", "@babel/types@^7.19.0", "@babel/types@^7.19.4", "@babel/types@^7.20.0", "@babel/types@^7.4.4": - version "7.20.0" - resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.20.0.tgz#52c94cf8a7e24e89d2a194c25c35b17a64871479" - integrity sha512-Jlgt3H0TajCW164wkTOTzHkZb075tMQMULzrLUoUeKmO7eFL96GgDxf7/Axhc5CAuKE3KFyVW1p6ysKsi2oXAg== +"@babel/types@^7.12.7", "@babel/types@^7.15.6", "@babel/types@^7.17.10", "@babel/types@^7.18.6", "@babel/types@^7.18.9", "@babel/types@^7.20.0", "@babel/types@^7.20.2", "@babel/types@^7.20.5", "@babel/types@^7.20.7", "@babel/types@^7.21.0", "@babel/types@^7.4.4": + version "7.21.0" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.21.0.tgz#1da00d89c2f18b226c9207d96edbeb79316a1819" + integrity sha512-uR7NWq2VNFnDi7EYqiRz2Jv/VQIu38tu64Zy8TX2nQFQ6etJ9V/Rr2msW8BS132mum2rL645qpDrLtAJtVpuow== dependencies: "@babel/helper-string-parser" "^7.19.4" "@babel/helper-validator-identifier" "^7.19.1" @@ -1429,20 +1449,67 @@ resolved "https://registry.yarnpkg.com/@braintree/sanitize-url/-/sanitize-url-6.0.2.tgz#6110f918d273fe2af8ea1c4398a88774bb9fc12f" integrity sha512-Tbsj02wXCbqGmzdnXNk0SOF19ChhRU70BsroIi4Pm6Ehp56in6vch94mfbdQ17DozxkL3BAVjbZ4Qc1a0HFRAg== +"@bufbuild/buf-darwin-arm64@1.14.0": + version "1.14.0" + resolved "https://registry.yarnpkg.com/@bufbuild/buf-darwin-arm64/-/buf-darwin-arm64-1.14.0.tgz#26d57c0ab5aeac66f64010f78f88021e46f4b834" + integrity sha512-V6WonyHSLtrCd+xl5XAqzpDXUMLhJF3seVD6ap4yJW6nigHw49+Oz38oE0DgwOlkIOoNgS8TWsRZFUyBXfV9vQ== + +"@bufbuild/buf-darwin-x64@1.14.0": + version "1.14.0" + resolved "https://registry.yarnpkg.com/@bufbuild/buf-darwin-x64/-/buf-darwin-x64-1.14.0.tgz#52c766e190cd6876629549b5bf8442fff8b18317" + integrity sha512-ZhPc0mN7K8E8IJGWzdCxb5CHqwmv3HSB25IgEjqTkwCDIUV7cPIUfb/56G6ir0shWCcVRoGPv2KbSG5rL0AYIw== + +"@bufbuild/buf-linux-aarch64@1.14.0": + version "1.14.0" + resolved "https://registry.yarnpkg.com/@bufbuild/buf-linux-aarch64/-/buf-linux-aarch64-1.14.0.tgz#1168346bd1739c4e98e122a3c545b578dfda8f03" + integrity sha512-M7La4zzSXGgIwhKclZFgh5OXvKkx5/1fsGKTJWfDL25xPMYrvZI7y1i44iOK5H8ciKe24fatITZHE0ZQVRohoQ== + +"@bufbuild/buf-linux-x64@1.14.0": + version "1.14.0" + resolved "https://registry.yarnpkg.com/@bufbuild/buf-linux-x64/-/buf-linux-x64-1.14.0.tgz#e1887e70657eaab3b764605825109755db02ecd1" + integrity sha512-/fqaKAUpFNbP6A2ROU/r35R2Fxig55MtseYtHNSLcQI6k9ubhdVsI3cM0MlOZ1VawclDYFiTpCd1urUL7spvsw== + +"@bufbuild/buf-win32-arm64@1.14.0": + version "1.14.0" + resolved "https://registry.yarnpkg.com/@bufbuild/buf-win32-arm64/-/buf-win32-arm64-1.14.0.tgz#496e60dab56a98c67fa191874a7aa118ba51f02b" + integrity sha512-t7cd8MfqJ2ew6uXUYVbgq97OzN/ybnJ5Q5yKbEGexkyOBHQZsEhv0FkJWkAn1DN93j5iqHO6xlDkHpGMjAW1sg== + +"@bufbuild/buf-win32-x64@1.14.0": + version "1.14.0" + resolved "https://registry.yarnpkg.com/@bufbuild/buf-win32-x64/-/buf-win32-x64-1.14.0.tgz#3c7a3b3893cd00deadffee4bdf85c5cedb65440a" + integrity sha512-KD0T1rkX7yfykKZodnAj2WxhIZfkA/sox6VAY20F6X6ckLP96/3TSVWvDPfDN2DNkTcmokygNtA2/ir0KejDfQ== + +"@bufbuild/buf@^1.14.0": + version "1.14.0" + resolved "https://registry.yarnpkg.com/@bufbuild/buf/-/buf-1.14.0.tgz#789f05b7909c45e702d78b035d52fcbf0ed90c78" + integrity sha512-hW6wua/V+goxF99TSoQ/ps/gLdLkyuMjUs6zm15rpNvYOqB5UNg3t4N29SOWqfGhwVU5eeAC2XubT24eVOCcRQ== + optionalDependencies: + "@bufbuild/buf-darwin-arm64" "1.14.0" + "@bufbuild/buf-darwin-x64" "1.14.0" + "@bufbuild/buf-linux-aarch64" "1.14.0" + "@bufbuild/buf-linux-x64" "1.14.0" + "@bufbuild/buf-win32-arm64" "1.14.0" + "@bufbuild/buf-win32-x64" "1.14.0" + "@colors/colors@1.5.0": version "1.5.0" resolved "https://registry.yarnpkg.com/@colors/colors/-/colors-1.5.0.tgz#bb504579c1cae923e6576a4f5da43d25f97bdbd9" integrity sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ== +"@discoveryjs/json-ext@0.5.7": + version "0.5.7" + resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz#1d572bfbbe14b7704e0ba0f39b74815b84870d70" + integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw== + "@docsearch/css@3.0.0": version "3.0.0" resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.0.0.tgz#fe57b474802ffd706d3246eab25d52fac8aa3698" integrity sha512-1kkV7tkAsiuEd0shunYRByKJe3xQDG2q7wYg24SOw1nV9/2lwEd4WrUYRJC/ukGTl2/kHeFxsaUvtiOy0y6fFA== -"@docsearch/css@3.3.0": - version "3.3.0" - resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.3.0.tgz#d698e48302d12240d7c2f7452ccb2d2239a8cd80" - integrity sha512-rODCdDtGyudLj+Va8b6w6Y85KE85bXRsps/R4Yjwt5vueXKXZQKYw0aA9knxLBT6a/bI/GMrAcmCR75KYOM6hg== +"@docsearch/css@3.3.3": + version "3.3.3" + resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.3.3.tgz#f9346c9e24602218341f51b8ba91eb9109add434" + integrity sha512-6SCwI7P8ao+se1TUsdZ7B4XzL+gqeQZnBc+2EONZlcVa0dVrk0NjETxozFKgMv0eEGH8QzP1fkN+A1rH61l4eg== "@docsearch/react@3.0.0": version "3.0.0" @@ -1455,16 +1522,16 @@ algoliasearch "^4.0.0" "@docsearch/react@^3.1.1": - version "3.3.0" - resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-3.3.0.tgz#b8ac8e7f49b9bf2f96d34c24bc1cfd097ec0eead" - integrity sha512-fhS5adZkae2SSdMYEMVg6pxI5a/cE+tW16ki1V0/ur4Fdok3hBRkmN/H8VvlXnxzggkQIIRIVvYPn00JPjen3A== + version "3.3.3" + resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-3.3.3.tgz#907b6936a565f880b4c0892624b4f7a9f132d298" + integrity sha512-pLa0cxnl+G0FuIDuYlW+EBK6Rw2jwLw9B1RHIeS4N4s2VhsfJ/wzeCi3CWcs5yVfxLd5ZK50t//TMA5e79YT7Q== dependencies: - "@algolia/autocomplete-core" "1.7.2" - "@algolia/autocomplete-preset-algolia" "1.7.2" - "@docsearch/css" "3.3.0" + "@algolia/autocomplete-core" "1.7.4" + "@algolia/autocomplete-preset-algolia" "1.7.4" + "@docsearch/css" "3.3.3" algoliasearch "^4.0.0" -"@docusaurus/core@2.2.0", "@docusaurus/core@^2.1.0": +"@docusaurus/core@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-2.2.0.tgz#64c9ee31502c23b93c869f8188f73afaf5fd4867" integrity sha512-Vd6XOluKQqzG12fEs9prJgDtyn6DPok9vmUWDR2E6/nV5Fl9SVkhEQOBxwObjk3kQh7OY7vguFaLh0jqdApWsA== @@ -1541,7 +1608,84 @@ webpack-merge "^5.8.0" webpackbar "^5.0.2" -"@docusaurus/cssnano-preset@2.2.0", "@docusaurus/cssnano-preset@^2.1.0": +"@docusaurus/core@2.3.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-2.3.1.tgz#32849f2ffd2f086a4e55739af8c4195c5eb386f2" + integrity sha512-0Jd4jtizqnRAr7svWaBbbrCCN8mzBNd2xFLoT/IM7bGfFie5y58oz97KzXliwiLY3zWjqMXjQcuP1a5VgCv2JA== + dependencies: + "@babel/core" "^7.18.6" + "@babel/generator" "^7.18.7" + "@babel/plugin-syntax-dynamic-import" "^7.8.3" + "@babel/plugin-transform-runtime" "^7.18.6" + "@babel/preset-env" "^7.18.6" + "@babel/preset-react" "^7.18.6" + "@babel/preset-typescript" "^7.18.6" + "@babel/runtime" "^7.18.6" + "@babel/runtime-corejs3" "^7.18.6" + "@babel/traverse" "^7.18.8" + "@docusaurus/cssnano-preset" "2.3.1" + "@docusaurus/logger" "2.3.1" + "@docusaurus/mdx-loader" "2.3.1" + "@docusaurus/react-loadable" "5.5.2" + "@docusaurus/utils" "2.3.1" + "@docusaurus/utils-common" "2.3.1" + "@docusaurus/utils-validation" "2.3.1" + "@slorber/static-site-generator-webpack-plugin" "^4.0.7" + "@svgr/webpack" "^6.2.1" + autoprefixer "^10.4.7" + babel-loader "^8.2.5" + babel-plugin-dynamic-import-node "^2.3.3" + boxen "^6.2.1" + chalk "^4.1.2" + chokidar "^3.5.3" + clean-css "^5.3.0" + cli-table3 "^0.6.2" + combine-promises "^1.1.0" + commander "^5.1.0" + copy-webpack-plugin "^11.0.0" + core-js "^3.23.3" + css-loader "^6.7.1" + css-minimizer-webpack-plugin "^4.0.0" + cssnano "^5.1.12" + del "^6.1.1" + detect-port "^1.3.0" + escape-html "^1.0.3" + eta "^2.0.0" + file-loader "^6.2.0" + fs-extra "^10.1.0" + html-minifier-terser "^6.1.0" + html-tags "^3.2.0" + html-webpack-plugin "^5.5.0" + import-fresh "^3.3.0" + leven "^3.1.0" + lodash "^4.17.21" + mini-css-extract-plugin "^2.6.1" + postcss "^8.4.14" + postcss-loader "^7.0.0" + prompts "^2.4.2" + react-dev-utils "^12.0.1" + react-helmet-async "^1.3.0" + react-loadable "npm:@docusaurus/react-loadable@5.5.2" + react-loadable-ssr-addon-v5-slorber "^1.0.1" + react-router "^5.3.3" + react-router-config "^5.1.1" + react-router-dom "^5.3.3" + rtl-detect "^1.0.4" + semver "^7.3.7" + serve-handler "^6.1.3" + shelljs "^0.8.5" + terser-webpack-plugin "^5.3.3" + tslib "^2.4.0" + update-notifier "^5.1.0" + url-loader "^4.1.1" + wait-on "^6.0.1" + webpack "^5.73.0" + webpack-bundle-analyzer "^4.5.0" + webpack-dev-server "^4.9.3" + webpack-merge "^5.8.0" + webpackbar "^5.0.2" + +"@docusaurus/cssnano-preset@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-2.2.0.tgz#fc05044659051ae74ab4482afcf4a9936e81d523" integrity sha512-mAAwCo4n66TMWBH1kXnHVZsakW9VAXJzTO4yZukuL3ro4F+JtkMwKfh42EG75K/J/YIFQG5I/Bzy0UH/hFxaTg== @@ -1551,6 +1695,16 @@ postcss-sort-media-queries "^4.2.1" tslib "^2.4.0" +"@docusaurus/cssnano-preset@2.3.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-2.3.1.tgz#e042487655e3e062417855e12edb3f6eee8f5ecb" + integrity sha512-7mIhAROES6CY1GmCjR4CZkUfjTL6B3u6rKHK0ChQl2d1IevYXq/k/vFgvOrJfcKxiObpMnE9+X6R2Wt1KqxC6w== + dependencies: + cssnano-preset-advanced "^5.3.8" + postcss "^8.4.14" + postcss-sort-media-queries "^4.2.1" + tslib "^2.4.0" + "@docusaurus/logger@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-2.2.0.tgz#ea2f7feda7b8675485933b87f06d9c976d17423f" @@ -1559,6 +1713,14 @@ chalk "^4.1.2" tslib "^2.4.0" +"@docusaurus/logger@2.3.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-2.3.1.tgz#d76aefb452e3734b4e0e645efc6cbfc0aae52869" + integrity sha512-2lAV/olKKVr9qJhfHFCaqBIl8FgYjbUFwgUnX76+cULwQYss+42ZQ3grHGFvI0ocN2X55WcYe64ellQXz7suqg== + dependencies: + chalk "^4.1.2" + tslib "^2.4.0" + "@docusaurus/mdx-loader@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-2.2.0.tgz#fd558f429e5d9403d284bd4214e54d9768b041a0" @@ -1582,7 +1744,30 @@ url-loader "^4.1.1" webpack "^5.73.0" -"@docusaurus/module-type-aliases@2.2.0", "@docusaurus/module-type-aliases@^2.1.0": +"@docusaurus/mdx-loader@2.3.1", "@docusaurus/mdx-loader@^2.0.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-2.3.1.tgz#7ec6acee5eff0a280e1b399ea4dd690b15a793f7" + integrity sha512-Gzga7OsxQRpt3392K9lv/bW4jGppdLFJh3luKRknCKSAaZrmVkOQv2gvCn8LAOSZ3uRg5No7AgYs/vpL8K94lA== + dependencies: + "@babel/parser" "^7.18.8" + "@babel/traverse" "^7.18.8" + "@docusaurus/logger" "2.3.1" + "@docusaurus/utils" "2.3.1" + "@mdx-js/mdx" "^1.6.22" + escape-html "^1.0.3" + file-loader "^6.2.0" + fs-extra "^10.1.0" + image-size "^1.0.1" + mdast-util-to-string "^2.0.0" + remark-emoji "^2.2.0" + stringify-object "^3.3.0" + tslib "^2.4.0" + unified "^9.2.2" + unist-util-visit "^2.0.3" + url-loader "^4.1.1" + webpack "^5.73.0" + +"@docusaurus/module-type-aliases@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-2.2.0.tgz#1e23e54a1bbb6fde1961e4fa395b1b69f4803ba5" integrity sha512-wDGW4IHKoOr9YuJgy7uYuKWrDrSpsUSDHLZnWQYM9fN7D5EpSmYHjFruUpKWVyxLpD/Wh0rW8hYZwdjJIQUQCQ== @@ -1596,6 +1781,20 @@ react-helmet-async "*" react-loadable "npm:@docusaurus/react-loadable@5.5.2" +"@docusaurus/module-type-aliases@2.3.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-2.3.1.tgz#986186200818fed999be2e18d6c698eaf4683a33" + integrity sha512-6KkxfAVOJqIUynTRb/tphYCl+co3cP0PlHiMDbi+SzmYxMdgIrwYqH9yAnGSDoN6Jk2ZE/JY/Azs/8LPgKP48A== + dependencies: + "@docusaurus/react-loadable" "5.5.2" + "@docusaurus/types" "2.3.1" + "@types/history" "^4.7.11" + "@types/react" "*" + "@types/react-router-config" "*" + "@types/react-router-dom" "*" + react-helmet-async "*" + react-loadable "npm:@docusaurus/react-loadable@5.5.2" + "@docusaurus/plugin-content-blog@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-2.2.0.tgz#dc55982e76771f4e678ac10e26d10e1da2011dc1" @@ -1640,6 +1839,28 @@ utility-types "^3.10.0" webpack "^5.73.0" +"@docusaurus/plugin-content-docs@^2.0.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-2.3.1.tgz#feae1555479558a55182f22f8a07acc5e0d7444d" + integrity sha512-DxztTOBEruv7qFxqUtbsqXeNcHqcVEIEe+NQoI1oi2DBmKBhW/o0MIal8lt+9gvmpx3oYtlwmLOOGepxZgJGkw== + dependencies: + "@docusaurus/core" "2.3.1" + "@docusaurus/logger" "2.3.1" + "@docusaurus/mdx-loader" "2.3.1" + "@docusaurus/module-type-aliases" "2.3.1" + "@docusaurus/types" "2.3.1" + "@docusaurus/utils" "2.3.1" + "@docusaurus/utils-validation" "2.3.1" + "@types/react-router-config" "^5.0.6" + combine-promises "^1.1.0" + fs-extra "^10.1.0" + import-fresh "^3.3.0" + js-yaml "^4.1.0" + lodash "^4.17.21" + tslib "^2.4.0" + utility-types "^3.10.0" + webpack "^5.73.0" + "@docusaurus/plugin-content-pages@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-pages/-/plugin-content-pages-2.2.0.tgz#e3f40408787bbe229545dd50595f87e1393bc3ae" @@ -1654,7 +1875,7 @@ tslib "^2.4.0" webpack "^5.73.0" -"@docusaurus/plugin-debug@2.2.0", "@docusaurus/plugin-debug@^2.1.0": +"@docusaurus/plugin-debug@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/plugin-debug/-/plugin-debug-2.2.0.tgz#b38741d2c492f405fee01ee0ef2e0029cedb689a" integrity sha512-p9vOep8+7OVl6r/NREEYxf4HMAjV8JMYJ7Bos5fCFO0Wyi9AZEo0sCTliRd7R8+dlJXZEgcngSdxAUo/Q+CJow== @@ -1666,7 +1887,7 @@ react-json-view "^1.21.3" tslib "^2.4.0" -"@docusaurus/plugin-google-analytics@2.2.0", "@docusaurus/plugin-google-analytics@^2.1.0": +"@docusaurus/plugin-google-analytics@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-2.2.0.tgz#63c7137eff5a1208d2059fea04b5207c037d7954" integrity sha512-+eZVVxVeEnV5nVQJdey9ZsfyEVMls6VyWTIj8SmX0k5EbqGvnIfET+J2pYEuKQnDIHxy+syRMoRM6AHXdHYGIg== @@ -1676,7 +1897,7 @@ "@docusaurus/utils-validation" "2.2.0" tslib "^2.4.0" -"@docusaurus/plugin-google-gtag@2.2.0", "@docusaurus/plugin-google-gtag@^2.1.0": +"@docusaurus/plugin-google-gtag@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-2.2.0.tgz#7b086d169ac5fe9a88aca10ab0fd2bf00c6c6b12" integrity sha512-6SOgczP/dYdkqUMGTRqgxAS1eTp6MnJDAQMy8VCF1QKbWZmlkx4agHDexihqmYyCujTYHqDAhm1hV26EET54NQ== @@ -1686,7 +1907,7 @@ "@docusaurus/utils-validation" "2.2.0" tslib "^2.4.0" -"@docusaurus/plugin-sitemap@2.2.0", "@docusaurus/plugin-sitemap@^2.1.0": +"@docusaurus/plugin-sitemap@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/plugin-sitemap/-/plugin-sitemap-2.2.0.tgz#876da60937886032d63143253d420db6a4b34773" integrity sha512-0jAmyRDN/aI265CbWZNZuQpFqiZuo+5otk2MylU9iVrz/4J7gSc+ZJ9cy4EHrEsW7PV8s1w18hIEsmcA1YgkKg== @@ -1701,7 +1922,7 @@ sitemap "^7.1.1" tslib "^2.4.0" -"@docusaurus/preset-classic@^2.1.0": +"@docusaurus/preset-classic@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/preset-classic/-/preset-classic-2.2.0.tgz#bece5a043eeb74430f7c6c7510000b9c43669eb7" integrity sha512-yKIWPGNx7BT8v2wjFIWvYrS+nvN04W+UameSFf8lEiJk6pss0kL6SG2MRvyULiI3BDxH+tj6qe02ncpSPGwumg== @@ -1727,7 +1948,7 @@ "@types/react" "*" prop-types "^15.6.2" -"@docusaurus/theme-classic@2.2.0", "@docusaurus/theme-classic@^2.1.0": +"@docusaurus/theme-classic@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-2.2.0.tgz#a048bb1bc077dee74b28bec25f4b84b481863742" integrity sha512-kjbg/qJPwZ6H1CU/i9d4l/LcFgnuzeiGgMQlt6yPqKo0SOJIBMPuz7Rnu3r/WWbZFPi//o8acclacOzmXdUUEg== @@ -1758,7 +1979,7 @@ tslib "^2.4.0" utility-types "^3.10.0" -"@docusaurus/theme-common@2.2.0": +"@docusaurus/theme-common@2.2.0", "@docusaurus/theme-common@^2.0.1": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/theme-common/-/theme-common-2.2.0.tgz#2303498d80448aafdd588b597ce9d6f4cfa930e4" integrity sha512-R8BnDjYoN90DCL75gP7qYQfSjyitXuP9TdzgsKDmSFPNyrdE3twtPNa2dIN+h+p/pr+PagfxwWbd6dn722A1Dw== @@ -1778,7 +1999,7 @@ tslib "^2.4.0" utility-types "^3.10.0" -"@docusaurus/theme-search-algolia@2.2.0", "@docusaurus/theme-search-algolia@^2.1.0": +"@docusaurus/theme-search-algolia@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-2.2.0.tgz#77fd9f7a600917e6024fe3ac7fb6cfdf2ce84737" integrity sha512-2h38B0tqlxgR2FZ9LpAkGrpDWVdXZ7vltfmTdX+4RsDs3A7khiNsmZB+x/x6sA4+G2V2CvrsPMlsYBy5X+cY1w== @@ -1808,7 +2029,7 @@ fs-extra "^10.1.0" tslib "^2.4.0" -"@docusaurus/types@2.2.0", "@docusaurus/types@^2.1.0": +"@docusaurus/types@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-2.2.0.tgz#02c577a4041ab7d058a3c214ccb13647e21a9857" integrity sha512-b6xxyoexfbRNRI8gjblzVOnLr4peCJhGbYGPpJ3LFqpi5nsFfoK4mmDLvWdeah0B7gmJeXabN7nQkFoqeSdmOw== @@ -1822,6 +2043,20 @@ webpack "^5.73.0" webpack-merge "^5.8.0" +"@docusaurus/types@2.3.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-2.3.1.tgz#785ade2e0f4e35e1eb7fb0d04c27d11c3991a2e8" + integrity sha512-PREbIRhTaNNY042qmfSE372Jb7djZt+oVTZkoqHJ8eff8vOIc2zqqDqBVc5BhOfpZGPTrE078yy/torUEZy08A== + dependencies: + "@types/history" "^4.7.11" + "@types/react" "*" + commander "^5.1.0" + joi "^17.6.0" + react-helmet-async "^1.3.0" + utility-types "^3.10.0" + webpack "^5.73.0" + webpack-merge "^5.8.0" + "@docusaurus/utils-common@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-2.2.0.tgz#a401c1b93a8697dd566baf6ac64f0fdff1641a78" @@ -1829,6 +2064,13 @@ dependencies: tslib "^2.4.0" +"@docusaurus/utils-common@2.3.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-2.3.1.tgz#1abe66846eb641547e4964d44f3011938e58e50b" + integrity sha512-pVlRpXkdNcxmKNxAaB1ya2hfCEvVsLDp2joeM6K6uv55Oc5nVIqgyYSgSNKZyMdw66NnvMfsu0RBylcwZQKo9A== + dependencies: + tslib "^2.4.0" + "@docusaurus/utils-validation@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-2.2.0.tgz#04d4d103137ad0145883971d3aa497f4a1315f25" @@ -1840,6 +2082,17 @@ js-yaml "^4.1.0" tslib "^2.4.0" +"@docusaurus/utils-validation@2.3.1", "@docusaurus/utils-validation@^2.0.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-2.3.1.tgz#b65c718ba9b84b7a891bccf5ac6d19b57ee7d887" + integrity sha512-7n0208IG3k1HVTByMHlZoIDjjOFC8sbViHVXJx0r3Q+3Ezrx+VQ1RZ/zjNn6lT+QBCRCXlnlaoJ8ug4HIVgQ3w== + dependencies: + "@docusaurus/logger" "2.3.1" + "@docusaurus/utils" "2.3.1" + joi "^17.6.0" + js-yaml "^4.1.0" + tslib "^2.4.0" + "@docusaurus/utils@2.2.0": version "2.2.0" resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-2.2.0.tgz#3d6f9b7a69168d5c92d371bf21c556a4f50d1da6" @@ -1861,6 +2114,33 @@ url-loader "^4.1.1" webpack "^5.73.0" +"@docusaurus/utils@2.3.1", "@docusaurus/utils@^2.0.1": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-2.3.1.tgz#24b9cae3a23b1e6dc88f95c45722c7e82727b032" + integrity sha512-9WcQROCV0MmrpOQDXDGhtGMd52DHpSFbKLfkyaYumzbTstrbA5pPOtiGtxK1nqUHkiIv8UwexS54p0Vod2I1lg== + dependencies: + "@docusaurus/logger" "2.3.1" + "@svgr/webpack" "^6.2.1" + escape-string-regexp "^4.0.0" + file-loader "^6.2.0" + fs-extra "^10.1.0" + github-slugger "^1.4.0" + globby "^11.1.0" + gray-matter "^4.0.3" + js-yaml "^4.1.0" + lodash "^4.17.21" + micromatch "^4.0.5" + resolve-pathname "^3.0.0" + shelljs "^0.8.5" + tslib "^2.4.0" + url-loader "^4.1.1" + webpack "^5.73.0" + +"@exodus/schemasafe@^1.0.0-rc.2": + version "1.0.0-rc.9" + resolved "https://registry.yarnpkg.com/@exodus/schemasafe/-/schemasafe-1.0.0-rc.9.tgz#56b9c6df627190f2dcda15f81f25d68826d9be4d" + integrity sha512-dGGHpb61hLwifAu7sotuHFDBw6GTdpG8aKC0fsK17EuTzMRvUrH7lEAr6LTJ+sx3AZYed9yZ77rltVDHyg2hRg== + "@hapi/hoek@^9.0.0": version "9.3.0" resolved "https://registry.yarnpkg.com/@hapi/hoek/-/hoek-9.3.0.tgz#8368869dcb735be2e7f5cb7647de78e167a251fb" @@ -1874,30 +2154,30 @@ "@hapi/hoek" "^9.0.0" "@headlessui/react@^1.7.4": - version "1.7.4" - resolved "https://registry.yarnpkg.com/@headlessui/react/-/react-1.7.4.tgz#ba7f50fda20667276ee84fcd4c2a459aa26187e3" - integrity sha512-D8n5yGCF3WIkPsjEYeM8knn9jQ70bigGGb5aUvN6y4BGxcT3OcOQOKcM3zRGllRCZCFxCZyQvYJF6ZE7bQUOyQ== + version "1.7.11" + resolved "https://registry.yarnpkg.com/@headlessui/react/-/react-1.7.11.tgz#1cc5750226abe5af2c94f72e975c0c8d2f5cc5a6" + integrity sha512-EaDbVgcyiylhtskZZf4Qb/JiiByY7cYbd0qgZ9xm2pm2X7hKojG0P4TaQYKgPOV3vojPhd/pZyQh3nmRkkcSyw== dependencies: client-only "^0.0.1" "@heroicons/react@^2.0.13": - version "2.0.13" - resolved "https://registry.yarnpkg.com/@heroicons/react/-/react-2.0.13.tgz#9b1cc54ff77d6625c9565efdce0054a4bcd9074c" - integrity sha512-iSN5XwmagrnirWlYEWNPdCDj9aRYVD/lnK3JlsC9/+fqGF80k8C7rl+1HCvBX0dBoagKqOFBs6fMhJJ1hOg1EQ== + version "2.0.16" + resolved "https://registry.yarnpkg.com/@heroicons/react/-/react-2.0.16.tgz#562883c19ba2690c83380b42a9a5cce39dcbdb4a" + integrity sha512-x89rFxH3SRdYaA+JCXwfe+RkE1SFTo9GcOkZettHer71Y3T7V+ogKmfw5CjTazgS3d0ClJ7p1NA+SP7VQLQcLw== -"@jest/schemas@^29.0.0": - version "29.0.0" - resolved "https://registry.yarnpkg.com/@jest/schemas/-/schemas-29.0.0.tgz#5f47f5994dd4ef067fb7b4188ceac45f77fe952a" - integrity sha512-3Ab5HgYIIAnS0HjqJHQYZS+zXc4tUmTmBH3z83ajI6afXp8X3ZtdLX+nXx+I7LNkJD7uN9LAVhgnjDgZa2z0kA== +"@jest/schemas@^29.4.3": + version "29.4.3" + resolved "https://registry.yarnpkg.com/@jest/schemas/-/schemas-29.4.3.tgz#39cf1b8469afc40b6f5a2baaa146e332c4151788" + integrity sha512-VLYKXQmtmuEz6IxJsrZwzG9NvtkQsWNnWMsKxqWNu3+CnfzJQhp0WDDKWLVV9hLKr0l3SLLFRqcYHjhtyuDVxg== dependencies: - "@sinclair/typebox" "^0.24.1" + "@sinclair/typebox" "^0.25.16" -"@jest/types@^29.2.1": - version "29.2.1" - resolved "https://registry.yarnpkg.com/@jest/types/-/types-29.2.1.tgz#ec9c683094d4eb754e41e2119d8bdaef01cf6da0" - integrity sha512-O/QNDQODLnINEPAI0cl9U6zUIDXEWXt6IC1o2N2QENuos7hlGUIthlKyV4p6ki3TvXFX071blj8HUhgLGquPjw== +"@jest/types@^29.4.3": + version "29.4.3" + resolved "https://registry.yarnpkg.com/@jest/types/-/types-29.4.3.tgz#9069145f4ef09adf10cec1b2901b2d390031431f" + integrity sha512-bPYfw8V65v17m2Od1cv44FH+SiKW7w2Xu7trhcdTLUmSv85rfKsP+qXSjO4KGJr4dtPSzl/gvslZBXctf1qGEA== dependencies: - "@jest/schemas" "^29.0.0" + "@jest/schemas" "^29.4.3" "@types/istanbul-lib-coverage" "^2.0.0" "@types/istanbul-reports" "^3.0.0" "@types/node" "*" @@ -1962,7 +2242,7 @@ "@jridgewell/resolve-uri" "^3.0.3" "@jridgewell/sourcemap-codec" "^1.4.10" -"@jridgewell/trace-mapping@^0.3.14", "@jridgewell/trace-mapping@^0.3.9": +"@jridgewell/trace-mapping@^0.3.14", "@jridgewell/trace-mapping@^0.3.17", "@jridgewell/trace-mapping@^0.3.9": version "0.3.17" resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.17.tgz#793041277af9073b0951a7fe0f0d8c4c98c36985" integrity sha512-MCNzAp77qzKca9+W/+I0+sEpaUnZoeasnghNeVc41VZCEKaCH73Vq3BZZ/SzWIgrqE4H4ceI+p+b6C0mHf9T4g== @@ -1970,6 +2250,11 @@ "@jridgewell/resolve-uri" "3.1.0" "@jridgewell/sourcemap-codec" "1.4.14" +"@jsdevtools/ono@^7.1.3": + version "7.1.3" + resolved "https://registry.yarnpkg.com/@jsdevtools/ono/-/ono-7.1.3.tgz#9df03bbd7c696a5c58885c34aa06da41c8543796" + integrity sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg== + "@leichtgewicht/ip-codec@2.0.4", "@leichtgewicht/ip-codec@^2.0.1": version "2.0.4" resolved "https://registry.yarnpkg.com/@leichtgewicht/ip-codec/-/ip-codec-2.0.4.tgz#b2ac626d6cb9c8718ab459166d4bb405b8ffa78b" @@ -2000,7 +2285,7 @@ unist-builder "2.0.3" unist-util-visit "2.0.3" -"@mdx-js/react@^1.6.22": +"@mdx-js/react@^1.6.21", "@mdx-js/react@^1.6.22": version "1.6.22" resolved "https://registry.yarnpkg.com/@mdx-js/react/-/react-1.6.22.tgz#ae09b4744fddc74714ee9f9d6f17a66e77c43573" integrity sha512-TDoPum4SHdfPiGSAaRBw7ECyI8VaHpK8GJugbJIJuqyh6kzw9ZLJZW3HGL3NNrJGxcAixUvqROm+YuQOo5eXtg== @@ -2031,11 +2316,90 @@ "@nodelib/fs.scandir" "2.1.5" fastq "^1.6.0" +"@paloaltonetworks/openapi-to-postmanv2@3.1.0-hotfix.1": + version "3.1.0-hotfix.1" + resolved "https://registry.yarnpkg.com/@paloaltonetworks/openapi-to-postmanv2/-/openapi-to-postmanv2-3.1.0-hotfix.1.tgz#4baf401d2e94ba86d888e6011a4c45d824e88114" + integrity sha512-0bdaPCEyQbnUo4xpOu7EzxXXkDx4BAXqc8QSbVBlzlVB5KoTLJiKKB4c3fa4BXbK+3u/OqfLbeNCebc2EC8ngA== + dependencies: + "@paloaltonetworks/postman-collection" "^4.1.0" + ajv "8.1.0" + ajv-formats "2.1.1" + async "3.2.1" + commander "2.20.3" + js-yaml "3.14.1" + json-schema-merge-allof "0.8.1" + lodash "4.17.21" + oas-resolver-browser "2.5.2" + path-browserify "1.0.1" + yaml "1.10.2" + +"@paloaltonetworks/postman-code-generators@1.1.13", "@paloaltonetworks/postman-code-generators@^1.1.12": + version "1.1.13" + resolved "https://registry.yarnpkg.com/@paloaltonetworks/postman-code-generators/-/postman-code-generators-1.1.13.tgz#49dc9baf4d98415fb5395c1aad0bd5362a43c845" + integrity sha512-7OA5k0ngMg/2ODqA6QjqUsauScnCKVvQuTdJbN02fqK/8jDEirEIWstPet5gF663WinuGvIr6sLIveR55w91LQ== + dependencies: + "@paloaltonetworks/postman-collection" "^4.1.0" + async "^3.2.4" + path "^0.12.7" + shelljs "^0.8.5" + +"@paloaltonetworks/postman-collection@^4.1.0": + version "4.1.1" + resolved "https://registry.yarnpkg.com/@paloaltonetworks/postman-collection/-/postman-collection-4.1.1.tgz#b2130bc8d7396ea8e6a6b2e4642a6b224b41e1e1" + integrity sha512-9JHHkkD8Xb4rvdKob7TDPRfqfmdG3KU0aO5gJyyjvMFbOVysam5I0d8/9HPOuJXWkUHGo3Sn+ov2Fcm2bnJ52Q== + dependencies: + file-type "3.9.0" + http-reasons "0.1.0" + iconv-lite "0.6.3" + liquid-json "0.3.1" + lodash "4.17.21" + mime-format "2.0.1" + mime-types "2.1.34" + postman-url-encoder "3.0.5" + semver "7.3.5" + uuid "8.3.2" + "@polka/url@^1.0.0-next.20": version "1.0.0-next.21" resolved "https://registry.yarnpkg.com/@polka/url/-/url-1.0.0-next.21.tgz#5de5a2385a35309427f6011992b544514d559aa1" integrity sha512-a5Sab1C4/icpTZVzZc5Ghpz88yQtGOyNqYXcZgOssB2uuAr+wF/MvN6bgtW32q7HHrvBki+BsZ0OuNv6EV3K9g== +"@redocly/ajv@^8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@redocly/ajv/-/ajv-8.11.0.tgz#2fad322888dc0113af026e08fceb3e71aae495ae" + integrity sha512-9GWx27t7xWhDIR02PA18nzBdLcKQRgc46xNQvjFkrYk4UOmvKhJ/dawwiX0cCOeetN5LcaaiqQbVOWYK62SGHw== + dependencies: + fast-deep-equal "^3.1.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + uri-js "^4.2.2" + +"@redocly/openapi-core@^1.0.0-beta.103": + version "1.0.0-beta.123" + resolved "https://registry.yarnpkg.com/@redocly/openapi-core/-/openapi-core-1.0.0-beta.123.tgz#0c29ae9fabe5f143f571caf608a7d025f41125db" + integrity sha512-W6MbUWpb/VaV+Kf0c3jmMIJw3WwwF7iK5nAfcOS+ZwrlbxtIl37+1hEydFlJ209vCR9HL12PaMwdh2Vpihj6Jw== + dependencies: + "@redocly/ajv" "^8.11.0" + "@types/node" "^14.11.8" + colorette "^1.2.0" + js-levenshtein "^1.1.6" + js-yaml "^4.1.0" + lodash.isequal "^4.5.0" + minimatch "^5.0.1" + node-fetch "^2.6.1" + pluralize "^8.0.0" + yaml-ast-parser "0.0.43" + +"@reduxjs/toolkit@^1.7.1": + version "1.9.3" + resolved "https://registry.yarnpkg.com/@reduxjs/toolkit/-/toolkit-1.9.3.tgz#27e1a33072b5a312e4f7fa19247fec160bbb2df9" + integrity sha512-GU2TNBQVofL09VGmuSioNPQIu6Ml0YLf4EJhgj0AvBadRlCGzUWet8372LjvO4fqKZF2vH1xU0htAa7BrK9pZg== + dependencies: + immer "^9.0.16" + redux "^4.2.0" + redux-thunk "^2.4.2" + reselect "^4.1.7" + "@saucelabs/theme-github-codeblock@^0.1.1": version "0.1.1" resolved "https://registry.yarnpkg.com/@saucelabs/theme-github-codeblock/-/theme-github-codeblock-0.1.1.tgz#d2caa3fbf56c38ae2fe974871f1188226bb57d92" @@ -2048,20 +2412,20 @@ dependencies: "@hapi/hoek" "^9.0.0" -"@sideway/formula@^3.0.0": - version "3.0.0" - resolved "https://registry.yarnpkg.com/@sideway/formula/-/formula-3.0.0.tgz#fe158aee32e6bd5de85044be615bc08478a0a13c" - integrity sha512-vHe7wZ4NOXVfkoRb8T5otiENVlT7a3IAiw7H5M2+GO+9CDgcVUUsX1zalAztCmwyOr2RUTGJdgB+ZvSVqmdHmg== +"@sideway/formula@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@sideway/formula/-/formula-3.0.1.tgz#80fcbcbaf7ce031e0ef2dd29b1bfc7c3f583611f" + integrity sha512-/poHZJJVjx3L+zVD6g9KgHfYnb443oi7wLu/XKojDviHy6HOEOA6z1Trk5aR1dGcmPenJEgb2sK2I80LeS3MIg== "@sideway/pinpoint@^2.0.0": version "2.0.0" resolved "https://registry.yarnpkg.com/@sideway/pinpoint/-/pinpoint-2.0.0.tgz#cff8ffadc372ad29fd3f78277aeb29e632cc70df" integrity sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ== -"@sinclair/typebox@^0.24.1": - version "0.24.51" - resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.24.51.tgz#645f33fe4e02defe26f2f5c0410e1c094eac7f5f" - integrity sha512-1P1OROm/rdubP5aFDSZQILU0vrLCJ4fvHt6EoqHEM+2D/G5MK3bIaymUKLit8Js9gbns5UyJnkP/TZROLw4tUA== +"@sinclair/typebox@^0.25.16": + version "0.25.23" + resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.25.23.tgz#1c15b0d2b872d89cc0f47c7243eacb447df8b8bd" + integrity sha512-VEB8ygeP42CFLWyAJhN5OklpxUliqdNEUcXb4xZ/CINqtYGTjL5ukluKdKzQ0iWdUxyQ7B0539PAUhHKrCNWSQ== "@sindresorhus/is@^0.14.0": version "0.14.0" @@ -2219,6 +2583,72 @@ "@svgr/plugin-jsx" "^6.5.1" "@svgr/plugin-svgo" "^6.5.1" +"@swc/core-darwin-arm64@1.3.36": + version "1.3.36" + resolved "https://registry.yarnpkg.com/@swc/core-darwin-arm64/-/core-darwin-arm64-1.3.36.tgz#37f15d0edda0e78837bdab337d69777d2fecfa40" + integrity sha512-lsP+C8p9cC/Vd9uAbtxpEnM8GoJI/MMnVuXak7OlxOtDH9/oTwmAcAQTfNGNaH19d2FAIRwf+5RbXCPnxa2Zjw== + +"@swc/core-darwin-x64@1.3.36": + version "1.3.36" + resolved "https://registry.yarnpkg.com/@swc/core-darwin-x64/-/core-darwin-x64-1.3.36.tgz#da6327511b62a78c2992749dd9ed813a9345608b" + integrity sha512-jaLXsozWN5xachl9fPxDMi5nbWq1rRxPAt6ISeiYB6RJk0MQKH1634pOweBBem2pUDDzwDFXFw6f22LTm/cFvA== + +"@swc/core-linux-arm-gnueabihf@1.3.36": + version "1.3.36" + resolved "https://registry.yarnpkg.com/@swc/core-linux-arm-gnueabihf/-/core-linux-arm-gnueabihf-1.3.36.tgz#4272d94f376e5b90e6453d56f52f2618e2f7b825" + integrity sha512-vcBdTHjoEpvJDbFlgto+S6VwAHzLA9GyCiuNcTU2v4KNQlFzhbO4A4PMfMCb/Z0RLJEr16tirfHdWIxjU3h8nw== + +"@swc/core-linux-arm64-gnu@1.3.36": + version "1.3.36" + resolved "https://registry.yarnpkg.com/@swc/core-linux-arm64-gnu/-/core-linux-arm64-gnu-1.3.36.tgz#d5c39fa52803ec0891c861588e5c4deb89652f63" + integrity sha512-o7f5OsvwWppJo+qIZmrGO5+XC6DPt6noecSbRHjF6o1YAcR13ETPC14k1eC9H1YbQwpyCFNVAFXyNcUbCeQyrQ== + +"@swc/core-linux-arm64-musl@1.3.36": + version "1.3.36" + resolved "https://registry.yarnpkg.com/@swc/core-linux-arm64-musl/-/core-linux-arm64-musl-1.3.36.tgz#2a47ba9b438790f2e32584ca0698ef053cc3ddba" + integrity sha512-FSHPngMi3c0fuGt9yY2Ubn5UcELi3EiPLJxBSC3X8TF9atI/WHZzK9PE9Gtn0C/LyRh4CoyOugDtSOPzGYmLQg== + +"@swc/core-linux-x64-gnu@1.3.36": + version "1.3.36" + resolved "https://registry.yarnpkg.com/@swc/core-linux-x64-gnu/-/core-linux-x64-gnu-1.3.36.tgz#5e239123452231092eac7d6bd007949b5a7e38fb" + integrity sha512-PHSsH2rek5pr3e0K09VgWAbrWK2vJhaI7MW9TPoTjyACYjcs3WwjcjQ30MghXUs2Dc/bXjWAOi9KFTjq/uCyFg== + +"@swc/core-linux-x64-musl@1.3.36": + version "1.3.36" + resolved "https://registry.yarnpkg.com/@swc/core-linux-x64-musl/-/core-linux-x64-musl-1.3.36.tgz#ed2a26e32d4d4e6f7cbf9f34d50cd38feb78d8dd" + integrity sha512-4LfMYQHzozHCKkIcmQy83b+4SpI+mOp6sYNbXqSRz5dYvTVjegKZXe596P1U/87cK2cgR4uYvkgkgBXquaWvwQ== + +"@swc/core-win32-arm64-msvc@1.3.36": + version "1.3.36" + resolved "https://registry.yarnpkg.com/@swc/core-win32-arm64-msvc/-/core-win32-arm64-msvc-1.3.36.tgz#d8fbba50bfbf5e39aa4826c8c46978c4b1fdfbe7" + integrity sha512-7y3dDcun79TAjCyk3Iv0eOMw1X/KNQbkVyKOGqnEgq9g22F8F1FoUGKHNTzUqVdzpHeJSsHgW5PlkEkl3c/d9w== + +"@swc/core-win32-ia32-msvc@1.3.36": + version "1.3.36" + resolved "https://registry.yarnpkg.com/@swc/core-win32-ia32-msvc/-/core-win32-ia32-msvc-1.3.36.tgz#108830d0282a80d0f2d77bee7773d2985d389346" + integrity sha512-zK0VR3B4LX5hzQ+7eD+K+FkxJlJg5Lo36BeahMzQ+/i0IURpnuyFlW88sdkFkMsc2swdU6bpvxLZeIRQ3W4OUg== + +"@swc/core-win32-x64-msvc@1.3.36": + version "1.3.36" + resolved "https://registry.yarnpkg.com/@swc/core-win32-x64-msvc/-/core-win32-x64-msvc-1.3.36.tgz#96d9b1077a6877f6583f5d7405f8b9380b9364fc" + integrity sha512-2bIjr9DhAckGiXZEvj6z2z7ECPcTimG+wD0VuQTvr+wkx46uAJKl5Kq+Zk+dd15ErL7JGUtCet1T7bf1k4FwvQ== + +"@swc/core@^1.3.36": + version "1.3.36" + resolved "https://registry.yarnpkg.com/@swc/core/-/core-1.3.36.tgz#c82fd4e7789082aeff47a622ef3701fffaf835e7" + integrity sha512-Ogrd9uRNIj7nHjXxG66UlKBIcXESUenJ7OD6K2a8p82qlg6ne7Ne5Goiipm/heHYhSfVmjcnRWL9ZJ4gv+YCPA== + optionalDependencies: + "@swc/core-darwin-arm64" "1.3.36" + "@swc/core-darwin-x64" "1.3.36" + "@swc/core-linux-arm-gnueabihf" "1.3.36" + "@swc/core-linux-arm64-gnu" "1.3.36" + "@swc/core-linux-arm64-musl" "1.3.36" + "@swc/core-linux-x64-gnu" "1.3.36" + "@swc/core-linux-x64-musl" "1.3.36" + "@swc/core-win32-arm64-msvc" "1.3.36" + "@swc/core-win32-ia32-msvc" "1.3.36" + "@swc/core-win32-x64-msvc" "1.3.36" + "@szmarczak/http-timer@^1.1.2": version "1.1.2" resolved "https://registry.yarnpkg.com/@szmarczak/http-timer/-/http-timer-1.1.2.tgz#b1665e2c461a2cd92f4c1bbf50d5454de0d4b421" @@ -2261,6 +2691,13 @@ dependencies: "@types/node" "*" +"@types/debug@^4.0.0": + version "4.1.7" + resolved "https://registry.yarnpkg.com/@types/debug/-/debug-4.1.7.tgz#7cc0ea761509124709b8b2d1090d8f6c17aadb82" + integrity sha512-9AonUzyTjXXhEOa0DnqpzZi6VHlqKMswga9EXjpXnnqxwLtdvPPtlO8evrI5D9S6asFRCQ6v+wpiUKbw+vKqyg== + dependencies: + "@types/ms" "*" + "@types/eslint-scope@3.7.3": version "3.7.3" resolved "https://registry.yarnpkg.com/@types/eslint-scope/-/eslint-scope-3.7.3.tgz#125b88504b61e3c8bc6f870882003253005c3224" @@ -2278,9 +2715,9 @@ "@types/estree" "*" "@types/eslint@*": - version "8.4.9" - resolved "https://registry.yarnpkg.com/@types/eslint/-/eslint-8.4.9.tgz#f7371980148697f4b582b086630319b55324b5aa" - integrity sha512-jFCSo4wJzlHQLCpceUhUnXdrPuCNOjGFMQ8Eg6JXxlz3QaCKOb7eGi2cephQdM4XTYsNej69P9JDJ1zqNIbncQ== + version "8.21.1" + resolved "https://registry.yarnpkg.com/@types/eslint/-/eslint-8.21.1.tgz#110b441a210d53ab47795124dbc3e9bb993d1e7c" + integrity sha512-rc9K8ZpVjNcLs8Fp0dkozd5Pt2Apk1glO4Vgz8ix1u6yFByxfqo5Yavpy65o+93TAe24jr7v+eSBtFLvOQtCRQ== dependencies: "@types/estree" "*" "@types/json-schema" "*" @@ -2295,22 +2732,22 @@ resolved "https://registry.yarnpkg.com/@types/estree/-/estree-0.0.51.tgz#cfd70924a25a3fd32b218e5e420e6897e1ac4f40" integrity sha512-CuPgU6f3eT/XgKKPqKd/gLZV1Xmvf1a2R5POBOGQa6uv82xpls89HU5zKeVoyR8XzHd1RGNOlQlvUe3CFkjWNQ== -"@types/express-serve-static-core@*", "@types/express-serve-static-core@^4.17.18": - version "4.17.31" - resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.17.31.tgz#a1139efeab4e7323834bb0226e62ac019f474b2f" - integrity sha512-DxMhY+NAsTwMMFHBTtJFNp5qiHKJ7TeqOo23zVEM9alT1Ml27Q3xcTH0xwxn7Q0BbMcVEJOs/7aQtUWupUQN3Q== +"@types/express-serve-static-core@*", "@types/express-serve-static-core@^4.17.33": + version "4.17.33" + resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.17.33.tgz#de35d30a9d637dc1450ad18dd583d75d5733d543" + integrity sha512-TPBqmR/HRYI3eC2E5hmiivIzv+bidAfXofM+sbonAGvyDhySGw9/PQZFt2BLOrjUUR++4eJVpx6KnLQK1Fk9tA== dependencies: "@types/node" "*" "@types/qs" "*" "@types/range-parser" "*" "@types/express@*", "@types/express@^4.17.13": - version "4.17.14" - resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.14.tgz#143ea0557249bc1b3b54f15db4c81c3d4eb3569c" - integrity sha512-TEbt+vaPFQ+xpxFLFssxUDXj5cWCxZJjIcB7Yg0k0GMHGtgtQgpvx/MUQUeAkNbA9AAGrwkAsoeItdTgS7FMyg== + version "4.17.17" + resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.17.tgz#01d5437f6ef9cfa8668e616e13c2f2ac9a491ae4" + integrity sha512-Q4FmmuLGBG58btUnfS1c1r/NQdlp3DMfGDGig8WhfpA2YRUtEkxAjkZb0yvplJGYdF1fsQ81iMDcH24sSCNC/Q== dependencies: "@types/body-parser" "*" - "@types/express-serve-static-core" "^4.17.18" + "@types/express-serve-static-core" "^4.17.33" "@types/qs" "*" "@types/serve-static" "*" @@ -2326,18 +2763,33 @@ resolved "https://registry.yarnpkg.com/@types/history/-/history-4.7.11.tgz#56588b17ae8f50c53983a524fc3cc47437969d64" integrity sha512-qjDJRrmvBMiTx+jyLxvLfJU7UznFuokDv4f3WRuriHKERccVpFU+8XMQUAbDzoiJCsmexxRExQeMwwCdamSKDA== +"@types/hoist-non-react-statics@^3.3.0": + version "3.3.1" + resolved "https://registry.yarnpkg.com/@types/hoist-non-react-statics/-/hoist-non-react-statics-3.3.1.tgz#1124aafe5118cb591977aeb1ceaaed1070eb039f" + integrity sha512-iMIqiko6ooLrTh1joXodJK5X9xeEALT1kM5G3ZLhD3hszxBdIEd5C75U834D9mLcINgD4OyZf5uQXjkuYydWvA== + dependencies: + "@types/react" "*" + hoist-non-react-statics "^3.3.0" + "@types/html-minifier-terser@^6.0.0": version "6.1.0" resolved "https://registry.yarnpkg.com/@types/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz#4fc33a00c1d0c16987b1a20cf92d20614c55ac35" integrity sha512-oh/6byDPnL1zeNXFrDXFLyZjkr1MsBG667IM792caf1L2UPOOMf65NFzjUH/ltyfwjAGfs1rsX1eftK0jC/KIg== -"@types/http-proxy@1.17.9", "@types/http-proxy@^1.17.8": +"@types/http-proxy@1.17.9": version "1.17.9" resolved "https://registry.yarnpkg.com/@types/http-proxy/-/http-proxy-1.17.9.tgz#7f0e7931343761efde1e2bf48c40f02f3f75705a" integrity sha512-QsbSjA/fSk7xB+UXlCT3wHBy5ai9wOcNDWwZAtud+jXhwOM3l+EYZh8Lng4+/6n8uar0J7xILzqftJdJ/Wdfkw== dependencies: "@types/node" "*" +"@types/http-proxy@^1.17.8": + version "1.17.10" + resolved "https://registry.yarnpkg.com/@types/http-proxy/-/http-proxy-1.17.10.tgz#e576c8e4a0cc5c6a138819025a88e167ebb38d6c" + integrity sha512-Qs5aULi+zV1bwKAg5z1PWnDXWmsn+LxIvUGv6E2+OOMYhclZMO+OXd9pYVf2gLykf2I7IV2u7oTHwChPNsvJ7g== + dependencies: + "@types/node" "*" + "@types/istanbul-lib-coverage@*", "@types/istanbul-lib-coverage@^2.0.0": version "2.0.4" resolved "https://registry.yarnpkg.com/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.4.tgz#8467d4b3c087805d63580480890791277ce35c44" @@ -2357,7 +2809,7 @@ dependencies: "@types/istanbul-lib-report" "*" -"@types/json-schema@*", "@types/json-schema@^7.0.4", "@types/json-schema@^7.0.5", "@types/json-schema@^7.0.8", "@types/json-schema@^7.0.9": +"@types/json-schema@*", "@types/json-schema@^7.0.4", "@types/json-schema@^7.0.5", "@types/json-schema@^7.0.6", "@types/json-schema@^7.0.8", "@types/json-schema@^7.0.9": version "7.0.11" resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.11.tgz#d421b6c527a3037f7c84433fd2c4229e016863d3" integrity sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ== @@ -2374,10 +2826,20 @@ resolved "https://registry.yarnpkg.com/@types/mime/-/mime-3.0.1.tgz#5f8f2bca0a5863cb69bc0b0acd88c96cb1d4ae10" integrity sha512-Y4XFY5VJAuw0FgAqPNd6NNoV44jbq9Bz2L7Rh/J6jLTiHBSBJa9fxqQIvkIld4GsoDOcCbvzOUAbLPsSKKg+uA== +"@types/ms@*": + version "0.7.31" + resolved "https://registry.yarnpkg.com/@types/ms/-/ms-0.7.31.tgz#31b7ca6407128a3d2bbc27fe2d21b345397f6197" + integrity sha512-iiUgKzV9AuaEkZqkOLDIvlQiL6ltuZd9tGcW3gwpnX8JbuiuhFlEGmmFXEXkN50Cvq7Os88IY2v0dkDqXYWVgA== + "@types/node@*": - version "18.11.9" - resolved "https://registry.yarnpkg.com/@types/node/-/node-18.11.9.tgz#02d013de7058cea16d36168ef2fc653464cfbad4" - integrity sha512-CRpX21/kGdzjOpFsZSkcrXMGIBWMGNIHXXBVFSH+ggkftxg+XYP20TESbh+zFvFj3EQOl5byk0HTRn1IL6hbqg== + version "18.14.0" + resolved "https://registry.yarnpkg.com/@types/node/-/node-18.14.0.tgz#94c47b9217bbac49d4a67a967fdcdeed89ebb7d0" + integrity sha512-5EWrvLmglK+imbCJY0+INViFWUHg1AHel1sq4ZVSfdcNqGy9Edv3UB9IIzzg+xPaUcAgZYcfVs2fBcwDeZzU0A== + +"@types/node@^14.11.8": + version "14.18.36" + resolved "https://registry.yarnpkg.com/@types/node/-/node-14.18.36.tgz#c414052cb9d43fab67d679d5f3c641be911f5835" + integrity sha512-FXKWbsJ6a1hIrRxv+FoukuHnGTgEzKYGi7kilfMae96AL9UNkPFNWJEEYWzdRI9ooIkbr4AKldyuSTLql06vLQ== "@types/node@^17.0.5": version "17.0.45" @@ -2394,7 +2856,12 @@ resolved "https://registry.yarnpkg.com/@types/parse5/-/parse5-5.0.3.tgz#e7b5aebbac150f8b5fdd4a46e7f0bd8e65e19109" integrity sha512-kUNnecmtkunAoQ3CnjmMkzNU/gtxG8guhi+Fk2U/kOpIKjIMKnXGp4IJCgQJrXSgMsWYimYG4TGjz/UzbGEBTw== -"@types/prop-types@*": +"@types/parse5@^6.0.0": + version "6.0.3" + resolved "https://registry.yarnpkg.com/@types/parse5/-/parse5-6.0.3.tgz#705bb349e789efa06f43f128cef51240753424cb" + integrity sha512-SuT16Q1K51EAVPz1K29DJ/sXjhSQ0zjvsypYJ6tlwVsRV9jwW5Adq2ch8Dq8kDBCkYnELS7N7VNCSB5nC56t/g== + +"@types/prop-types@*", "@types/prop-types@^15.0.0": version "15.7.5" resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.5.tgz#5f19d2b85a98e9558036f6a3cacc8819420f05cf" integrity sha512-JCB8C6SnDoQf0cNycqd/35A7MjcnK+ZTqE7judS6o7utxUCg6imJg3QK2qzHKszlTjcj2cn+NwMB2i96ubpj7w== @@ -2409,6 +2876,16 @@ resolved "https://registry.yarnpkg.com/@types/range-parser/-/range-parser-1.2.4.tgz#cd667bcfdd025213aafb7ca5915a932590acdcdc" integrity sha512-EEhsLsD6UsDM1yFhAvy0Cjr6VwmpMWqFBCb9w07wVugF7w9nfajxLuVmngTIpgS6svCnm6Vaw+MZhoDCKnOfsw== +"@types/react-redux@^7.1.20": + version "7.1.25" + resolved "https://registry.yarnpkg.com/@types/react-redux/-/react-redux-7.1.25.tgz#de841631205b24f9dfb4967dd4a7901e048f9a88" + integrity sha512-bAGh4e+w5D8dajd6InASVIyCo4pZLJ66oLb80F9OBLO1gKESbZcRCJpTT6uLXX+HAB57zw1WTdwJdAsewuTweg== + dependencies: + "@types/hoist-non-react-statics" "^3.3.0" + "@types/react" "*" + hoist-non-react-statics "^3.3.0" + redux "^4.0.0" + "@types/react-router-config@*", "@types/react-router-config@5.0.6", "@types/react-router-config@^5.0.6": version "5.0.6" resolved "https://registry.yarnpkg.com/@types/react-router-config/-/react-router-config-5.0.6.tgz#87c5c57e72d241db900d9734512c50ccec062451" @@ -2428,17 +2905,17 @@ "@types/react-router" "*" "@types/react-router@*": - version "5.1.19" - resolved "https://registry.yarnpkg.com/@types/react-router/-/react-router-5.1.19.tgz#9b404246fba7f91474d7008a3d48c17b6e075ad6" - integrity sha512-Fv/5kb2STAEMT3wHzdKQK2z8xKq38EDIGVrutYLmQVVLe+4orDFquU52hQrULnEHinMKv9FSA6lf9+uNT1ITtA== + version "5.1.20" + resolved "https://registry.yarnpkg.com/@types/react-router/-/react-router-5.1.20.tgz#88eccaa122a82405ef3efbcaaa5dcdd9f021387c" + integrity sha512-jGjmu/ZqS7FjSH6owMcD5qpq19+1RS9DeVRqfl1FeBMxTDQAGwlMWOcs52NDoXaNKyG3d1cYQFMs9rCrb88o9Q== dependencies: "@types/history" "^4.7.11" "@types/react" "*" "@types/react@*": - version "18.0.25" - resolved "https://registry.yarnpkg.com/@types/react/-/react-18.0.25.tgz#8b1dcd7e56fe7315535a4af25435e0bb55c8ae44" - integrity sha512-xD6c0KDT4m7n9uD4ZHi02lzskaiqcBxf4zi+tXZY98a04wvc0hi/TcCPC2FOESZi51Nd7tlUeOJY8RofL799/g== + version "18.0.28" + resolved "https://registry.yarnpkg.com/@types/react/-/react-18.0.28.tgz#accaeb8b86f4908057ad629a26635fe641480065" + integrity sha512-RD0ivG1kEztNBdoAK7lekI9M+azSnitIn85h4iOiaLjaTrMjzslhaqCGaI4IyCJ1RljWiLCEu4jyrLLgqxBTew== dependencies: "@types/prop-types" "*" "@types/scheduler" "*" @@ -2488,22 +2965,29 @@ resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.6.tgz#250a7b16c3b91f672a24552ec64678eeb1d3a08d" integrity sha512-PBjIUxZHOuj0R15/xuwJYjFi+KZdNFrehocChv4g5hu6aFroHue8m0lBP0POdK2nKzbw0cgV1mws8+V/JAcEkQ== -"@types/ws@8.5.3", "@types/ws@^8.5.1": +"@types/ws@8.5.3": version "8.5.3" resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.5.3.tgz#7d25a1ffbecd3c4f2d35068d0b283c037003274d" integrity sha512-6YOoWjruKj1uLf3INHH7D3qTXwFfEsg1kf3c0uDdSBJwfa/llkwIjrAGV7j7mVgGNbzTQ3HiHKKDXl6bJPD97w== dependencies: "@types/node" "*" +"@types/ws@^8.5.1": + version "8.5.4" + resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.5.4.tgz#bb10e36116d6e570dd943735f86c933c1587b8a5" + integrity sha512-zdQDHKUgcX/zBc4GrwsE/7dVdAD8JR4EuiAXiiUhhfyIJXXb2+PrGshFyeXWQPMmmZ2XxgaqclgpIC7eTXc1mg== + dependencies: + "@types/node" "*" + "@types/yargs-parser@*": version "21.0.0" resolved "https://registry.yarnpkg.com/@types/yargs-parser/-/yargs-parser-21.0.0.tgz#0c60e537fa790f5f9472ed2776c2b71ec117351b" integrity sha512-iO9ZQHkZxHn4mSakYV0vFHAVDyEOIJQrV2uZ06HxEPcx+mt8swXoZHIbaaJ2crJYFfErySgktuTZ3BeLz+XmFA== "@types/yargs@^17.0.8": - version "17.0.13" - resolved "https://registry.yarnpkg.com/@types/yargs/-/yargs-17.0.13.tgz#34cced675ca1b1d51fcf4d34c3c6f0fa142a5c76" - integrity sha512-9sWaruZk2JGxIQU+IhI1fhPYRcQ0UuTNuKuCW9bR5fp7qi2Llf7WDzNa17Cy7TKnh3cdxDOiyTu6gaLS0eDatg== + version "17.0.22" + resolved "https://registry.yarnpkg.com/@types/yargs/-/yargs-17.0.22.tgz#7dd37697691b5f17d020f3c63e7a45971ff71e9a" + integrity sha512-pet5WJ9U8yPVRhkwuEIp5ktAeAqRZOq4UdAyWLWzxbtpyXnzbtLdKiXAjJzi/KLmPGS9wk86lUFWZFN6sISo4g== dependencies: "@types/yargs-parser" "*" @@ -2676,14 +3160,14 @@ acorn@^7.0.0: integrity sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A== acorn@^8.0.4, acorn@^8.5.0, acorn@^8.7.1: - version "8.8.1" - resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.8.1.tgz#0a3f9cbecc4ec3bea6f0a80b66ae8dd2da250b73" - integrity sha512-7zFpHzhnqYKrkYdUjF1HI1bzd0VygEGX8lFk4k5zVMqHEoES+P+7TKI+EvLO9WVMJ8eekdO0aDEK044xTXwPPA== + version "8.8.2" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.8.2.tgz#1b2f25db02af965399b9776b0c2c391276d37c4a" + integrity sha512-xjIYgE8HBrkpd/sJqOGNspf8uHG+NOHGOw6a/Urj8taM2EXfdNAH2oFcPeIFfsv3+kz/mJrS5VuMqbNLjCa2vw== address@^1.0.1, address@^1.1.2: - version "1.2.1" - resolved "https://registry.yarnpkg.com/address/-/address-1.2.1.tgz#25bb61095b7522d65b357baa11bc05492d4c8acd" - integrity sha512-B+6bi5D34+fDYENiH5qOlA0cV2rAGKuWZ9LeyUUehbXy8e0VS9e498yO0Jeeh+iM+6KbfudHTFjXw2MmJD4QRA== + version "1.2.2" + resolved "https://registry.yarnpkg.com/address/-/address-1.2.2.tgz#2b5248dac5485a6390532c6a517fda2e3faac89e" + integrity sha512-4B/qKCfeE/ODUaAUpSwfzazo5x29WD4r3vXiWsB7I2mSDAihwEqKO+g8GELZUQSSAo5e1XTYh3ZVfLyxBc12nA== aggregate-error@^3.0.0: version "3.1.0" @@ -2693,7 +3177,7 @@ aggregate-error@^3.0.0: clean-stack "^2.0.0" indent-string "^4.0.0" -ajv-formats@^2.1.1: +ajv-formats@2.1.1, ajv-formats@^2.1.1: version "2.1.1" resolved "https://registry.yarnpkg.com/ajv-formats/-/ajv-formats-2.1.1.tgz#6e669400659eb74973bbf2e33327180a0996b520" integrity sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA== @@ -2712,6 +3196,16 @@ ajv-keywords@^5.0.0: dependencies: fast-deep-equal "^3.1.3" +ajv@8.1.0: + version "8.1.0" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.1.0.tgz#45d5d3d36c7cdd808930cc3e603cf6200dbeb736" + integrity sha512-B/Sk2Ix7A36fs/ZkuGLIR86EdjbgR6fsAcbx9lOP/QBSXujDNbVmIS/U4Itz5k8fPFDeVZl/zQ/gJW4Jrq6XjQ== + dependencies: + fast-deep-equal "^3.1.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + uri-js "^4.2.2" + ajv@^6.12.2, ajv@^6.12.4, ajv@^6.12.5: version "6.12.6" resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.12.6.tgz#baf5a62e802b07d977034586f8c3baf5adf26df4" @@ -2723,9 +3217,9 @@ ajv@^6.12.2, ajv@^6.12.4, ajv@^6.12.5: uri-js "^4.2.2" ajv@^8.0.0, ajv@^8.8.0: - version "8.11.0" - resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.11.0.tgz#977e91dd96ca669f54a11e23e378e33b884a565f" - integrity sha512-wGgprdCvMalC0BztXvitD2hC04YffAvtsUn93JbGXYLAtCUO4xd17mCCZQxUOItiBwZvJScWo8NIvQMQ71rdpg== + version "8.12.0" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.12.0.tgz#d1a0527323e22f53562c567c00991577dfbe19d1" + integrity sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA== dependencies: fast-deep-equal "^3.1.1" json-schema-traverse "^1.0.0" @@ -2733,31 +3227,31 @@ ajv@^8.0.0, ajv@^8.8.0: uri-js "^4.2.2" algoliasearch-helper@^3.10.0: - version "3.11.1" - resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.11.1.tgz#d83ab7f1a2a374440686ef7a144b3c288b01188a" - integrity sha512-mvsPN3eK4E0bZG0/WlWJjeqe/bUD2KOEVOl0GyL/TGXn6wcpZU8NOuztGHCUKXkyg5gq6YzUakVTmnmSSO5Yiw== + version "3.11.3" + resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.11.3.tgz#6e7af8afe6f9a9e55186abffb7b6cf7ca8de3301" + integrity sha512-TbaEvLwiuGygHQIB8y+OsJKQQ40+JKUua5B91X66tMUHyyhbNHvqyr0lqd3wCoyKx7WybyQrC0WJvzoIeh24Aw== dependencies: "@algolia/events" "^4.0.1" algoliasearch@^4.0.0, algoliasearch@^4.13.1: - version "4.14.2" - resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-4.14.2.tgz#63f142583bfc3a9bd3cd4a1b098bf6fe58e56f6c" - integrity sha512-ngbEQonGEmf8dyEh5f+uOIihv4176dgbuOZspiuhmTTBRBuzWu3KCGHre6uHj5YyuC7pNvQGzB6ZNJyZi0z+Sg== + version "4.14.3" + resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-4.14.3.tgz#f02a77a4db17de2f676018938847494b692035e7" + integrity sha512-GZTEuxzfWbP/vr7ZJfGzIl8fOsoxN916Z6FY2Egc9q2TmZ6hvq5KfAxY89pPW01oW/2HDEKA8d30f9iAH9eXYg== dependencies: - "@algolia/cache-browser-local-storage" "4.14.2" - "@algolia/cache-common" "4.14.2" - "@algolia/cache-in-memory" "4.14.2" - "@algolia/client-account" "4.14.2" - "@algolia/client-analytics" "4.14.2" - "@algolia/client-common" "4.14.2" - "@algolia/client-personalization" "4.14.2" - "@algolia/client-search" "4.14.2" - "@algolia/logger-common" "4.14.2" - "@algolia/logger-console" "4.14.2" - "@algolia/requester-browser-xhr" "4.14.2" - "@algolia/requester-common" "4.14.2" - "@algolia/requester-node-http" "4.14.2" - "@algolia/transporter" "4.14.2" + "@algolia/cache-browser-local-storage" "4.14.3" + "@algolia/cache-common" "4.14.3" + "@algolia/cache-in-memory" "4.14.3" + "@algolia/client-account" "4.14.3" + "@algolia/client-analytics" "4.14.3" + "@algolia/client-common" "4.14.3" + "@algolia/client-personalization" "4.14.3" + "@algolia/client-search" "4.14.3" + "@algolia/logger-common" "4.14.3" + "@algolia/logger-console" "4.14.3" + "@algolia/requester-browser-xhr" "4.14.3" + "@algolia/requester-common" "4.14.3" + "@algolia/requester-node-http" "4.14.3" + "@algolia/transporter" "4.14.3" ansi-align@^3.0.0, ansi-align@^3.0.1: version "3.0.1" @@ -2800,10 +3294,15 @@ ansi-styles@^6.1.0: resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.1.tgz#0e62320cf99c21afff3b3012192546aacbfb05c5" integrity sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug== +any-promise@^1.0.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/any-promise/-/any-promise-1.3.0.tgz#abc6afeedcea52e809cdc0376aed3ce39635d17f" + integrity sha512-7UvmKalWRt1wgjL1RrGxoSJW/0QZFIegpeGvZG9kjp8vrRu55XTHbwnqq2GpXm9uLbcuhxm3IqX9OB4MZR1b2A== + anymatch@~3.1.2: - version "3.1.2" - resolved "https://registry.yarnpkg.com/anymatch/-/anymatch-3.1.2.tgz#c0557c096af32f106198f4f4e2a383537e378716" - integrity sha512-P43ePfOAIupkguHUycrc4qJ9kz8ZiuOUijaETwX7THt0Y/GNK7v0aa8rY816xWjZ7rJdA5XdMcpVFTKMq+RvWg== + version "3.1.3" + resolved "https://registry.yarnpkg.com/anymatch/-/anymatch-3.1.3.tgz#790c58b19ba1720a84205b57c618d5ad8524973e" + integrity sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw== dependencies: normalize-path "^3.0.0" picomatch "^2.0.4" @@ -2845,11 +3344,26 @@ array-union@^3.0.1: resolved "https://registry.yarnpkg.com/array-union/-/array-union-3.0.1.tgz#da52630d327f8b88cfbfb57728e2af5cd9b6b975" integrity sha512-1OvF9IbWwaeiM9VhzYXVQacMibxpXOMYVNIvMtKRyX9SImBXpKcFr8XvFDeEslCyuH/t6KRt7HEO94AlP8Iatw== -asap@~2.0.3: +asap@^2.0.0, asap@~2.0.3: version "2.0.6" resolved "https://registry.yarnpkg.com/asap/-/asap-2.0.6.tgz#e50347611d7e690943208bbdafebcbc2fb866d46" integrity sha512-BSHWgDSAiKs50o2Re8ppvp3seVHXSRM44cdSsT9FfNEUUZLOGWVCsiWaRPWM1Znn+mqZ1OfVZ3z3DWEzSp7hRA== +async@3.2.1: + version "3.2.1" + resolved "https://registry.yarnpkg.com/async/-/async-3.2.1.tgz#d3274ec66d107a47476a4c49136aacdb00665fc8" + integrity sha512-XdD5lRO/87udXCMC9meWdYiR+Nq6ZjUfXidViUZGu2F1MO4T3XwZ1et0hb2++BgLfhyJwy44BGB/yx80ABx8hg== + +async@^3.2.4: + version "3.2.4" + resolved "https://registry.yarnpkg.com/async/-/async-3.2.4.tgz#2d22e00f8cddeb5fde5dd33522b56d1cf569a81c" + integrity sha512-iAB+JbDEGXhyIUavoDl9WP/Jj106Kz9DEn1DPgYw5ruDn0e3Wgi3sKFm55sASdGBNOQB8F59d9qQ7deqrHA8wQ== + +asynckit@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79" + integrity sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q== + at-least-node@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/at-least-node/-/at-least-node-1.0.0.tgz#602cd4b46e844ad4effc92a8011a3c46e0238dc2" @@ -2960,6 +3474,11 @@ bail@^1.0.0: resolved "https://registry.yarnpkg.com/bail/-/bail-1.0.5.tgz#b6fa133404a392cbc1f8c4bf63f5953351e7a776" integrity sha512-xFbRxM1tahm08yHBP16MMjVUAvDaBMD38zsM9EMAUN61omwLmKlOpB/Zku5QkjZ8TZ4vn53pj+t518cH0S03RQ== +bail@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/bail/-/bail-2.0.2.tgz#d26f5cd8fe5d6f832a31517b9f7c356040ba6d5d" + integrity sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw== + balanced-match@^1.0.0: version "1.0.2" resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" @@ -3042,9 +3561,9 @@ bonjour-service@1.0.12: multicast-dns "^7.2.4" bonjour-service@^1.0.11: - version "1.0.14" - resolved "https://registry.yarnpkg.com/bonjour-service/-/bonjour-service-1.0.14.tgz#c346f5bc84e87802d08f8d5a60b93f758e514ee7" - integrity sha512-HIMbgLnk1Vqvs6B4Wq5ep7mxvj9sGz5d1JJyDNSGNIdA/w2MCz6GTjWTdjqOJV1bEPj+6IkxDvWNFKEBxNt4kQ== + version "1.1.0" + resolved "https://registry.yarnpkg.com/bonjour-service/-/bonjour-service-1.1.0.tgz#424170268d68af26ff83a5c640b95def01803a13" + integrity sha512-LVRinRB3k1/K0XzZ2p58COnWvkQknIY6sf0zF2rpErvcJXpMBttEPQSxK+HEXSS9VmpZlDoDnQWv8ftJT20B0Q== dependencies: array-flatten "^2.1.2" dns-equal "^1.0.0" @@ -3092,6 +3611,13 @@ brace-expansion@^1.1.7: balanced-match "^1.0.0" concat-map "0.0.1" +brace-expansion@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.1.tgz#1edc459e0f0c548486ecf9fc99f2221364b9a0ae" + integrity sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA== + dependencies: + balanced-match "^1.0.0" + braces@^3.0.2, braces@~3.0.2: version "3.0.2" resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107" @@ -3099,15 +3625,15 @@ braces@^3.0.2, braces@~3.0.2: dependencies: fill-range "^7.0.1" -browserslist@^4.0.0, browserslist@^4.14.5, browserslist@^4.16.6, browserslist@^4.18.1, browserslist@^4.21.3, browserslist@^4.21.4: - version "4.21.4" - resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.21.4.tgz#e7496bbc67b9e39dd0f98565feccdcb0d4ff6987" - integrity sha512-CBHJJdDmgjl3daYjN5Cp5kbTf1mUhZoS+beLklHIvkOWscs83YAhLlF3Wsh/lciQYAcbBJgTOD44VtG31ZM4Hw== +browserslist@^4.0.0, browserslist@^4.14.5, browserslist@^4.16.6, browserslist@^4.18.1, browserslist@^4.21.3, browserslist@^4.21.4, browserslist@^4.21.5: + version "4.21.5" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.21.5.tgz#75c5dae60063ee641f977e00edd3cfb2fb7af6a7" + integrity sha512-tUkiguQGW7S3IhB7N+c2MV/HZPSCPAAiYBZXLsBhFB/PCy6ZKKsZrmBayHV9fdGV/ARIfJ14NkxKzRDjvp7L6w== dependencies: - caniuse-lite "^1.0.30001400" - electron-to-chromium "^1.4.251" - node-releases "^2.0.6" - update-browserslist-db "^1.0.9" + caniuse-lite "^1.0.30001449" + electron-to-chromium "^1.4.284" + node-releases "^2.0.8" + update-browserslist-db "^1.0.10" buffer-from@^1.0.0: version "1.1.2" @@ -3153,6 +3679,11 @@ call-bind@^1.0.0, call-bind@^1.0.2: function-bind "^1.1.1" get-intrinsic "^1.0.2" +call-me-maybe@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/call-me-maybe/-/call-me-maybe-1.0.2.tgz#03f964f19522ba643b1b0693acb9152fe2074baa" + integrity sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ== + callsites@^3.0.0: version "3.1.0" resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73" @@ -3171,6 +3702,11 @@ camelcase-css@2.0.1, camelcase-css@^2.0.1: resolved "https://registry.yarnpkg.com/camelcase-css/-/camelcase-css-2.0.1.tgz#ee978f6947914cc30c6b44741b6ed1df7f043fd5" integrity sha512-QOSvevhslijgYwRx6Rv7zKdMF8lbRmx+uQGx2+vDc+KI/eBnsy9kit5aj23AgGu3pa4t9AgwbnXWqS+iOY+2aA== +camelcase@^5.0.0: + version "5.3.1" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-5.3.1.tgz#e3c9b31569e106811df242f715725a1f4c494320" + integrity sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg== + camelcase@^6.2.0: version "6.3.0" resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-6.3.0.tgz#5685b95eb209ac9c0c177467778c9c84df58ba9a" @@ -3186,10 +3722,10 @@ caniuse-api@^3.0.0: lodash.memoize "^4.1.2" lodash.uniq "^4.5.0" -caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001400, caniuse-lite@^1.0.30001426: - version "1.0.30001430" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001430.tgz#638a8ae00b5a8a97e66ff43733b2701f81b101fa" - integrity sha512-IB1BXTZKPDVPM7cnV4iaKaHxckvdr/3xtctB3f7Hmenx3qYBhGtTZ//7EllK66aKXW98Lx0+7Yr0kxBtIt3tzg== +caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001426, caniuse-lite@^1.0.30001449: + version "1.0.30001457" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001457.tgz#6af34bb5d720074e2099432aa522c21555a18301" + integrity sha512-SDIV6bgE1aVbK6XyxdURbUE89zY7+k1BBBaOwYwkNCglXlel/E7mELiHC64HQ+W0xSKlqWhV9Wh7iHxUjMs4fA== ccount@^1.0.0: version "1.1.0" @@ -3223,11 +3759,21 @@ character-entities@^1.0.0: resolved "https://registry.yarnpkg.com/character-entities/-/character-entities-1.2.4.tgz#e12c3939b7eaf4e5b15e7ad4c5e28e1d48c5b16b" integrity sha512-iBMyeEHxfVnIakwOuDXpVkc54HijNgCyQB2w0VfGQThle6NXn50zU6V/u+LDhxHcDUPojn6Kpga3PTAD8W1bQw== +character-entities@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/character-entities/-/character-entities-2.0.2.tgz#2d09c2e72cd9523076ccb21157dff66ad43fcc22" + integrity sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ== + character-reference-invalid@^1.0.0: version "1.1.4" resolved "https://registry.yarnpkg.com/character-reference-invalid/-/character-reference-invalid-1.1.4.tgz#083329cda0eae272ab3dbbf37e9a382c13af1560" integrity sha512-mKKUkUbhPpQlCOfIuZkvSEgktjPFIsZKRRbC6KWVEMvlzblj3i3asQv5ODsrwt0N3pHAEvjP8KTQPHkp0+6jOg== +charset@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/charset/-/charset-1.0.1.tgz#8d59546c355be61049a8fa9164747793319852bd" + integrity sha512-6dVyOOYjpfFcL1Y4qChrAoQLRHvj2ziyhcm0QJlhOcAhykL/k1kTUPbeo+87MNRTRdk2OIIsIXbuF3x2wi5EXg== + cheerio-select@^2.1.0: version "2.1.0" resolved "https://registry.yarnpkg.com/cheerio-select/-/cheerio-select-2.1.0.tgz#4d8673286b8126ca2a8e42740d5e3c4884ae21b4" @@ -3301,9 +3847,9 @@ ci-info@^2.0.0: integrity sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ== ci-info@^3.2.0: - version "3.5.0" - resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-3.5.0.tgz#bfac2a29263de4c829d806b1ab478e35091e171f" - integrity sha512-yH4RezKOGlOhxkmhbeNuC4eYZKAUsEaGtBuBzDDP1eFUKiccDWzBABxBfOx31IDwDIXMTxWuwAxUGModvkbuVw== + version "3.8.0" + resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-3.8.0.tgz#81408265a5380c929f0bc665d62256628ce9ef91" + integrity sha512-eXTggHWSooYhq49F2opQhuHWgzucfF2YgODK4e1566GQs5BIfP30B0oenwBJHfWxAs2fyPB1s7Mg949zLf61Yw== clean-css@5.3.0: version "5.3.0" @@ -3313,9 +3859,9 @@ clean-css@5.3.0: source-map "~0.6.0" clean-css@^5.2.2, clean-css@^5.3.0: - version "5.3.1" - resolved "https://registry.yarnpkg.com/clean-css/-/clean-css-5.3.1.tgz#d0610b0b90d125196a2894d35366f734e5d7aa32" - integrity sha512-lCr8OHhiWCTw4v8POJovCoh4T7I9U11yVsPjMWWnnMmp9ZowCxyad1Pathle/9HjaDp+fdQKjO9fQydE6RHTZg== + version "5.3.2" + resolved "https://registry.yarnpkg.com/clean-css/-/clean-css-5.3.2.tgz#70ecc7d4d4114921f5d298349ff86a31a9975224" + integrity sha512-JVJbM+f3d3Q704rF4bqQ5UUyTtuJ0JRKNbTKVEeujCCBoMdkEi+V+e8oktO9qGQNSvHrFTM6JZRXrUvGR1czww== dependencies: source-map "~0.6.0" @@ -3357,6 +3903,24 @@ client-only@^0.0.1: resolved "https://registry.yarnpkg.com/client-only/-/client-only-0.0.1.tgz#38bba5d403c41ab150bff64a95c85013cf73bca1" integrity sha512-IV3Ou0jSMzZrd3pZ48nLkT9DA7Ag1pnPzaiQhpW7c3RbcqqzvzzVu+L8gfqMp/8IM2MQtSiqaCxrrcfu8I8rMA== +cliui@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-6.0.0.tgz#511d702c0c4e41ca156d7d0e96021f23e13225b1" + integrity sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ== + dependencies: + string-width "^4.2.0" + strip-ansi "^6.0.0" + wrap-ansi "^6.2.0" + +cliui@^8.0.1: + version "8.0.1" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-8.0.1.tgz#0c04b075db02cbfe60dc8e6cf2f5486b1a3608aa" + integrity sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ== + dependencies: + string-width "^4.2.0" + strip-ansi "^6.0.1" + wrap-ansi "^7.0.0" + clone-deep@^4.0.1: version "4.0.1" resolved "https://registry.yarnpkg.com/clone-deep/-/clone-deep-4.0.1.tgz#c19fd9bdbbf85942b4fd979c84dcf7d5f07c2387" @@ -3373,7 +3937,7 @@ clone-response@^1.0.2: dependencies: mimic-response "^1.0.0" -clsx@^1.2.1: +clsx@^1.1.1, clsx@^1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/clsx/-/clsx-1.2.1.tgz#0ddc4a20a549b59c93a4116bb26f5294ca17dc12" integrity sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg== @@ -3412,6 +3976,11 @@ colord@^2.9.1: resolved "https://registry.yarnpkg.com/colord/-/colord-2.9.3.tgz#4f8ce919de456f1d5c1c368c307fe20f3e59fb43" integrity sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw== +colorette@^1.2.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/colorette/-/colorette-1.4.0.tgz#5190fbb87276259a86ad700bff2c6d6faa3fca40" + integrity sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g== + colorette@^2.0.10: version "2.0.19" resolved "https://registry.yarnpkg.com/colorette/-/colorette-2.0.19.tgz#cdf044f47ad41a0f4b56b3a0d5b4e6e1a2d5a798" @@ -3422,12 +3991,24 @@ combine-promises@^1.1.0: resolved "https://registry.yarnpkg.com/combine-promises/-/combine-promises-1.1.0.tgz#72db90743c0ca7aab7d0d8d2052fd7b0f674de71" integrity sha512-ZI9jvcLDxqwaXEixOhArm3r7ReIivsXkpbyEWyeOhzz1QS0iSgBPnWvEqvIQtYyamGCYA88gFhmUrs9hrrQ0pg== +combined-stream@^1.0.8: + version "1.0.8" + resolved "https://registry.yarnpkg.com/combined-stream/-/combined-stream-1.0.8.tgz#c3d45a8b34fd730631a110a8a2520682b31d5a7f" + integrity sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg== + dependencies: + delayed-stream "~1.0.0" + comma-separated-tokens@^1.0.0: version "1.0.8" resolved "https://registry.yarnpkg.com/comma-separated-tokens/-/comma-separated-tokens-1.0.8.tgz#632b80b6117867a158f1080ad498b2fbe7e3f5ea" integrity sha512-GHuDRO12Sypu2cV70d1dkA2EUmXHgntrzbpvOB+Qy+49ypNfGgFQIC2fhhXbnyrJRynDCAARsT7Ou0M6hirpfw== -commander@2, commander@^2.20.0: +comma-separated-tokens@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz#4e89c9458acb61bc8fef19f4529973b2392839ee" + integrity sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg== + +commander@2.20.3, commander@^2.20.0: version "2.20.3" resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33" integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ== @@ -3437,6 +4018,11 @@ commander@7, commander@^7.2.0: resolved "https://registry.yarnpkg.com/commander/-/commander-7.2.0.tgz#a36cb57d0b501ce108e4d20559a150a391d97ab7" integrity sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw== +commander@^4.0.0, commander@~4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/commander/-/commander-4.1.1.tgz#9fd602bd936294e9e9ef46a3f4d6964044b18068" + integrity sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA== + commander@^5.1.0: version "5.1.0" resolved "https://registry.yarnpkg.com/commander/-/commander-5.1.0.tgz#46abbd1652f8e059bddaef99bbdcb2ad9cf179ae" @@ -3452,6 +4038,11 @@ commondir@^1.0.1: resolved "https://registry.yarnpkg.com/commondir/-/commondir-1.0.1.tgz#ddd800da0c66127393cca5950ea968a3aaf1253b" integrity sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg== +component-emitter@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/component-emitter/-/component-emitter-1.3.0.tgz#16e4070fba8ae29b679f2215853ee181ab2eabc0" + integrity sha512-Rd3se6QB+sO1TwqZjscQrurpEPIfO0/yYnSin6Q/rD3mOutHvUrCAhJub3r90uNb+SESBuE0QYoB90YdfatsRg== + compressible@~2.0.16: version "2.0.18" resolved "https://registry.yarnpkg.com/compressible/-/compressible-2.0.18.tgz#af53cca6b070d4c3c0750fbd77286a6d7cc46fba" @@ -3472,6 +4063,25 @@ compression@^1.7.4: safe-buffer "5.1.2" vary "~1.1.2" +compute-gcd@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/compute-gcd/-/compute-gcd-1.2.1.tgz#34d639f3825625e1357ce81f0e456a6249d8c77f" + integrity sha512-TwMbxBNz0l71+8Sc4czv13h4kEqnchV9igQZBi6QUaz09dnz13juGnnaWWJTRsP3brxOoxeB4SA2WELLw1hCtg== + dependencies: + validate.io-array "^1.0.3" + validate.io-function "^1.0.2" + validate.io-integer-array "^1.0.0" + +compute-lcm@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/compute-lcm/-/compute-lcm-1.1.2.tgz#9107c66b9dca28cefb22b4ab4545caac4034af23" + integrity sha512-OFNPdQAXnQhDSKioX8/XYT6sdUlXwpeMjfd6ApxMJfyZ4GxmLR1xvMERctlYhlHwIiz6CSpBc2+qYKjHGZw4TQ== + dependencies: + compute-gcd "^1.2.1" + validate.io-array "^1.0.3" + validate.io-function "^1.0.2" + validate.io-integer-array "^1.0.0" + concat-map@0.0.1: version "0.0.1" resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" @@ -3517,9 +4127,9 @@ content-disposition@0.5.4: safe-buffer "5.2.1" content-type@~1.0.4: - version "1.0.4" - resolved "https://registry.yarnpkg.com/content-type/-/content-type-1.0.4.tgz#e138cc75e040c727b1966fe5e5f8c9aee256fe3b" - integrity sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA== + version "1.0.5" + resolved "https://registry.yarnpkg.com/content-type/-/content-type-1.0.5.tgz#8b773162656d1d1086784c8f23a54ce6d73d7918" + integrity sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA== convert-source-map@^1.7.0: version "1.9.0" @@ -3536,6 +4146,11 @@ cookie@0.5.0: resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.5.0.tgz#d1f5d71adec6558c58f389987c366aa47e994f8b" integrity sha512-YZ3GUyn/o8gfKJlnlX7g7xq4gyO6OSuhGPKaaGssGB2qgDUS0gPgtTvoyZLTt9Ab6dC4hfc9dV5arkvc/OCmrw== +cookiejar@^2.1.3: + version "2.1.4" + resolved "https://registry.yarnpkg.com/cookiejar/-/cookiejar-2.1.4.tgz#ee669c1fea2cf42dc31585469d193fef0d65771b" + integrity sha512-LDx6oHrK+PhzLKJU9j5S7/Y3jM/mUHvD/DeI1WQmJn652iPC5Y4TBzC9l+5OMOXlyTTA+SmVUPm0HQUwpD5Jqw== + copy-text-to-clipboard@^3.0.1: version "3.0.1" resolved "https://registry.yarnpkg.com/copy-text-to-clipboard/-/copy-text-to-clipboard-3.0.1.tgz#8cbf8f90e0a47f12e4a24743736265d157bce69c" @@ -3566,11 +4181,11 @@ copy-webpack-plugin@^11.0.0: serialize-javascript "^6.0.0" core-js-compat@^3.21.0, core-js-compat@^3.22.1, core-js-compat@^3.25.1: - version "3.26.0" - resolved "https://registry.yarnpkg.com/core-js-compat/-/core-js-compat-3.26.0.tgz#94e2cf8ba3e63800c4956ea298a6473bc9d62b44" - integrity sha512-piOX9Go+Z4f9ZiBFLnZ5VrOpBl0h7IGCkiFUN11QTe6LjAvOT3ifL/5TdoizMh99hcGy5SoLyWbapIY/PIb/3A== + version "3.28.0" + resolved "https://registry.yarnpkg.com/core-js-compat/-/core-js-compat-3.28.0.tgz#c08456d854608a7264530a2afa281fadf20ecee6" + integrity sha512-myzPgE7QodMg4nnd3K1TDoES/nADRStM8Gpz0D6nhkwbmwEnE0ZGJgoWsvQ722FR8D7xS0n0LV556RcEicjTyg== dependencies: - browserslist "^4.21.4" + browserslist "^4.21.5" core-js-pure@3.22.5: version "3.22.5" @@ -3578,9 +4193,9 @@ core-js-pure@3.22.5: integrity sha512-8xo9R00iYD7TcV7OrC98GwxiUEAabVWO3dix+uyWjnYrx9fyASLlIX+f/3p5dW5qByaP2bcZ8X/T47s55et/tA== core-js-pure@^3.20.2, core-js-pure@^3.25.1: - version "3.26.0" - resolved "https://registry.yarnpkg.com/core-js-pure/-/core-js-pure-3.26.0.tgz#7ad8a5dd7d910756f3124374b50026e23265ca9a" - integrity sha512-LiN6fylpVBVwT8twhhluD9TzXmZQQsr2I2eIKtWNbZI1XMfBT7CV18itaN6RA7EtQd/SDdRx/wzvAShX2HvhQA== + version "3.28.0" + resolved "https://registry.yarnpkg.com/core-js-pure/-/core-js-pure-3.28.0.tgz#4ef2888475b6c856ef6f5aeef8b4f618b76ad048" + integrity sha512-DSOVleA9/v3LNj/vFxAPfUHttKTzrB2RXhAPvR5TPXn4vrra3Z2ssytvRyt8eruJwAfwAiFADEbrjcRdcvPLQQ== core-js@3.22.5: version "3.22.5" @@ -3588,15 +4203,29 @@ core-js@3.22.5: integrity sha512-VP/xYuvJ0MJWRAobcmQ8F2H6Bsn+s7zqAAjFaHGBMc5AQm7zaelhD1LGduFn2EehEcQcU+br6t+fwbpQ5d1ZWA== core-js@^3.23.3: - version "3.26.0" - resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.26.0.tgz#a516db0ed0811be10eac5d94f3b8463d03faccfe" - integrity sha512-+DkDrhoR4Y0PxDz6rurahuB+I45OsEUv8E1maPTB6OuHRohMMcznBq9TMpdpDMm/hUPob/mJJS3PqgbHpMTQgw== + version "3.28.0" + resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.28.0.tgz#ed8b9e99c273879fdfff0edfc77ee709a5800e4a" + integrity sha512-GiZn9D4Z/rSYvTeg1ljAIsEqFm0LaN9gVtwDCrKL80zHtS31p9BAjmTxVqTQDMpwlMolJZOFntUG2uwyj7DAqw== core-util-is@~1.0.0: version "1.0.3" resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.3.tgz#a6042d3634c2b27e9328f837b965fac83808db85" integrity sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ== +cose-base@^1.0.0: + version "1.0.3" + resolved "https://registry.yarnpkg.com/cose-base/-/cose-base-1.0.3.tgz#650334b41b869578a543358b80cda7e0abe0a60a" + integrity sha512-s9whTXInMSgAp/NVXVNuVxVKzGH2qck3aQlVHxDCdAEPgtMKwc4Wq6/QKhgdEdgbLSi9rBTAcPoRa6JpiG4ksg== + dependencies: + layout-base "^1.0.0" + +cose-base@^2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/cose-base/-/cose-base-2.2.0.tgz#1c395c35b6e10bb83f9769ca8b817d614add5c01" + integrity sha512-AzlgcsCbUMymkADOJtQm3wO9S3ltPfYOFD5033keQn9NJzIbtnZj+UdBJe7DYml/8TdbtHJW3j58SOnKhWY/5g== + dependencies: + layout-base "^2.0.0" + cosmiconfig@^6.0.0: version "6.0.0" resolved "https://registry.yarnpkg.com/cosmiconfig/-/cosmiconfig-6.0.0.tgz#da4fee853c52f6b1e6935f41c1a2fc50bd4a9982" @@ -3609,9 +4238,9 @@ cosmiconfig@^6.0.0: yaml "^1.7.2" cosmiconfig@^7.0.0, cosmiconfig@^7.0.1: - version "7.0.1" - resolved "https://registry.yarnpkg.com/cosmiconfig/-/cosmiconfig-7.0.1.tgz#714d756522cace867867ccb4474c5d01bbae5d6d" - integrity sha512-a1YWNUV2HwGimB7dU2s1wUMurNKjpx60HxBB6xUM8Re+2s1g1IIfJvFR0/iCF+XHdE0GMTKTuLR32UQff4TEyQ== + version "7.1.0" + resolved "https://registry.yarnpkg.com/cosmiconfig/-/cosmiconfig-7.1.0.tgz#1443b9afa596b670082ea46cbd8f6a62b84635f6" + integrity sha512-AdmX6xUzdNASswsFtmwSt7Vj8po9IuqXm0UXz7QKPuEUmPB4XyjGfaAr2PSuELMwkRMVH1EpIkX5bTZGRB3eCA== dependencies: "@types/parse-json" "^4.0.0" import-fresh "^3.2.1" @@ -3635,6 +4264,11 @@ cross-spawn@^7.0.3: shebang-command "^2.0.0" which "^2.0.1" +crypto-js@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/crypto-js/-/crypto-js-4.1.1.tgz#9e485bcf03521041bd85844786b83fb7619736cf" + integrity sha512-o2JlM7ydqd3Qk9CA0L4NL6mTzU2sdx96a+oOfPu8Mkl/PK51vSyoi8/rQ8NknZtk44vq15lmhAj9CIAGwgeWKw== + crypto-random-string@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/crypto-random-string/-/crypto-random-string-2.0.0.tgz#ef2a7a966ec11083388369baa02ebead229b30d5" @@ -3650,7 +4284,7 @@ css-declaration-sorter@^6.3.1: resolved "https://registry.yarnpkg.com/css-declaration-sorter/-/css-declaration-sorter-6.3.1.tgz#be5e1d71b7a992433fb1c542c7a1b835e45682ec" integrity sha512-fBffmak0bPAnyqc/HO8C3n2sHrp9wcqQz6ES9koRF2/mLOVAx9zIQ3Y7R29sYCteTPqMCwns4WYQoCX91Xl3+w== -css-loader@6.7.1, css-loader@^6.7.1: +css-loader@6.7.1: version "6.7.1" resolved "https://registry.yarnpkg.com/css-loader/-/css-loader-6.7.1.tgz#e98106f154f6e1baf3fc3bc455cb9981c1d5fd2e" integrity sha512-yB5CNFa14MbPJcomwNh3wLThtkZgcNyI2bNMRt8iE5Z8Vwl7f8vQXFAzn2HDOJvtDq2NTZBUGMSUNNyrv3/+cw== @@ -3664,6 +4298,20 @@ css-loader@6.7.1, css-loader@^6.7.1: postcss-value-parser "^4.2.0" semver "^7.3.5" +css-loader@^6.7.1: + version "6.7.3" + resolved "https://registry.yarnpkg.com/css-loader/-/css-loader-6.7.3.tgz#1e8799f3ccc5874fdd55461af51137fcc5befbcd" + integrity sha512-qhOH1KlBMnZP8FzRO6YCH9UHXQhVMcEGLyNdb7Hv2cpcmJbW0YrddO+tG1ab5nT41KpHIYGsbeHqxB9xPu1pKQ== + dependencies: + icss-utils "^5.1.0" + postcss "^8.4.19" + postcss-modules-extract-imports "^3.0.0" + postcss-modules-local-by-default "^4.0.0" + postcss-modules-scope "^3.0.0" + postcss-modules-values "^4.0.0" + postcss-value-parser "^4.2.0" + semver "^7.3.8" + css-minimizer-webpack-plugin@3.4.1: version "3.4.1" resolved "https://registry.yarnpkg.com/css-minimizer-webpack-plugin/-/css-minimizer-webpack-plugin-3.4.1.tgz#ab78f781ced9181992fe7b6e4f3422e76429878f" @@ -3756,33 +4404,33 @@ cssnano-preset-advanced@5.3.3: postcss-zindex "^5.1.0" cssnano-preset-advanced@^5.3.8: - version "5.3.9" - resolved "https://registry.yarnpkg.com/cssnano-preset-advanced/-/cssnano-preset-advanced-5.3.9.tgz#99e1cdf81a467a5e6c366cfc6d874a166c4d9a67" - integrity sha512-njnh4pp1xCsibJcEHnWZb4EEzni0ePMqPuPNyuWT4Z+YeXmsgqNuTPIljXFEXhxGsWs9183JkXgHxc1TcsahIg== + version "5.3.10" + resolved "https://registry.yarnpkg.com/cssnano-preset-advanced/-/cssnano-preset-advanced-5.3.10.tgz#25558a1fbf3a871fb6429ce71e41be7f5aca6eef" + integrity sha512-fnYJyCS9jgMU+cmHO1rPSPf9axbQyD7iUhLO5Df6O4G+fKIOMps+ZbU0PdGFejFBBZ3Pftf18fn1eG7MAPUSWQ== dependencies: autoprefixer "^10.4.12" - cssnano-preset-default "^5.2.13" + cssnano-preset-default "^5.2.14" postcss-discard-unused "^5.1.0" postcss-merge-idents "^5.1.1" postcss-reduce-idents "^5.2.0" postcss-zindex "^5.1.0" -cssnano-preset-default@^5.2.13, cssnano-preset-default@^5.2.7: - version "5.2.13" - resolved "https://registry.yarnpkg.com/cssnano-preset-default/-/cssnano-preset-default-5.2.13.tgz#e7353b0c57975d1bdd97ac96e68e5c1b8c68e990" - integrity sha512-PX7sQ4Pb+UtOWuz8A1d+Rbi+WimBIxJTRyBdgGp1J75VU0r/HFQeLnMYgHiCAp6AR4rqrc7Y4R+1Rjk3KJz6DQ== +cssnano-preset-default@^5.2.14, cssnano-preset-default@^5.2.7: + version "5.2.14" + resolved "https://registry.yarnpkg.com/cssnano-preset-default/-/cssnano-preset-default-5.2.14.tgz#309def4f7b7e16d71ab2438052093330d9ab45d8" + integrity sha512-t0SFesj/ZV2OTylqQVOrFgEh5uanxbO6ZAdeCrNsUQ6fVuXwYTxJPNAGvGTxHbD68ldIJNec7PyYZDBrfDQ+6A== dependencies: css-declaration-sorter "^6.3.1" cssnano-utils "^3.1.0" postcss-calc "^8.2.3" - postcss-colormin "^5.3.0" + postcss-colormin "^5.3.1" postcss-convert-values "^5.1.3" postcss-discard-comments "^5.1.2" postcss-discard-duplicates "^5.1.0" postcss-discard-empty "^5.1.1" postcss-discard-overridden "^5.1.0" postcss-merge-longhand "^5.1.7" - postcss-merge-rules "^5.1.3" + postcss-merge-rules "^5.1.4" postcss-minify-font-values "^5.1.0" postcss-minify-gradients "^5.1.1" postcss-minify-params "^5.1.4" @@ -3797,7 +4445,7 @@ cssnano-preset-default@^5.2.13, cssnano-preset-default@^5.2.7: postcss-normalize-url "^5.1.0" postcss-normalize-whitespace "^5.1.1" postcss-ordered-values "^5.1.3" - postcss-reduce-initial "^5.1.1" + postcss-reduce-initial "^5.1.2" postcss-reduce-transforms "^5.1.0" postcss-svgo "^5.1.0" postcss-unique-selectors "^5.1.1" @@ -3817,11 +4465,11 @@ cssnano@5.1.7: yaml "^1.10.2" cssnano@^5.0.6, cssnano@^5.1.12, cssnano@^5.1.8: - version "5.1.14" - resolved "https://registry.yarnpkg.com/cssnano/-/cssnano-5.1.14.tgz#07b0af6da73641276fe5a6d45757702ebae2eb05" - integrity sha512-Oou7ihiTocbKqi0J1bB+TRJIQX5RMR3JghA8hcWSw9mjBLQ5Y3RWqEDoYG3sRNlAbCIXpqMoZGbq5KDR3vdzgw== + version "5.1.15" + resolved "https://registry.yarnpkg.com/cssnano/-/cssnano-5.1.15.tgz#ded66b5480d5127fcb44dac12ea5a983755136bf" + integrity sha512-j+BKgDcLDQA+eDifLx0EO4XSA56b7uut3BQFH+wbSaSTuGLuiyTa/wbRYthUXX8LC9mLg+WWKe8h+qJuwTAbHw== dependencies: - cssnano-preset-default "^5.2.13" + cssnano-preset-default "^5.2.14" lilconfig "^2.0.3" yaml "^1.10.2" @@ -3837,39 +4485,40 @@ csstype@^3.0.2: resolved "https://registry.yarnpkg.com/csstype/-/csstype-3.1.1.tgz#841b532c45c758ee546a11d5bd7b7b473c8c30b9" integrity sha512-DJR/VvkAvSZW9bTouZue2sSxDwdTN92uHjqeKVm+0dAqdfNykRzQ95tay8aXMBAAPpUiq4Qcug2L7neoRh2Egw== -d3-array@1, d3-array@^1.1.1, d3-array@^1.2.0: - version "1.2.4" - resolved "https://registry.yarnpkg.com/d3-array/-/d3-array-1.2.4.tgz#635ce4d5eea759f6f605863dbcfc30edc737f71f" - integrity sha512-KHW6M86R+FUPYGb3R5XiYjXPq7VzwxZ22buHhAEVG5ztoEcZZMLov530mmccaqA1GghZArjQV46fuc8kUqhhHw== +cytoscape-cose-bilkent@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/cytoscape-cose-bilkent/-/cytoscape-cose-bilkent-4.1.0.tgz#762fa121df9930ffeb51a495d87917c570ac209b" + integrity sha512-wgQlVIUJF13Quxiv5e1gstZ08rnZj2XaLHGoFMYXz7SkNfCDOOteKBE6SYRfA9WxxI/iBc3ajfDoc6hb/MRAHQ== + dependencies: + cose-base "^1.0.0" + +cytoscape-fcose@^2.1.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/cytoscape-fcose/-/cytoscape-fcose-2.2.0.tgz#e4d6f6490df4fab58ae9cea9e5c3ab8d7472f471" + integrity sha512-ki1/VuRIHFCzxWNrsshHYPs6L7TvLu3DL+TyIGEsRcvVERmxokbf5Gdk7mFxZnTdiGtnA4cfSmjZJMviqSuZrQ== + dependencies: + cose-base "^2.2.0" + +cytoscape@^3.23.0: + version "3.23.0" + resolved "https://registry.yarnpkg.com/cytoscape/-/cytoscape-3.23.0.tgz#054ee05a6d0aa3b4f139382bbf2f4e5226df3c6d" + integrity sha512-gRZqJj/1kiAVPkrVFvz/GccxsXhF3Qwpptl32gKKypO4IlqnKBjTOu+HbXtEggSGzC5KCaHp3/F7GgENrtsFkA== + dependencies: + heap "^0.2.6" + lodash "^4.17.21" "d3-array@2 - 3", "d3-array@2.10.0 - 3", "d3-array@2.5.0 - 3", d3-array@3, d3-array@^3.2.0: - version "3.2.0" - resolved "https://registry.yarnpkg.com/d3-array/-/d3-array-3.2.0.tgz#15bf96cd9b7333e02eb8de8053d78962eafcff14" - integrity sha512-3yXFQo0oG3QCxbF06rMPFyGRMGJNS7NvsV1+2joOjbBE+9xvWQ8+GcMJAjRCzw06zQ3/arXeJgbPYcjUCuC+3g== + version "3.2.2" + resolved "https://registry.yarnpkg.com/d3-array/-/d3-array-3.2.2.tgz#f8ac4705c5b06914a7e0025bbf8d5f1513f6a86e" + integrity sha512-yEEyEAbDrF8C6Ob2myOBLjwBLck1Z89jMGFee0oPsn95GqjerpaOA4ch+vc2l0FNFFwMD5N7OCSEN5eAlsUbgQ== dependencies: internmap "1 - 2" -d3-axis@1: - version "1.0.12" - resolved "https://registry.yarnpkg.com/d3-axis/-/d3-axis-1.0.12.tgz#cdf20ba210cfbb43795af33756886fb3638daac9" - integrity sha512-ejINPfPSNdGFKEOAtnBtdkpr24c4d4jsei6Lg98mxf424ivoDP2956/5HDpIAtmHo85lqT4pruy+zEgvRUBqaQ== - d3-axis@3: version "3.0.0" resolved "https://registry.yarnpkg.com/d3-axis/-/d3-axis-3.0.0.tgz#c42a4a13e8131d637b745fc2973824cfeaf93322" integrity sha512-IH5tgjV4jE/GhHkRV0HiVYPDtvfjHQlQfJHs0usq7M30XcSBvOotpmH1IgkcXsO/5gEQZD43B//fc7SRT5S+xw== -d3-brush@1: - version "1.1.6" - resolved "https://registry.yarnpkg.com/d3-brush/-/d3-brush-1.1.6.tgz#b0a22c7372cabec128bdddf9bddc058592f89e9b" - integrity sha512-7RW+w7HfMCPyZLifTz/UnJmI5kdkXtpCbombUSs8xniAyo0vIbrDzDwUJB6eJOgl9u5DQOt2TQlYumxzD1SvYA== - dependencies: - d3-dispatch "1" - d3-drag "1" - d3-interpolate "1" - d3-selection "1" - d3-transition "1" - d3-brush@3: version "3.0.0" resolved "https://registry.yarnpkg.com/d3-brush/-/d3-brush-3.0.0.tgz#6f767c4ed8dcb79de7ede3e1c0f89e63ef64d31c" @@ -3881,14 +4530,6 @@ d3-brush@3: d3-selection "3" d3-transition "3" -d3-chord@1: - version "1.0.6" - resolved "https://registry.yarnpkg.com/d3-chord/-/d3-chord-1.0.6.tgz#309157e3f2db2c752f0280fedd35f2067ccbb15f" - integrity sha512-JXA2Dro1Fxw9rJe33Uv+Ckr5IrAa74TlfDEhE/jfLOaXegMQFQTAgAw9WnZL8+HxVBRXaRGCkrNU7pJeylRIuA== - dependencies: - d3-array "1" - d3-path "1" - d3-chord@3: version "3.0.1" resolved "https://registry.yarnpkg.com/d3-chord/-/d3-chord-3.0.1.tgz#d156d61f485fce8327e6abf339cb41d8cbba6966" @@ -3896,32 +4537,15 @@ d3-chord@3: dependencies: d3-path "1 - 3" -d3-collection@1: - version "1.0.7" - resolved "https://registry.yarnpkg.com/d3-collection/-/d3-collection-1.0.7.tgz#349bd2aa9977db071091c13144d5e4f16b5b310e" - integrity sha512-ii0/r5f4sjKNTfh84Di+DpztYwqKhEyUlKoPrzUFfeSkWxjW49xU2QzO9qrPrNkpdI0XJkfzvmTu8V2Zylln6A== - -d3-color@1: - version "1.4.1" - resolved "https://registry.yarnpkg.com/d3-color/-/d3-color-1.4.1.tgz#c52002bf8846ada4424d55d97982fef26eb3bc8a" - integrity sha512-p2sTHSLCJI2QKunbGb7ocOh7DgTAn8IrLx21QRc/BSnodXM4sv6aLQlnfpvehFMLZEfBc6g9pH9SWQccFYfJ9Q== - "d3-color@1 - 3", d3-color@3: version "3.1.0" resolved "https://registry.yarnpkg.com/d3-color/-/d3-color-3.1.0.tgz#395b2833dfac71507f12ac2f7af23bf819de24e2" integrity sha512-zg/chbXyeBtMQ1LbD/WSoW2DpC3I0mpmPdW+ynRTj/x2DAWYrIY7qeZIHidozwV24m4iavr15lNwIwLxRmOxhA== -d3-contour@1: - version "1.3.2" - resolved "https://registry.yarnpkg.com/d3-contour/-/d3-contour-1.3.2.tgz#652aacd500d2264cb3423cee10db69f6f59bead3" - integrity sha512-hoPp4K/rJCu0ladiH6zmJUEz6+u3lgR+GSm/QdM2BBvDraU39Vr7YdDCicJcxP1z8i9B/2dJLgDC1NcvlF8WCg== - dependencies: - d3-array "^1.1.1" - d3-contour@4: - version "4.0.0" - resolved "https://registry.yarnpkg.com/d3-contour/-/d3-contour-4.0.0.tgz#5a1337c6da0d528479acdb5db54bc81a0ff2ec6b" - integrity sha512-7aQo0QHUTu/Ko3cP9YK9yUTxtoDEiDGwnBHyLxG5M4vqlBkO/uixMRele3nfsfj6UXOcuReVpVXzAboGraYIJw== + version "4.0.2" + resolved "https://registry.yarnpkg.com/d3-contour/-/d3-contour-4.0.2.tgz#bb92063bc8c5663acb2422f99c73cbb6c6ae3bcc" + integrity sha512-4EzFTRIikzs47RGmdxbeUvLWtGedDUNkTcmzoeyg4sP/dvCexO47AaQL7VKy/gul85TOxw+IBgA8US2xwbToNA== dependencies: d3-array "^3.2.0" @@ -3932,24 +4556,11 @@ d3-delaunay@6: dependencies: delaunator "5" -d3-dispatch@1: - version "1.0.6" - resolved "https://registry.yarnpkg.com/d3-dispatch/-/d3-dispatch-1.0.6.tgz#00d37bcee4dd8cd97729dd893a0ac29caaba5d58" - integrity sha512-fVjoElzjhCEy+Hbn8KygnmMS7Or0a9sI2UzGwoB7cCtvI1XpVN9GpoYlnb3xt2YV66oXYb1fLJ8GMvP4hdU1RA== - "d3-dispatch@1 - 3", d3-dispatch@3: version "3.0.1" resolved "https://registry.yarnpkg.com/d3-dispatch/-/d3-dispatch-3.0.1.tgz#5fc75284e9c2375c36c839411a0cf550cbfc4d5e" integrity sha512-rzUyPU/S7rwUflMyLc1ETDeBj0NRuHKKAcvukozwhshr6g6c5d8zh4c2gQjY2bZ0dXeGLWc1PF174P2tVvKhfg== -d3-drag@1: - version "1.2.5" - resolved "https://registry.yarnpkg.com/d3-drag/-/d3-drag-1.2.5.tgz#2537f451acd39d31406677b7dc77c82f7d988f70" - integrity sha512-rD1ohlkKQwMZYkQlYVCrSFxsWPzI97+W+PaEIBNTMxRuxz9RF0Hi5nJWHGVJ3Om9d2fRTe1yOBINJyy/ahV95w== - dependencies: - d3-dispatch "1" - d3-selection "1" - "d3-drag@2 - 3", d3-drag@3: version "3.0.0" resolved "https://registry.yarnpkg.com/d3-drag/-/d3-drag-3.0.0.tgz#994aae9cd23c719f53b5e10e3a0a6108c69607ba" @@ -3958,15 +4569,6 @@ d3-drag@1: d3-dispatch "1 - 3" d3-selection "3" -d3-dsv@1: - version "1.2.0" - resolved "https://registry.yarnpkg.com/d3-dsv/-/d3-dsv-1.2.0.tgz#9d5f75c3a5f8abd611f74d3f5847b0d4338b885c" - integrity sha512-9yVlqvZcSOMhCYzniHE7EVUws7Fa1zgw+/EAV2BxJoG3ME19V6BQFBwI855XQDsxyOuG7NibqRMTtiF/Qup46g== - dependencies: - commander "2" - iconv-lite "0.4" - rw "1" - "d3-dsv@1 - 3", d3-dsv@3: version "3.0.1" resolved "https://registry.yarnpkg.com/d3-dsv/-/d3-dsv-3.0.1.tgz#c63af978f4d6a0d084a52a673922be2160789b73" @@ -3976,23 +4578,11 @@ d3-dsv@1: iconv-lite "0.6" rw "1" -d3-ease@1: - version "1.0.7" - resolved "https://registry.yarnpkg.com/d3-ease/-/d3-ease-1.0.7.tgz#9a834890ef8b8ae8c558b2fe55bd57f5993b85e2" - integrity sha512-lx14ZPYkhNx0s/2HX5sLFUI3mbasHjSSpwO/KaaNACweVwxUruKyWVcb293wMv1RqTPZyZ8kSZ2NogUZNcLOFQ== - "d3-ease@1 - 3", d3-ease@3: version "3.0.1" resolved "https://registry.yarnpkg.com/d3-ease/-/d3-ease-3.0.1.tgz#9658ac38a2140d59d346160f1f6c30fda0bd12f4" integrity sha512-wR/XK3D3XcLIZwpbvQwQ5fK+8Ykds1ip7A2Txe0yxncXSdq1L9skcG7blcedkOX+ZcgxGAmLX1FrRGbADwzi0w== -d3-fetch@1: - version "1.2.0" - resolved "https://registry.yarnpkg.com/d3-fetch/-/d3-fetch-1.2.0.tgz#15ce2ecfc41b092b1db50abd2c552c2316cf7fc7" - integrity sha512-yC78NBVcd2zFAyR/HnUiBS7Lf6inSCoWcSxFfw8FYL7ydiqe80SazNwoffcqOfs95XaLo7yebsmQqDKSsXUtvA== - dependencies: - d3-dsv "1" - d3-fetch@3: version "3.0.1" resolved "https://registry.yarnpkg.com/d3-fetch/-/d3-fetch-3.0.1.tgz#83141bff9856a0edb5e38de89cdcfe63d0a60a22" @@ -4000,16 +4590,6 @@ d3-fetch@3: dependencies: d3-dsv "1 - 3" -d3-force@1: - version "1.2.1" - resolved "https://registry.yarnpkg.com/d3-force/-/d3-force-1.2.1.tgz#fd29a5d1ff181c9e7f0669e4bd72bdb0e914ec0b" - integrity sha512-HHvehyaiUlVo5CxBJ0yF/xny4xoaxFxDnBXNvNcfW9adORGZfyNF1dj6DGLKyk4Yh3brP/1h3rnDzdIAwL08zg== - dependencies: - d3-collection "1" - d3-dispatch "1" - d3-quadtree "1" - d3-timer "1" - d3-force@3: version "3.0.0" resolved "https://registry.yarnpkg.com/d3-force/-/d3-force-3.0.0.tgz#3e2ba1a61e70888fe3d9194e30d6d14eece155c4" @@ -4019,47 +4599,23 @@ d3-force@3: d3-quadtree "1 - 3" d3-timer "1 - 3" -d3-format@1: - version "1.4.5" - resolved "https://registry.yarnpkg.com/d3-format/-/d3-format-1.4.5.tgz#374f2ba1320e3717eb74a9356c67daee17a7edb4" - integrity sha512-J0piedu6Z8iB6TbIGfZgDzfXxUFN3qQRMofy2oPdXzQibYGqPB/9iMcxr/TGalU+2RsyDO+U4f33id8tbnSRMQ== - "d3-format@1 - 3", d3-format@3: version "3.1.0" resolved "https://registry.yarnpkg.com/d3-format/-/d3-format-3.1.0.tgz#9260e23a28ea5cb109e93b21a06e24e2ebd55641" integrity sha512-YyUI6AEuY/Wpt8KWLgZHsIU86atmikuoOmCfommt0LYHiQSPjvX2AcFc38PX0CBpr2RCyZhjex+NS/LPOv6YqA== -d3-geo@1: - version "1.12.1" - resolved "https://registry.yarnpkg.com/d3-geo/-/d3-geo-1.12.1.tgz#7fc2ab7414b72e59fbcbd603e80d9adc029b035f" - integrity sha512-XG4d1c/UJSEX9NfU02KwBL6BYPj8YKHxgBEw5om2ZnTRSbIcego6dhHwcxuSR3clxh0EpE38os1DVPOmnYtTPg== - dependencies: - d3-array "1" - d3-geo@3: - version "3.0.1" - resolved "https://registry.yarnpkg.com/d3-geo/-/d3-geo-3.0.1.tgz#4f92362fd8685d93e3b1fae0fd97dc8980b1ed7e" - integrity sha512-Wt23xBych5tSy9IYAM1FR2rWIBFWa52B/oF/GYe5zbdHrg08FU8+BuI6X4PvTwPDdqdAdq04fuWJpELtsaEjeA== + version "3.1.0" + resolved "https://registry.yarnpkg.com/d3-geo/-/d3-geo-3.1.0.tgz#74fd54e1f4cebd5185ac2039217a98d39b0a4c0e" + integrity sha512-JEo5HxXDdDYXCaWdwLRt79y7giK8SbhZJbFWXqbRTolCHFI5jRqteLzCsq51NKbUoX0PjBVSohxrx+NoOUujYA== dependencies: d3-array "2.5.0 - 3" -d3-hierarchy@1: - version "1.1.9" - resolved "https://registry.yarnpkg.com/d3-hierarchy/-/d3-hierarchy-1.1.9.tgz#2f6bee24caaea43f8dc37545fa01628559647a83" - integrity sha512-j8tPxlqh1srJHAtxfvOUwKNYJkQuBFdM1+JAUfq6xqH5eAqf93L7oG1NVqDa4CpFZNvnNKtCYEUC8KY9yEn9lQ== - d3-hierarchy@3: version "3.1.2" resolved "https://registry.yarnpkg.com/d3-hierarchy/-/d3-hierarchy-3.1.2.tgz#b01cd42c1eed3d46db77a5966cf726f8c09160c6" integrity sha512-FX/9frcub54beBdugHjDCdikxThEqjnR93Qt7PvQTOHxyiNCAlvMrHhclk3cD5VeAaq9fxmfRp+CnWw9rEMBuA== -d3-interpolate@1: - version "1.4.0" - resolved "https://registry.yarnpkg.com/d3-interpolate/-/d3-interpolate-1.4.0.tgz#526e79e2d80daa383f9e0c1c1c7dcc0f0583e987" - integrity sha512-V9znK0zc3jOPV4VD2zZn0sDhZU3WAE2bmlxdIwwQPPzPjvyLkd8B3JUVdS1IDUFDkWZ72c9qnv1GK2ZagTZ8EA== - dependencies: - d3-color "1" - "d3-interpolate@1 - 3", "d3-interpolate@1.2.0 - 3", d3-interpolate@3: version "3.0.1" resolved "https://registry.yarnpkg.com/d3-interpolate/-/d3-interpolate-3.0.1.tgz#3c47aa5b32c5b3dfb56ef3fd4342078a632b400d" @@ -4067,54 +4623,26 @@ d3-interpolate@1: dependencies: d3-color "1 - 3" -d3-path@1: - version "1.0.9" - resolved "https://registry.yarnpkg.com/d3-path/-/d3-path-1.0.9.tgz#48c050bb1fe8c262493a8caf5524e3e9591701cf" - integrity sha512-VLaYcn81dtHVTjEHd8B+pbe9yHWpXKZUC87PzoFmsFrJqgFwDe/qxfp5MlfsfM1V5E/iVt0MmEbWQ7FVIXh/bg== - -"d3-path@1 - 3", d3-path@3: - version "3.0.1" - resolved "https://registry.yarnpkg.com/d3-path/-/d3-path-3.0.1.tgz#f09dec0aaffd770b7995f1a399152bf93052321e" - integrity sha512-gq6gZom9AFZby0YLduxT1qmrp4xpBA1YZr19OI717WIdKE2OM5ETq5qrHLb301IgxhLwcuxvGZVLeeWc/k1I6w== - -d3-polygon@1: - version "1.0.6" - resolved "https://registry.yarnpkg.com/d3-polygon/-/d3-polygon-1.0.6.tgz#0bf8cb8180a6dc107f518ddf7975e12abbfbd38e" - integrity sha512-k+RF7WvI08PC8reEoXa/w2nSg5AUMTi+peBD9cmFc+0ixHfbs4QmxxkarVal1IkVkgxVuk9JSHhJURHiyHKAuQ== +"d3-path@1 - 3", d3-path@3, d3-path@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/d3-path/-/d3-path-3.1.0.tgz#22df939032fb5a71ae8b1800d61ddb7851c42526" + integrity sha512-p3KP5HCf/bvjBSSKuXid6Zqijx7wIfNW+J/maPs+iwR35at5JCbLUT0LzF1cnjbCHWhqzQTIN2Jpe8pRebIEFQ== d3-polygon@3: version "3.0.1" resolved "https://registry.yarnpkg.com/d3-polygon/-/d3-polygon-3.0.1.tgz#0b45d3dd1c48a29c8e057e6135693ec80bf16398" integrity sha512-3vbA7vXYwfe1SYhED++fPUQlWSYTTGmFmQiany/gdbiWgU/iEyQzyymwL9SkJjFFuCS4902BSzewVGsHHmHtXg== -d3-quadtree@1: - version "1.0.7" - resolved "https://registry.yarnpkg.com/d3-quadtree/-/d3-quadtree-1.0.7.tgz#ca8b84df7bb53763fe3c2f24bd435137f4e53135" - integrity sha512-RKPAeXnkC59IDGD0Wu5mANy0Q2V28L+fNe65pOCXVdVuTJS3WPKaJlFHer32Rbh9gIo9qMuJXio8ra4+YmIymA== - "d3-quadtree@1 - 3", d3-quadtree@3: version "3.0.1" resolved "https://registry.yarnpkg.com/d3-quadtree/-/d3-quadtree-3.0.1.tgz#6dca3e8be2b393c9a9d514dabbd80a92deef1a4f" integrity sha512-04xDrxQTDTCFwP5H6hRhsRcb9xxv2RzkcsygFzmkSIOJy3PeRJP7sNk3VRIbKXcog561P9oU0/rVH6vDROAgUw== -d3-random@1: - version "1.1.2" - resolved "https://registry.yarnpkg.com/d3-random/-/d3-random-1.1.2.tgz#2833be7c124360bf9e2d3fd4f33847cfe6cab291" - integrity sha512-6AK5BNpIFqP+cx/sreKzNjWbwZQCSUatxq+pPRmFIQaWuoD+NrbVWw7YWpHiXpCQ/NanKdtGDuB+VQcZDaEmYQ== - d3-random@3: version "3.0.1" resolved "https://registry.yarnpkg.com/d3-random/-/d3-random-3.0.1.tgz#d4926378d333d9c0bfd1e6fa0194d30aebaa20f4" integrity sha512-FXMe9GfxTxqd5D6jFsQ+DJ8BJS4E/fT5mqqdjovykEB2oFbTMDVdg1MGFxfQW+FBOGoB++k8swBrgwSHT1cUXQ== -d3-scale-chromatic@1: - version "1.5.0" - resolved "https://registry.yarnpkg.com/d3-scale-chromatic/-/d3-scale-chromatic-1.5.0.tgz#54e333fc78212f439b14641fb55801dd81135a98" - integrity sha512-ACcL46DYImpRFMBcpk9HhtIyC7bTBR4fNOPxwVSl0LfulDAwyiHyPOTqcDG1+t5d4P9W7t/2NAuWu59aKko/cg== - dependencies: - d3-color "1" - d3-interpolate "1" - d3-scale-chromatic@3: version "3.0.0" resolved "https://registry.yarnpkg.com/d3-scale-chromatic/-/d3-scale-chromatic-3.0.0.tgz#15b4ceb8ca2bb0dcb6d1a641ee03d59c3b62376a" @@ -4123,18 +4651,6 @@ d3-scale-chromatic@3: d3-color "1 - 3" d3-interpolate "1 - 3" -d3-scale@2: - version "2.2.2" - resolved "https://registry.yarnpkg.com/d3-scale/-/d3-scale-2.2.2.tgz#4e880e0b2745acaaddd3ede26a9e908a9e17b81f" - integrity sha512-LbeEvGgIb8UMcAa0EATLNX0lelKWGYDQiPdHj+gLblGVhGLyNbaCn3EvrJf0A3Y/uOOU5aD6MTh5ZFCdEwGiCw== - dependencies: - d3-array "^1.2.0" - d3-collection "1" - d3-format "1" - d3-interpolate "1" - d3-time "1" - d3-time-format "2" - d3-scale@4: version "4.0.2" resolved "https://registry.yarnpkg.com/d3-scale/-/d3-scale-4.0.2.tgz#82b38e8e8ff7080764f8dcec77bd4be393689396" @@ -4146,36 +4662,17 @@ d3-scale@4: d3-time "2.1.1 - 3" d3-time-format "2 - 4" -d3-selection@1, d3-selection@^1.1.0: - version "1.4.2" - resolved "https://registry.yarnpkg.com/d3-selection/-/d3-selection-1.4.2.tgz#dcaa49522c0dbf32d6c1858afc26b6094555bc5c" - integrity sha512-SJ0BqYihzOjDnnlfyeHT0e30k0K1+5sR3d5fNueCNeuhZTnGw4M4o8mqJchSwgKMXCNFo+e2VTChiSJ0vYtXkg== - "d3-selection@2 - 3", d3-selection@3: version "3.0.0" resolved "https://registry.yarnpkg.com/d3-selection/-/d3-selection-3.0.0.tgz#c25338207efa72cc5b9bd1458a1a41901f1e1b31" integrity sha512-fmTRWbNMmsmWq6xJV8D19U/gw/bwrHfNXxrIN+HfZgnzqTHp9jOmKMhsTUjXOJnZOdZY9Q28y4yebKzqDKlxlQ== -d3-shape@1: - version "1.3.7" - resolved "https://registry.yarnpkg.com/d3-shape/-/d3-shape-1.3.7.tgz#df63801be07bc986bc54f63789b4fe502992b5d7" - integrity sha512-EUkvKjqPFUAZyOlhY5gzCxCeI0Aep04LwIRpsZ/mLFelJiUfnK56jo5JMDSE7yyP2kLSb6LtF+S5chMk7uqPqw== - dependencies: - d3-path "1" - d3-shape@3: - version "3.1.0" - resolved "https://registry.yarnpkg.com/d3-shape/-/d3-shape-3.1.0.tgz#c8a495652d83ea6f524e482fca57aa3f8bc32556" - integrity sha512-tGDh1Muf8kWjEDT/LswZJ8WF85yDZLvVJpYU9Nq+8+yW1Z5enxrmXOhTArlkaElU+CTn0OTVNli+/i+HP45QEQ== + version "3.2.0" + resolved "https://registry.yarnpkg.com/d3-shape/-/d3-shape-3.2.0.tgz#a1a839cbd9ba45f28674c69d7f855bcf91dfc6a5" + integrity sha512-SaLBuwGm3MOViRq2ABk3eLoxwZELpH6zhl3FbAoJ7Vm1gofKx6El1Ib5z23NUEhF9AsGl7y+dzLe5Cw2AArGTA== dependencies: - d3-path "1 - 3" - -d3-time-format@2: - version "2.3.0" - resolved "https://registry.yarnpkg.com/d3-time-format/-/d3-time-format-2.3.0.tgz#107bdc028667788a8924ba040faf1fbccd5a7850" - integrity sha512-guv6b2H37s2Uq/GefleCDtbe0XZAuy7Wa49VGkPVPMfLL9qObgBST3lEHJBMUp8S7NdLQAGIvr2KXk8Hc98iKQ== - dependencies: - d3-time "1" + d3-path "^3.1.0" "d3-time-format@2 - 4", d3-time-format@4: version "4.1.0" @@ -4184,40 +4681,18 @@ d3-time-format@2: dependencies: d3-time "1 - 3" -d3-time@1: - version "1.1.0" - resolved "https://registry.yarnpkg.com/d3-time/-/d3-time-1.1.0.tgz#b1e19d307dae9c900b7e5b25ffc5dcc249a8a0f1" - integrity sha512-Xh0isrZ5rPYYdqhAVk8VLnMEidhz5aP7htAADH6MfzgmmicPkTo8LhkLxci61/lCB7n7UmE3bN0leRt+qvkLxA== - "d3-time@1 - 3", "d3-time@2.1.1 - 3", d3-time@3: - version "3.0.0" - resolved "https://registry.yarnpkg.com/d3-time/-/d3-time-3.0.0.tgz#65972cb98ae2d4954ef5c932e8704061335d4975" - integrity sha512-zmV3lRnlaLI08y9IMRXSDshQb5Nj77smnfpnd2LrBa/2K281Jijactokeak14QacHs/kKq0AQ121nidNYlarbQ== + version "3.1.0" + resolved "https://registry.yarnpkg.com/d3-time/-/d3-time-3.1.0.tgz#9310db56e992e3c0175e1ef385e545e48a9bb5c7" + integrity sha512-VqKjzBLejbSMT4IgbmVgDjpkYrNWUYJnbCGo874u7MMKIWsILRX+OpX/gTk8MqjpT1A/c6HY2dCA77ZN0lkQ2Q== dependencies: d3-array "2 - 3" -d3-timer@1: - version "1.0.10" - resolved "https://registry.yarnpkg.com/d3-timer/-/d3-timer-1.0.10.tgz#dfe76b8a91748831b13b6d9c793ffbd508dd9de5" - integrity sha512-B1JDm0XDaQC+uvo4DT79H0XmBskgS3l6Ve+1SBCfxgmtIb1AVrPIoqd+nPSv+loMX8szQ0sVUhGngL7D5QPiXw== - "d3-timer@1 - 3", d3-timer@3: version "3.0.1" resolved "https://registry.yarnpkg.com/d3-timer/-/d3-timer-3.0.1.tgz#6284d2a2708285b1abb7e201eda4380af35e63b0" integrity sha512-ndfJ/JxxMd3nw31uyKoY2naivF+r29V+Lc0svZxe1JvvIRmi8hUsrMvdOwgS1o6uBHmiz91geQ0ylPP0aj1VUA== -d3-transition@1: - version "1.3.2" - resolved "https://registry.yarnpkg.com/d3-transition/-/d3-transition-1.3.2.tgz#a98ef2151be8d8600543434c1ca80140ae23b398" - integrity sha512-sc0gRU4PFqZ47lPVHloMn9tlPcv8jxgOQg+0zjhfZXMQuvppjG6YuwdMBE0TuqCZjeJkLecku/l9R0JPcRhaDA== - dependencies: - d3-color "1" - d3-dispatch "1" - d3-ease "1" - d3-interpolate "1" - d3-selection "^1.1.0" - d3-timer "1" - "d3-transition@2 - 3", d3-transition@3: version "3.0.1" resolved "https://registry.yarnpkg.com/d3-transition/-/d3-transition-3.0.1.tgz#6869fdde1448868077fdd5989200cb61b2a1645f" @@ -4229,22 +4704,6 @@ d3-transition@1: d3-interpolate "1 - 3" d3-timer "1 - 3" -d3-voronoi@1: - version "1.1.4" - resolved "https://registry.yarnpkg.com/d3-voronoi/-/d3-voronoi-1.1.4.tgz#dd3c78d7653d2bb359284ae478645d95944c8297" - integrity sha512-dArJ32hchFsrQ8uMiTBLq256MpnZjeuBtdHpaDlYuQyjU0CVzCJl/BVW+SkszaAeH95D/8gxqAhgx0ouAWAfRg== - -d3-zoom@1: - version "1.8.3" - resolved "https://registry.yarnpkg.com/d3-zoom/-/d3-zoom-1.8.3.tgz#b6a3dbe738c7763121cd05b8a7795ffe17f4fc0a" - integrity sha512-VoLXTK4wvy1a0JpH2Il+F2CiOhVu7VRXWF5M/LroMIh3/zBAC3WAt7QoIvPibOavVo20hN6/37vwAsdBejLyKQ== - dependencies: - d3-dispatch "1" - d3-drag "1" - d3-interpolate "1" - d3-selection "1" - d3-transition "1" - d3-zoom@3: version "3.0.0" resolved "https://registry.yarnpkg.com/d3-zoom/-/d3-zoom-3.0.0.tgz#d13f4165c73217ffeaa54295cd6969b3e7aee8f3" @@ -4256,47 +4715,10 @@ d3-zoom@3: d3-selection "2 - 3" d3-transition "2 - 3" -d3@^5.14: - version "5.16.0" - resolved "https://registry.yarnpkg.com/d3/-/d3-5.16.0.tgz#9c5e8d3b56403c79d4ed42fbd62f6113f199c877" - integrity sha512-4PL5hHaHwX4m7Zr1UapXW23apo6pexCgdetdJ5kTmADpG/7T9Gkxw0M0tf/pjoB63ezCCm0u5UaFYy2aMt0Mcw== - dependencies: - d3-array "1" - d3-axis "1" - d3-brush "1" - d3-chord "1" - d3-collection "1" - d3-color "1" - d3-contour "1" - d3-dispatch "1" - d3-drag "1" - d3-dsv "1" - d3-ease "1" - d3-fetch "1" - d3-force "1" - d3-format "1" - d3-geo "1" - d3-hierarchy "1" - d3-interpolate "1" - d3-path "1" - d3-polygon "1" - d3-quadtree "1" - d3-random "1" - d3-scale "2" - d3-scale-chromatic "1" - d3-selection "1" - d3-shape "1" - d3-time "1" - d3-time-format "2" - d3-timer "1" - d3-transition "1" - d3-voronoi "1" - d3-zoom "1" - -d3@^7.0.0: - version "7.6.1" - resolved "https://registry.yarnpkg.com/d3/-/d3-7.6.1.tgz#b21af9563485ed472802f8c611cc43be6c37c40c" - integrity sha512-txMTdIHFbcpLx+8a0IFhZsbp+PfBBPt8yfbmukZTQFroKuFqIwqswF0qE5JXWefylaAVpSXFoKm3yP+jpNLFLw== +d3@^7.0.0, d3@^7.8.2: + version "7.8.2" + resolved "https://registry.yarnpkg.com/d3/-/d3-7.8.2.tgz#2bdb3c178d095ae03b107a18837ae049838e372d" + integrity sha512-WXty7qOGSHb7HR7CfOzwN1Gw04MUOzN8qh9ZUsvwycIMb4DYMpY9xczZ6jUorGtO6bR9BPMPaueIKwiDxu9uiQ== dependencies: d3-array "3" d3-axis "3" @@ -4329,23 +4751,13 @@ d3@^7.0.0: d3-transition "3" d3-zoom "3" -dagre-d3@^0.6.4: - version "0.6.4" - resolved "https://registry.yarnpkg.com/dagre-d3/-/dagre-d3-0.6.4.tgz#0728d5ce7f177ca2337df141ceb60fbe6eeb7b29" - integrity sha512-e/6jXeCP7/ptlAM48clmX4xTZc5Ek6T6kagS7Oz2HrYSdqcLZFLqpAfh7ldbZRFfxCZVyh61NEPR08UQRVxJzQ== +dagre-d3-es@7.0.8: + version "7.0.8" + resolved "https://registry.yarnpkg.com/dagre-d3-es/-/dagre-d3-es-7.0.8.tgz#14c309c3c08ba8329a7cf51000bd56a369c513d1" + integrity sha512-eykdoYQ4FwCJinEYS0gPL2f2w+BPbSLvnQSJ3Ye1vAoPjdkq6xIMKBv+UkICd3qZE26wBKIn3p+6n0QC7R1LyA== dependencies: - d3 "^5.14" - dagre "^0.8.5" - graphlib "^2.1.8" - lodash "^4.17.15" - -dagre@^0.8.5: - version "0.8.5" - resolved "https://registry.yarnpkg.com/dagre/-/dagre-0.8.5.tgz#ba30b0055dac12b6c1fcc247817442777d06afee" - integrity sha512-/aTqmnRta7x7MCCpExk7HQL2O4owCT2h8NT//9I1OQ9vt29Pa0BzSAkR5lwFUcQ7491yVi/3CXU9jQ5o0Mn2Sw== - dependencies: - graphlib "^2.1.8" - lodash "^4.17.15" + d3 "^7.8.2" + lodash-es "^4.17.21" debug@2.6.9, debug@^2.6.0: version "2.6.9" @@ -4354,13 +4766,25 @@ debug@2.6.9, debug@^2.6.0: dependencies: ms "2.0.0" -debug@4, debug@^4.1.0, debug@^4.1.1: +debug@4, debug@^4.0.0, debug@^4.1.0, debug@^4.1.1, debug@^4.3.4: version "4.3.4" resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.4.tgz#1319f6579357f2338d3337d2cdd4914bb5dcc865" integrity sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ== dependencies: ms "2.1.2" +decamelize@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290" + integrity sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA== + +decode-named-character-reference@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/decode-named-character-reference/-/decode-named-character-reference-1.0.2.tgz#daabac9690874c394c81e4162a0304b35d824f0e" + integrity sha512-O8x12RzrUF8xyVcY0KJowWsmaJxQbmy0/EtnNtHRpsOcT7dFk5W598coHqBVpmWo1oQQfsCqfCmkZN5DJrZVdg== + dependencies: + character-entities "^2.0.0" + decompress-response@^3.3.0: version "3.3.0" resolved "https://registry.yarnpkg.com/decompress-response/-/decompress-response-3.3.0.tgz#80a4dd323748384bfa248083622aedec982adff3" @@ -4374,9 +4798,9 @@ deep-extend@^0.6.0: integrity sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA== deepmerge@^4.2.2: - version "4.2.2" - resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.2.2.tgz#44d2ea3679b8f4d4ffba33f03d865fc1e7bf4955" - integrity sha512-FJ3UgI4gIl+PHZm53knsuSFpE+nESMr7M4v9QcgB7S63Kj/6WqMiFQJpBBYz1Pt+66bZpP3Q7Lye0Oo9MPKEdg== + version "4.3.0" + resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.3.0.tgz#65491893ec47756d44719ae520e0e2609233b59b" + integrity sha512-z2wJZXrmeHdvYJp/Ux55wIjqo81G5Bp4c+oELTW+7ar6SogWHajt5a9gO3s3IDaGSAXjDk0vlQKN3rms8ab3og== default-gateway@^6.0.3: version "6.0.3" @@ -4396,9 +4820,9 @@ define-lazy-prop@^2.0.0: integrity sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og== define-properties@^1.1.4: - version "1.1.4" - resolved "https://registry.yarnpkg.com/define-properties/-/define-properties-1.1.4.tgz#0b14d7bd7fbeb2f3572c3a7eda80ea5d57fb05b1" - integrity sha512-uckOqKcfaVvtBdsVkdPv3XjveQJsNQqmhXgRi8uhvWWuPYZCNlzT8qAyblUgNoXdHdjMTzAqeGjAoli8f+bzPA== + version "1.2.0" + resolved "https://registry.yarnpkg.com/define-properties/-/define-properties-1.2.0.tgz#52988570670c9eacedd8064f4a990f2405849bd5" + integrity sha512-xvqAVKGfT1+UAvPwKTVw/njhdQ8ZhXK4lI0bCIuCMrp2up9nPnaDftrLtmpTazqd1o+UY4zgzU+avtMbDP+ldA== dependencies: has-property-descriptors "^1.0.0" object-keys "^1.1.1" @@ -4429,6 +4853,11 @@ delaunator@5: dependencies: robust-predicates "^3.0.0" +delayed-stream@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619" + integrity sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ== + depd@2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/depd/-/depd-2.0.0.tgz#b696163cc757560d09cf22cc8fad1571b79e76df" @@ -4439,6 +4868,11 @@ depd@~1.1.2: resolved "https://registry.yarnpkg.com/depd/-/depd-1.1.2.tgz#9bcd52e14c097763e749b274c4346ed2e560b5a9" integrity sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ== +dequal@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/dequal/-/dequal-2.0.3.tgz#2644214f1997d39ed0ee0ece72335490a7ac67be" + integrity sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA== + destroy@1.2.0: version "1.2.0" resolved "https://registry.yarnpkg.com/destroy/-/destroy-1.2.0.tgz#4803735509ad8be552934c67df614f94e66fa015" @@ -4481,11 +4915,24 @@ detective@^5.2.1: defined "^1.0.0" minimist "^1.2.6" +dezalgo@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/dezalgo/-/dezalgo-1.0.4.tgz#751235260469084c132157dfa857f386d4c33d81" + integrity sha512-rXSP0bf+5n0Qonsb+SVVfNfIsimO4HEtmnIpPHY8Q1UCzKlQrDMfdobr8nJOOsRgWCyMRqeSBQzmWUMq7zvVig== + dependencies: + asap "^2.0.0" + wrappy "1" + didyoumean@^1.2.2: version "1.2.2" resolved "https://registry.yarnpkg.com/didyoumean/-/didyoumean-1.2.2.tgz#989346ffe9e839b4555ecf5666edea0d3e8ad037" integrity sha512-gxtyfqMg7GKyhQmb056K7M3xszy/myH8w+B4RT+QXBQsvAOdc3XymqDDPHx1BgPgsdAA5SIifona89YtRATDzw== +diff@^5.0.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/diff/-/diff-5.1.0.tgz#bc52d298c5ea8df9194800224445ed43ffc87e40" + integrity sha512-D+mk+qE8VC/PAUrlAU34N+VfXev0ghe5ywmpqrawphmVZc1bEfn56uo9qpyGp1p4xpzOHkSW4ztBd6L7Xx4ACw== + dir-glob@^3.0.1: version "3.0.1" resolved "https://registry.yarnpkg.com/dir-glob/-/dir-glob-3.0.1.tgz#56dbf73d992a4a93ba1584f4534063fd2e41717f" @@ -4524,11 +4971,67 @@ docusaurus-plugin-image-zoom@^0.1.1: dependencies: medium-zoom "^1.0.6" +docusaurus-plugin-openapi-docs@1.5.2, docusaurus-plugin-openapi-docs@^1.5.2: + version "1.5.2" + resolved "https://registry.yarnpkg.com/docusaurus-plugin-openapi-docs/-/docusaurus-plugin-openapi-docs-1.5.2.tgz#02ba9ba6821e99e135963042183a5b2dedc52e02" + integrity sha512-fec3tEucAKYYskSEUOmQOte43wm57O4W0zRFN9ebktVuenddtM0fz9YQRb5EILOqHXYybjvvYyl1fLH/3CnnbA== + dependencies: + "@apidevtools/json-schema-ref-parser" "^9.0.9" + "@docusaurus/mdx-loader" "^2.0.1" + "@docusaurus/plugin-content-docs" "^2.0.1" + "@docusaurus/utils" "^2.0.1" + "@docusaurus/utils-validation" "^2.0.1" + "@paloaltonetworks/openapi-to-postmanv2" "3.1.0-hotfix.1" + "@paloaltonetworks/postman-collection" "^4.1.0" + "@redocly/openapi-core" "^1.0.0-beta.103" + chalk "^4.1.2" + clsx "^1.1.1" + fs-extra "^9.0.1" + js-yaml "^4.1.0" + json-pointer "^0.6.2" + json-refs "^3.0.15" + json-schema-merge-allof "^0.8.1" + lodash "^4.17.20" + mustache "^4.2.0" + slugify "^1.6.5" + swagger2openapi "^7.0.8" + url-template "^3.0.0" + webpack "^5.61.0" + xml-formatter "^2.6.1" + docusaurus-plugin-plausible@^0.0.5: version "0.0.5" resolved "https://registry.yarnpkg.com/docusaurus-plugin-plausible/-/docusaurus-plugin-plausible-0.0.5.tgz#d113f7d82c09a3945e88227265b599ba1904bfb9" integrity sha512-8wiglvMjkGjhGUnBYgJM87V1Ip0wr8AbIHiC5YHNar3DOfXX+JL0nBoThlnvaX1ib/emraWgimR5QiMDOgMJjA== +docusaurus-theme-openapi-docs@1.5.2: + version "1.5.2" + resolved "https://registry.yarnpkg.com/docusaurus-theme-openapi-docs/-/docusaurus-theme-openapi-docs-1.5.2.tgz#8dc0cd91fc9792aec598fc61b707dcfdfd65eb92" + integrity sha512-4cUhn+ukltJTXv4bbnSzE9GgaUYWcDCR/ZHwXzcv7Q4oKFtSmVJL6qleeVL1vSYTc8ocGbq2mY1TMIwKeokTuA== + dependencies: + "@docusaurus/theme-common" "^2.0.1" + "@mdx-js/react" "^1.6.21" + "@paloaltonetworks/postman-code-generators" "^1.1.12" + "@paloaltonetworks/postman-collection" "^4.1.0" + "@reduxjs/toolkit" "^1.7.1" + buffer "^6.0.3" + clsx "^1.1.1" + crypto-js "^4.1.1" + docusaurus-plugin-openapi-docs "^1.5.2" + file-saver "^2.0.5" + immer "^9.0.7" + lodash "^4.17.20" + process "^0.11.10" + react-live "^3.1.1" + react-magic-dropzone "^1.0.1" + react-markdown "^8.0.1" + react-modal "^3.15.1" + react-redux "^7.2.0" + redux-devtools-extension "^2.13.8" + rehype-raw "^6.1.1" + webpack "^5.61.0" + xml-formatter "^2.6.1" + dom-converter@^0.2.0: version "0.2.0" resolved "https://registry.yarnpkg.com/dom-converter/-/dom-converter-0.2.0.tgz#6721a9daee2e293682955b6afe416771627bb768" @@ -4601,10 +5104,10 @@ domhandler@^5.0.1, domhandler@^5.0.2, domhandler@^5.0.3: dependencies: domelementtype "^2.3.0" -dompurify@2.3.8: - version "2.3.8" - resolved "https://registry.yarnpkg.com/dompurify/-/dompurify-2.3.8.tgz#224fe9ae57d7ebd9a1ae1ac18c1c1ca3f532226f" - integrity sha512-eVhaWoVibIzqdGYjwsBWodIQIaXFSB+cKDf4cfxLMsK0xiud6SE+/WCVx/Xw/UwQsa4cS3T2eITcdtmTg2UKcw== +dompurify@2.4.3: + version "2.4.3" + resolved "https://registry.yarnpkg.com/dompurify/-/dompurify-2.4.3.tgz#f4133af0e6a50297fc8874e2eaedc13a3c308c03" + integrity sha512-q6QaLcakcRjebxjg8/+NP+h0rPfatOgOzc46Fst9VAA3jF2ApfKBNKMzdP4DYTqtUMXSCd5pRS/8Po/OmoCHZQ== domutils@1.5.1: version "1.5.1" @@ -4675,10 +5178,15 @@ ee-first@1.1.1: resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d" integrity sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow== -electron-to-chromium@^1.4.251: - version "1.4.284" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.284.tgz#61046d1e4cab3a25238f6bf7413795270f125592" - integrity sha512-M8WEXFuKXMYMVr45fo8mq0wUrrJHheiKZf6BArTKk9ZBYCKJEOU5H8cdWgDT+qCVZf7Na4lVUaZsA+h6uA9+PA== +electron-to-chromium@^1.4.284: + version "1.4.306" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.306.tgz#3f16bc14e150ad79803145fffeaf0bee15d3fca7" + integrity sha512-1zGmLFfpcs2v7ELt/1HgLZF6Gm2CCHaAdNKxd9Ge4INSU/HDYWjs7fcWU6eVMmhkpwmh+52ZrGCUU+Ji9OJihA== + +elkjs@^0.8.2: + version "0.8.2" + resolved "https://registry.yarnpkg.com/elkjs/-/elkjs-0.8.2.tgz#c37763c5a3e24e042e318455e0147c912a7c248e" + integrity sha512-L6uRgvZTH+4OF5NE/MBbzQx/WYpru1xCBE9respNj6qznEewGUIfhzmm7horWWxbNO2M0WckQypGctR8lH79xQ== emoji-regex@^8.0.0: version "8.0.0" @@ -4721,9 +5229,9 @@ enhanced-resolve@5.9.3: tapable "^2.2.0" enhanced-resolve@^5.10.0: - version "5.10.0" - resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.10.0.tgz#0dc579c3bb2a1032e357ac45b8f3a6f3ad4fb1e6" - integrity sha512-T0yTFjdpldGY8PmuXXR0PyQ1ufZpEGiHVrp7zHKB7jdR4qlmZHhONVM5AQOAWXuF/w3dnHbEQVrNptJgt7F+cQ== + version "5.12.0" + resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.12.0.tgz#300e1c90228f5b570c4d35babf263f6da7155634" + integrity sha512-QHTXI/sZQmko1cbDoNAa3mJ5qhWUUNAq3vR0/YiD379fWQrcfuoX1+HW2S0MTt7XmoPLapdaDKUtelUSPic7hQ== dependencies: graceful-fs "^4.2.4" tapable "^2.2.0" @@ -4760,6 +5268,11 @@ es-module-lexer@^0.9.0: resolved "https://registry.yarnpkg.com/es-module-lexer/-/es-module-lexer-0.9.3.tgz#6f13db00cc38417137daf74366f535c8eb438f19" integrity sha512-1HQ2M2sPtxwnvOvT1ZClHyQDiggdNjURWpY2we6aMKCQiUVxTmVs2UYPLIrD84sS+kMdUwfBSylbJPwNnBrnHQ== +es6-promise@^3.2.1: + version "3.3.1" + resolved "https://registry.yarnpkg.com/es6-promise/-/es6-promise-3.3.1.tgz#a08cdde84ccdbf34d027a1451bc91d4bcd28a613" + integrity sha512-SOp9Phqvqn7jtEUxPWdWfWoLmyt2VaJ6MpvP9Comy1MceMXqE6bxvaTu4iaxpYYPzhny28Lc+M87/c2cPK6lDg== + escalade@^3.1.1: version "3.1.1" resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.1.1.tgz#d8cfdc7000965c5a0174b4a82eaa5c0552742e40" @@ -4821,9 +5334,14 @@ esutils@^2.0.2: integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g== eta@^1.12.3: - version "1.12.3" - resolved "https://registry.yarnpkg.com/eta/-/eta-1.12.3.tgz#2982d08adfbef39f9fa50e2fbd42d7337e7338b1" - integrity sha512-qHixwbDLtekO/d51Yr4glcaUJCIjGVJyTzuqV4GPlgZo1YpgOKG+avQynErZIYrfM6JIJdtiG2Kox8tbb+DoGg== + version "1.14.2" + resolved "https://registry.yarnpkg.com/eta/-/eta-1.14.2.tgz#5e6181a26ec13d8444c559ce51f7b3090cebbdd1" + integrity sha512-wZmJAV7EFUG5W8XNXSazIdichnWEhGB1OWg4tnXWPj0CPNUcFdgorGNO6N9p6WBUgoUe4P0OziJYn1+6zxP2aQ== + +eta@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/eta/-/eta-2.0.0.tgz#376865fadebc899e5b6dfce82fae64cbbe47e594" + integrity sha512-NqE7S2VmVwgMS8yBxsH4VgNQjNjLq1gfGU0u9I6Cjh468nPRMoDfGdK9n1p/3Dvsw3ebklDkZsFAnKJ9sefjBA== etag@~1.8.1: version "1.8.1" @@ -4863,6 +5381,11 @@ execa@^5.0.0: signal-exit "^3.0.3" strip-final-newline "^2.0.0" +exenv@^1.2.0: + version "1.2.2" + resolved "https://registry.yarnpkg.com/exenv/-/exenv-1.2.2.tgz#2ae78e85d9894158670b03d47bec1f03bd91bb9d" + integrity sha512-Z+ktTxTwv9ILfgKCk32OX3n/doe+OcLTRtqK9pcL+JsP3J1/VW8Uvl4ZjLlKqeW4rzK4oesDOGMEMRIZqtP4Iw== + express@4.18.1: version "4.18.1" resolved "https://registry.yarnpkg.com/express/-/express-4.18.1.tgz#7797de8b9c72c857b9cd0e14a5eea80666267caf" @@ -4970,6 +5493,11 @@ fast-json-stable-stringify@^2.0.0: resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633" integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== +fast-safe-stringify@^2.0.7, fast-safe-stringify@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/fast-safe-stringify/-/fast-safe-stringify-2.1.1.tgz#c406a83b6e70d9e35ce3b30a81141df30aeba884" + integrity sha512-W+KJc2dmILlPplD/H4K9l9LcAHAfPtP6BY84uVLXQ6Evcz9Lcg33Y2z1IVblT6xdY54PXYVHEv+0Wpq8Io6zkA== + fast-url-parser@1.1.3: version "1.1.3" resolved "https://registry.yarnpkg.com/fast-url-parser/-/fast-url-parser-1.1.3.tgz#f4af3ea9f34d8a271cf58ad2b3759f431f0b318d" @@ -4978,9 +5506,9 @@ fast-url-parser@1.1.3: punycode "^1.3.2" fastq@^1.6.0: - version "1.13.0" - resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.13.0.tgz#616760f88a7526bdfc596b7cab8c18938c36b98c" - integrity sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw== + version "1.15.0" + resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.15.0.tgz#d04d07c6a2a68fe4599fea8d2e103a937fae6b3a" + integrity sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw== dependencies: reusify "^1.0.4" @@ -5031,6 +5559,16 @@ file-loader@^6.2.0: loader-utils "^2.0.0" schema-utils "^3.0.0" +file-saver@^2.0.5: + version "2.0.5" + resolved "https://registry.yarnpkg.com/file-saver/-/file-saver-2.0.5.tgz#d61cfe2ce059f414d899e9dd6d4107ee25670c38" + integrity sha512-P9bmyZ3h/PRG+Nzga+rbdI4OEpNDzAVyy74uVO9ATgzLK6VtAsYybF/+TOCvrc0MO793d6+42lLyZTw7/ArVzA== + +file-type@3.9.0: + version "3.9.0" + resolved "https://registry.yarnpkg.com/file-type/-/file-type-3.9.0.tgz#257a078384d1db8087bc449d107d52a52672b9e9" + integrity sha512-RLoqTXE8/vPmMuTI88DAzhMYC99I8BWv7zYP4A1puo5HIjEJ5EX48ighy4ZyKMG9EDXxBgW6e++cn7d1xuFghA== + filesize@^8.0.6: version "8.0.7" resolved "https://registry.yarnpkg.com/filesize/-/filesize-8.0.7.tgz#695e70d80f4e47012c132d57a059e80c6b580bd8" @@ -5072,7 +5610,7 @@ find-up@^3.0.0: dependencies: locate-path "^3.0.0" -find-up@^4.0.0: +find-up@^4.0.0, find-up@^4.1.0: version "4.1.0" resolved "https://registry.yarnpkg.com/find-up/-/find-up-4.1.0.tgz#97afe7d6cdc0bc5928584b7c8d7b16e8a9aa5d19" integrity sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw== @@ -5106,6 +5644,11 @@ follow-redirects@^1.0.0, follow-redirects@^1.14.7: resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.2.tgz#b460864144ba63f2681096f274c4e57026da2c13" integrity sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA== +foreach@^2.0.4: + version "2.0.6" + resolved "https://registry.yarnpkg.com/foreach/-/foreach-2.0.6.tgz#87bcc8a1a0e74000ff2bf9802110708cfb02eb6e" + integrity sha512-k6GAGDyqLe9JaebCsFCoudPPWfihKu8pylYXRlqP1J7ms39iPoTtk2fviNglIeQEwdh0bQeKJ01ZPyuyQvKzwg== + fork-ts-checker-webpack-plugin@^6.5.0: version "6.5.2" resolved "https://registry.yarnpkg.com/fork-ts-checker-webpack-plugin/-/fork-ts-checker-webpack-plugin-6.5.2.tgz#4f67183f2f9eb8ba7df7177ce3cf3e75cdafb340" @@ -5125,6 +5668,25 @@ fork-ts-checker-webpack-plugin@^6.5.0: semver "^7.3.2" tapable "^1.0.0" +form-data@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/form-data/-/form-data-4.0.0.tgz#93919daeaf361ee529584b9b31664dc12c9fa452" + integrity sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww== + dependencies: + asynckit "^0.4.0" + combined-stream "^1.0.8" + mime-types "^2.1.12" + +formidable@^2.0.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/formidable/-/formidable-2.1.1.tgz#81269cbea1a613240049f5f61a9d97731517414f" + integrity sha512-0EcS9wCFEzLvfiks7omJ+SiYJAiD+TzK4Pcw1UlUoGnhUxDcMKjt0P7x8wEb0u6OHu8Nb98WG3nxtlF5C7bvUQ== + dependencies: + dezalgo "^1.0.4" + hexoid "^1.0.0" + once "^1.4.0" + qs "^6.11.0" + forwarded@0.2.0: version "0.2.0" resolved "https://registry.yarnpkg.com/forwarded/-/forwarded-0.2.0.tgz#2269936428aad4c15c7ebe9779a84bf0b2a81811" @@ -5149,7 +5711,7 @@ fs-extra@^10.1.0: jsonfile "^6.0.1" universalify "^2.0.0" -fs-extra@^9.0.0: +fs-extra@^9.0.0, fs-extra@^9.0.1: version "9.1.0" resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-9.1.0.tgz#5954460c764a8da2094ba3554bf839e6b9a7c86d" integrity sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ== @@ -5184,10 +5746,15 @@ gensync@^1.0.0-beta.1, gensync@^1.0.0-beta.2: resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0" integrity sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg== +get-caller-file@^2.0.1, get-caller-file@^2.0.5: + version "2.0.5" + resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e" + integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg== + get-intrinsic@^1.0.2, get-intrinsic@^1.1.1: - version "1.1.3" - resolved "https://registry.yarnpkg.com/get-intrinsic/-/get-intrinsic-1.1.3.tgz#063c84329ad93e83893c7f4f243ef63ffa351385" - integrity sha512-QJVz1Tj7MS099PevUG5jvnt9tSkXN8K14dxQlikJuPt4uD9hHAHjLyLBiLR5zELelBdD9QNRAXZzsJx0WaDL9A== + version "1.2.0" + resolved "https://registry.yarnpkg.com/get-intrinsic/-/get-intrinsic-1.2.0.tgz#7ad1dc0535f3a2904bba075772763e5051f6d05f" + integrity sha512-L049y6nFOuom5wGyRc3/gdTLO94dySVKRACj1RmJZBQXlbTMhtNIgkWkUHq+jYmZvKf14EW1EoJnnjbmoHij0Q== dependencies: function-bind "^1.1.1" has "^1.0.3" @@ -5241,6 +5808,18 @@ glob-to-regexp@^0.4.1: resolved "https://registry.yarnpkg.com/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz#c75297087c851b9a578bd217dd59a92f59fe546e" integrity sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw== +glob@7.1.6: + version "7.1.6" + resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.6.tgz#141f33b81a7c2492e125594307480c46679278a6" + integrity sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA== + dependencies: + fs.realpath "^1.0.0" + inflight "^1.0.4" + inherits "2" + minimatch "^3.0.4" + once "^1.3.0" + path-is-absolute "^1.0.0" + glob@^7.0.0, glob@^7.1.3, glob@^7.1.6: version "7.2.3" resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" @@ -5254,9 +5833,9 @@ glob@^7.0.0, glob@^7.1.3, glob@^7.1.6: path-is-absolute "^1.0.0" global-dirs@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/global-dirs/-/global-dirs-3.0.0.tgz#70a76fe84ea315ab37b1f5576cbde7d48ef72686" - integrity sha512-v8ho2DS5RiCjftj1nD9NmnfaOzTdud7RRnVd9kFNOjqZbISlx5DQ+OrTkywgd0dIt7oFCvKetZSHoHcP3sDdiA== + version "3.0.1" + resolved "https://registry.yarnpkg.com/global-dirs/-/global-dirs-3.0.1.tgz#0c488971f066baceda21447aecb1a8b911d22485" + integrity sha512-NBcGGFbBA9s1VzD41QXDG+3++t9Mn5t1FpLdhESY6oKY4gYTFpX4wO3sqGUa0Srjtbfj3szX0RnemmrVRUdULA== dependencies: ini "2.0.0" @@ -5306,9 +5885,9 @@ globby@^12.0.2: slash "^4.0.0" globby@^13.1.1: - version "13.1.2" - resolved "https://registry.yarnpkg.com/globby/-/globby-13.1.2.tgz#29047105582427ab6eca4f905200667b056da515" - integrity sha512-LKSDZXToac40u8Q1PQtZihbNdTYSNMuWe+K5l+oa6KgDzSvVrHXlJy40hUP522RjAIoNLJYBJi7ow+rbFpIhHQ== + version "13.1.3" + resolved "https://registry.yarnpkg.com/globby/-/globby-13.1.3.tgz#f62baf5720bcb2c1330c8d4ef222ee12318563ff" + integrity sha512-8krCNHXvlCgHDpegPzleMq07yMYTO2sXKASmZmquEYWEmCx6J5UTRbp5RwMJkTJGtcQ44YpiUYUiN0b9mzy8Bw== dependencies: dir-glob "^3.0.1" fast-glob "^3.2.11" @@ -5426,11 +6005,31 @@ hast-util-from-parse5@^6.0.0: vfile-location "^3.2.0" web-namespaces "^1.0.0" +hast-util-from-parse5@^7.0.0: + version "7.1.2" + resolved "https://registry.yarnpkg.com/hast-util-from-parse5/-/hast-util-from-parse5-7.1.2.tgz#aecfef73e3ceafdfa4550716443e4eb7b02e22b0" + integrity sha512-Nz7FfPBuljzsN3tCQ4kCBKqdNhQE2l0Tn+X1ubgKBPRoiDIu1mL08Cfw4k7q71+Duyaw7DXDN+VTAp4Vh3oCOw== + dependencies: + "@types/hast" "^2.0.0" + "@types/unist" "^2.0.0" + hastscript "^7.0.0" + property-information "^6.0.0" + vfile "^5.0.0" + vfile-location "^4.0.0" + web-namespaces "^2.0.0" + hast-util-parse-selector@^2.0.0: version "2.2.5" resolved "https://registry.yarnpkg.com/hast-util-parse-selector/-/hast-util-parse-selector-2.2.5.tgz#d57c23f4da16ae3c63b3b6ca4616683313499c3a" integrity sha512-7j6mrk/qqkSehsM92wQjdIgWM2/BW61u/53G6xmC8i1OmEdKLHbk419QKQUjz6LglWsfqoiHmyMRkP1BGjecNQ== +hast-util-parse-selector@^3.0.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/hast-util-parse-selector/-/hast-util-parse-selector-3.1.1.tgz#25ab00ae9e75cbc62cf7a901f68a247eade659e2" + integrity sha512-jdlwBjEexy1oGz0aJ2f4GKMaVKkA9jwjr4MjAAI22E5fM/TXVZHuS5OpONtdeIkRKqAaryQ2E9xNQxijoThSZA== + dependencies: + "@types/hast" "^2.0.0" + hast-util-raw@6.0.1: version "6.0.1" resolved "https://registry.yarnpkg.com/hast-util-raw/-/hast-util-raw-6.0.1.tgz#973b15930b7529a7b66984c98148b46526885977" @@ -5447,6 +6046,23 @@ hast-util-raw@6.0.1: xtend "^4.0.0" zwitch "^1.0.0" +hast-util-raw@^7.2.0: + version "7.2.3" + resolved "https://registry.yarnpkg.com/hast-util-raw/-/hast-util-raw-7.2.3.tgz#dcb5b22a22073436dbdc4aa09660a644f4991d99" + integrity sha512-RujVQfVsOrxzPOPSzZFiwofMArbQke6DJjnFfceiEbFh7S05CbPt0cYN+A5YeD3pso0JQk6O1aHBnx9+Pm2uqg== + dependencies: + "@types/hast" "^2.0.0" + "@types/parse5" "^6.0.0" + hast-util-from-parse5 "^7.0.0" + hast-util-to-parse5 "^7.0.0" + html-void-elements "^2.0.0" + parse5 "^6.0.0" + unist-util-position "^4.0.0" + unist-util-visit "^4.0.0" + vfile "^5.0.0" + web-namespaces "^2.0.0" + zwitch "^2.0.0" + hast-util-to-parse5@^6.0.0: version "6.0.0" resolved "https://registry.yarnpkg.com/hast-util-to-parse5/-/hast-util-to-parse5-6.0.0.tgz#1ec44650b631d72952066cea9b1445df699f8479" @@ -5458,6 +6074,23 @@ hast-util-to-parse5@^6.0.0: xtend "^4.0.0" zwitch "^1.0.0" +hast-util-to-parse5@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/hast-util-to-parse5/-/hast-util-to-parse5-7.1.0.tgz#c49391bf8f151973e0c9adcd116b561e8daf29f3" + integrity sha512-YNRgAJkH2Jky5ySkIqFXTQiaqcAtJyVE+D5lkN6CdtOqrnkLfGYYrEcKuHOJZlp+MwjSwuD3fZuawI+sic/RBw== + dependencies: + "@types/hast" "^2.0.0" + comma-separated-tokens "^2.0.0" + property-information "^6.0.0" + space-separated-tokens "^2.0.0" + web-namespaces "^2.0.0" + zwitch "^2.0.0" + +hast-util-whitespace@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/hast-util-whitespace/-/hast-util-whitespace-2.0.1.tgz#0ec64e257e6fc216c7d14c8a1b74d27d650b4557" + integrity sha512-nAxA0v8+vXSBDt3AnRUNjyRIQ0rD+ntpbAp4LnPkumc5M9yUbSMa4XDU9Q6etY4f1Wp4bNgvc1yjiZtsTTrSng== + hastscript@^6.0.0: version "6.0.0" resolved "https://registry.yarnpkg.com/hastscript/-/hastscript-6.0.0.tgz#e8768d7eac56c3fdeac8a92830d58e811e5bf640" @@ -5469,11 +6102,32 @@ hastscript@^6.0.0: property-information "^5.0.0" space-separated-tokens "^1.0.0" +hastscript@^7.0.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/hastscript/-/hastscript-7.2.0.tgz#0eafb7afb153d047077fa2a833dc9b7ec604d10b" + integrity sha512-TtYPq24IldU8iKoJQqvZOuhi5CyCQRAbvDOX0x1eW6rsHSxa/1i2CCiptNTotGHJ3VoHRGmqiv6/D3q113ikkw== + dependencies: + "@types/hast" "^2.0.0" + comma-separated-tokens "^2.0.0" + hast-util-parse-selector "^3.0.0" + property-information "^6.0.0" + space-separated-tokens "^2.0.0" + he@^1.2.0: version "1.2.0" resolved "https://registry.yarnpkg.com/he/-/he-1.2.0.tgz#84ae65fa7eafb165fddb61566ae14baf05664f0f" integrity sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw== +heap@^0.2.6: + version "0.2.7" + resolved "https://registry.yarnpkg.com/heap/-/heap-0.2.7.tgz#1e6adf711d3f27ce35a81fe3b7bd576c2260a8fc" + integrity sha512-2bsegYkkHO+h/9MGbn6KWcE45cHZgPANo5LXF7EvWdT0yT2EguSVO1nDgU5c8+ZOPwp2vMNa7YFsJhVcDR9Sdg== + +hexoid@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/hexoid/-/hexoid-1.0.0.tgz#ad10c6573fb907de23d9ec63a711267d9dc9bc18" + integrity sha512-QFLV0taWQOZtvIRIAdBChesmogZrtuXvVWsFHZTk2SU+anspqZ2vMnoLg7IE1+Uk16N19APic1BuF8bC8c2m5g== + history@^4.9.0: version "4.10.1" resolved "https://registry.yarnpkg.com/history/-/history-4.10.1.tgz#33371a65e3a83b267434e2b3f3b1b4c58aad4cf3" @@ -5486,7 +6140,7 @@ history@^4.9.0: tiny-warning "^1.0.0" value-equal "^1.0.1" -hoist-non-react-statics@^3.1.0: +hoist-non-react-statics@^3.1.0, hoist-non-react-statics@^3.3.0, hoist-non-react-statics@^3.3.2: version "3.3.2" resolved "https://registry.yarnpkg.com/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz#ece0acaf71d62c2969c2ec59feff42a4b1a85b45" integrity sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw== @@ -5531,6 +6185,11 @@ html-void-elements@^1.0.0: resolved "https://registry.yarnpkg.com/html-void-elements/-/html-void-elements-1.0.5.tgz#ce9159494e86d95e45795b166c2021c2cfca4483" integrity sha512-uE/TxKuyNIcx44cIWnjr/rfIATDH7ZaOMmstu0CwhFG1Dunhlp4OC6/NMbhiwoq5BpW0ubi303qnEk/PZj614w== +html-void-elements@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/html-void-elements/-/html-void-elements-2.0.1.tgz#29459b8b05c200b6c5ee98743c41b979d577549f" + integrity sha512-0quDb7s97CfemeJAnW9wC0hw78MtW7NU3hqtCD75g2vFlDLt36llsYD7uB7SUzojLMP24N5IatXf7ylGXiGG9A== + html-webpack-plugin@5.5.0, html-webpack-plugin@^5.5.0: version "5.5.0" resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-5.5.0.tgz#c3911936f57681c1f9f4d8b68c158cd9dfe52f50" @@ -5630,19 +6289,29 @@ http-proxy@^1.18.1: follow-redirects "^1.0.0" requires-port "^1.0.0" +http-reasons@0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/http-reasons/-/http-reasons-0.1.0.tgz#a953ca670078669dde142ce899401b9d6e85d3b4" + integrity sha512-P6kYh0lKZ+y29T2Gqz+RlC9WBLhKe8kDmcJ+A+611jFfxdPsbMRQ5aNmFRM3lENqFkK+HTTL+tlQviAiv0AbLQ== + +http2-client@^1.2.5: + version "1.3.5" + resolved "https://registry.yarnpkg.com/http2-client/-/http2-client-1.3.5.tgz#20c9dc909e3cc98284dd20af2432c524086df181" + integrity sha512-EC2utToWl4RKfs5zd36Mxq7nzHHBuomZboI0yYL6Y0RmBgT7Sgkq4rQ0ezFTYoIsSs7Tm9SJe+o2FcAg6GBhGA== + human-signals@^2.1.0: version "2.1.0" resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== -iconv-lite@0.4, iconv-lite@0.4.24: +iconv-lite@0.4.24: version "0.4.24" resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b" integrity sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA== dependencies: safer-buffer ">= 2.1.2 < 3" -iconv-lite@0.6: +iconv-lite@0.6, iconv-lite@0.6.3: version "0.6.3" resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.6.3.tgz#a52f80bf38da1952eb5c681790719871a1a72501" integrity sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw== @@ -5660,9 +6329,9 @@ ieee754@^1.2.1: integrity sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA== ignore@^5.1.9, ignore@^5.2.0: - version "5.2.0" - resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.2.0.tgz#6d3bac8fa7fe0d45d9f9be7bac2fc279577e345a" - integrity sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ== + version "5.2.4" + resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.2.4.tgz#a291c0c6178ff1b960befe47fcdec301674a6324" + integrity sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ== image-size@^1.0.1: version "1.0.2" @@ -5671,10 +6340,10 @@ image-size@^1.0.1: dependencies: queue "6.0.2" -immer@^9.0.7: - version "9.0.16" - resolved "https://registry.yarnpkg.com/immer/-/immer-9.0.16.tgz#8e7caab80118c2b54b37ad43e05758cdefad0198" - integrity sha512-qenGE7CstVm1NrHQbMh8YaSzTZTFNP3zPqr3YU0S0UY441j4bJTg4A2Hh5KAhwgaiU6ZZ1Ar6y/2f4TblnMReQ== +immer@^9.0.16, immer@^9.0.7: + version "9.0.19" + resolved "https://registry.yarnpkg.com/immer/-/immer-9.0.19.tgz#67fb97310555690b5f9cd8380d38fc0aabb6b38b" + integrity sha512-eY+Y0qcsB4TZKwgQzLaE/lqYMlKhv5J9dyd2RhhtGhNo2njPXDqU9XPfcNfa3MIDsdtZt5KlkIsirlo4dHsWdQ== import-fresh@^3.1.0, import-fresh@^3.2.1, import-fresh@^3.3.0: version "3.3.0" @@ -5898,6 +6567,11 @@ is-plain-obj@^3.0.0: resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-3.0.0.tgz#af6f2ea14ac5a646183a5bbdb5baabbc156ad9d7" integrity sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA== +is-plain-obj@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-4.1.0.tgz#d65025edec3657ce032fd7db63c97883eaed71f0" + integrity sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg== + is-plain-object@^2.0.4: version "2.0.4" resolved "https://registry.yarnpkg.com/is-plain-object/-/is-plain-object-2.0.4.tgz#2c163b3fafb1b606d9d17928f05c2a1c38e07677" @@ -5967,12 +6641,12 @@ isobject@^3.0.1: resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df" integrity sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg== -jest-util@^29.2.1: - version "29.2.1" - resolved "https://registry.yarnpkg.com/jest-util/-/jest-util-29.2.1.tgz#f26872ba0dc8cbefaba32c34f98935f6cf5fc747" - integrity sha512-P5VWDj25r7kj7kl4pN2rG/RN2c1TLfYYYZYULnS/35nFDjBai+hBeo3MDrYZS7p6IoY3YHZnt2vq4L6mKnLk0g== +jest-util@^29.4.3: + version "29.4.3" + resolved "https://registry.yarnpkg.com/jest-util/-/jest-util-29.4.3.tgz#851a148e23fc2b633c55f6dad2e45d7f4579f496" + integrity sha512-ToSGORAz4SSSoqxDSylWX8JzkOQR7zoBtNRsA7e+1WUX5F8jrOwaNpuh1YfJHJKDHXLHmObv5eOjejUd+/Ws+Q== dependencies: - "@jest/types" "^29.2.1" + "@jest/types" "^29.4.3" "@types/node" "*" chalk "^4.0.0" ci-info "^3.2.0" @@ -5989,32 +6663,37 @@ jest-worker@^27.0.2, jest-worker@^27.4.5: supports-color "^8.0.0" jest-worker@^29.1.2: - version "29.2.1" - resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-29.2.1.tgz#8ba68255438252e1674f990f0180c54dfa26a3b1" - integrity sha512-ROHTZ+oj7sBrgtv46zZ84uWky71AoYi0vEV9CdEtc1FQunsoAGe5HbQmW76nI5QWdvECVPrSi1MCVUmizSavMg== + version "29.4.3" + resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-29.4.3.tgz#9a4023e1ea1d306034237c7133d7da4240e8934e" + integrity sha512-GLHN/GTAAMEy5BFdvpUfzr9Dr80zQqBrh0fz1mtRMe05hqP45+HfQltu7oTBfduD0UeZs09d+maFtFYAXFWvAA== dependencies: "@types/node" "*" - jest-util "^29.2.1" + jest-util "^29.4.3" merge-stream "^2.0.0" supports-color "^8.0.0" joi@^17.6.0: - version "17.7.0" - resolved "https://registry.yarnpkg.com/joi/-/joi-17.7.0.tgz#591a33b1fe1aca2bc27f290bcad9b9c1c570a6b3" - integrity sha512-1/ugc8djfn93rTE3WRKdCzGGt/EtiYKxITMO4Wiv6q5JL1gl9ePt4kBsl1S499nbosspfctIQTpYIhSmHA3WAg== + version "17.8.3" + resolved "https://registry.yarnpkg.com/joi/-/joi-17.8.3.tgz#d772fe27a87a5cda21aace5cf11eee8671ca7e6f" + integrity sha512-q5Fn6Tj/jR8PfrLrx4fpGH4v9qM6o+vDUfD4/3vxxyg34OmKcNqYZ1qn2mpLza96S8tL0p0rIw2gOZX+/cTg9w== dependencies: "@hapi/hoek" "^9.0.0" "@hapi/topo" "^5.0.0" "@sideway/address" "^4.1.3" - "@sideway/formula" "^3.0.0" + "@sideway/formula" "^3.0.1" "@sideway/pinpoint" "^2.0.0" +js-levenshtein@^1.1.6: + version "1.1.6" + resolved "https://registry.yarnpkg.com/js-levenshtein/-/js-levenshtein-1.1.6.tgz#c6cee58eb3550372df8deb85fad5ce66ce01d59d" + integrity sha512-X2BB11YZtrRqY4EnQcLX5Rh373zbK4alC1FW7D7MBhL2gtcC17cTnr6DmfHZeS0s2rTHjUTMMHfG7gO8SSdw+g== + "js-tokens@^3.0.0 || ^4.0.0", js-tokens@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== -js-yaml@^3.13.1: +js-yaml@3.14.1, js-yaml@^3.13.1: version "3.14.1" resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.1.tgz#dae812fdb3825fa306609a8717383c50c36a0537" integrity sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g== @@ -6049,6 +6728,43 @@ json-parse-even-better-errors@^2.3.0, json-parse-even-better-errors@^2.3.1: resolved "https://registry.yarnpkg.com/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz#7c47805a94319928e05777405dc12e1f7a4ee02d" integrity sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w== +json-pointer@^0.6.2: + version "0.6.2" + resolved "https://registry.yarnpkg.com/json-pointer/-/json-pointer-0.6.2.tgz#f97bd7550be5e9ea901f8c9264c9d436a22a93cd" + integrity sha512-vLWcKbOaXlO+jvRy4qNd+TI1QUPZzfJj1tpJ3vAXDych5XJf93ftpUKe5pKCrzyIIwgBJcOcCVRUfqQP25afBw== + dependencies: + foreach "^2.0.4" + +json-refs@^3.0.15: + version "3.0.15" + resolved "https://registry.yarnpkg.com/json-refs/-/json-refs-3.0.15.tgz#1089f4acf263a3152c790479485195cd6449e855" + integrity sha512-0vOQd9eLNBL18EGl5yYaO44GhixmImes2wiYn9Z3sag3QnehWrYWlB9AFtMxCL2Bj3fyxgDYkxGFEU/chlYssw== + dependencies: + commander "~4.1.1" + graphlib "^2.1.8" + js-yaml "^3.13.1" + lodash "^4.17.15" + native-promise-only "^0.8.1" + path-loader "^1.0.10" + slash "^3.0.0" + uri-js "^4.2.2" + +json-schema-compare@^0.2.2: + version "0.2.2" + resolved "https://registry.yarnpkg.com/json-schema-compare/-/json-schema-compare-0.2.2.tgz#dd601508335a90c7f4cfadb6b2e397225c908e56" + integrity sha512-c4WYmDKyJXhs7WWvAWm3uIYnfyWFoIp+JEoX34rctVvEkMYCPGhXtvmFFXiffBbxfZsvQ0RNnV5H7GvDF5HCqQ== + dependencies: + lodash "^4.17.4" + +json-schema-merge-allof@0.8.1, json-schema-merge-allof@^0.8.1: + version "0.8.1" + resolved "https://registry.yarnpkg.com/json-schema-merge-allof/-/json-schema-merge-allof-0.8.1.tgz#ed2828cdd958616ff74f932830a26291789eaaf2" + integrity sha512-CTUKmIlPJbsWfzRRnOXz+0MjIqvnleIXwFTzz+t9T86HnYX/Rozria6ZVGLktAU9e+NygNljveP+yxqtQp/Q4w== + dependencies: + compute-lcm "^1.1.2" + json-schema-compare "^0.2.2" + lodash "^4.17.20" + json-schema-traverse@^0.4.1: version "0.4.1" resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660" @@ -6059,7 +6775,7 @@ json-schema-traverse@^1.0.0: resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz#ae7bcb3656ab77a73ba5c49bf654f38e6b6860e2" integrity sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== -json5@^2.1.2, json5@^2.2.1: +json5@^2.1.2, json5@^2.2.1, json5@^2.2.2: version "2.2.3" resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283" integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== @@ -6095,10 +6811,15 @@ kleur@^3.0.3: resolved "https://registry.yarnpkg.com/kleur/-/kleur-3.0.3.tgz#a79c9ecc86ee1ce3fa6206d1216c501f147fc07e" integrity sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w== +kleur@^4.0.3: + version "4.1.5" + resolved "https://registry.yarnpkg.com/kleur/-/kleur-4.1.5.tgz#95106101795f7050c6c650f350c683febddb1780" + integrity sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ== + klona@^2.0.5: - version "2.0.5" - resolved "https://registry.yarnpkg.com/klona/-/klona-2.0.5.tgz#d166574d90076395d9963aa7a928fabb8d76afbc" - integrity sha512-pJiBpiXMbt7dkzXe8Ghj/u4FfXOOa98fPW+bihOJ4SjnoijweJrNThJfd3ifXpXhREjpoF2mZVH1GfS9LV3kHQ== + version "2.0.6" + resolved "https://registry.yarnpkg.com/klona/-/klona-2.0.6.tgz#85bffbf819c03b2f53270412420a4555ef882e22" + integrity sha512-dhG34DXATL5hSxJbIexCft8FChFXtmskoZYnoPWjXQuebWYCNkVeV3KkGegCK9CP1oswI/vQibS2GY7Em/sJJA== latest-version@^5.1.0: version "5.1.0" @@ -6107,6 +6828,16 @@ latest-version@^5.1.0: dependencies: package-json "^6.3.0" +layout-base@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/layout-base/-/layout-base-1.0.2.tgz#1291e296883c322a9dd4c5dd82063721b53e26e2" + integrity sha512-8h2oVEZNktL4BH2JCOI90iD1yXwL6iNW7KcCKT2QZgQJR2vbqDsldCTPRU9NifTCqHZci57XvQQ15YTu+sTYPg== + +layout-base@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/layout-base/-/layout-base-2.0.1.tgz#d0337913586c90f9c2c075292069f5c2da5dd285" + integrity sha512-dp3s92+uNI1hWIpPGH3jK2kxE2lMjdXdr+DH8ynZHpd6PUlH6x6cbuXnoMmiNumznqaNO31xu9e79F0uuZ0JFg== + leven@^3.1.0: version "3.1.0" resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2" @@ -6122,6 +6853,11 @@ lines-and-columns@^1.1.6: resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632" integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== +liquid-json@0.3.1: + version "0.3.1" + resolved "https://registry.yarnpkg.com/liquid-json/-/liquid-json-0.3.1.tgz#9155a18136d8a6b2615e5f16f9a2448ab6b50eea" + integrity sha512-wUayTU8MS827Dam6MxgD72Ui+KOSF+u/eIqpatOtjnvgJ0+mnDq33uC2M7J0tPK+upe/DpUAuK4JUU89iBoNKQ== + loader-runner@^4.2.0: version "4.3.0" resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-4.3.0.tgz#c1b4a163b99f614830353b16755e7149ac2314e1" @@ -6137,9 +6873,9 @@ loader-utils@^2.0.0: json5 "^2.1.2" loader-utils@^3.2.0: - version "3.2.0" - resolved "https://registry.yarnpkg.com/loader-utils/-/loader-utils-3.2.0.tgz#bcecc51a7898bee7473d4bc6b845b23af8304d4f" - integrity sha512-HVl9ZqccQihZ7JM85dco1MvO9G+ONvxoGa9rkhzFsneGLKSUg1gJf9bWzhRhcvm2qChhWpebQhP44qxjKIUCaQ== + version "3.2.1" + resolved "https://registry.yarnpkg.com/loader-utils/-/loader-utils-3.2.1.tgz#4fb104b599daafd82ef3e1a41fb9265f87e1f576" + integrity sha512-ZvFw1KWS3GVyYBYb7qkmRM/WwL2TQQBxgCK62rlvm4WpVQ23Nb4tYjApUlfjrEGvOs7KHEsmyUn75OHZrJMWPw== locate-path@^3.0.0: version "3.0.0" @@ -6163,6 +6899,11 @@ locate-path@^6.0.0: dependencies: p-locate "^5.0.0" +lodash-es@^4.17.21: + version "4.17.21" + resolved "https://registry.yarnpkg.com/lodash-es/-/lodash-es-4.17.21.tgz#43e626c46e6591b7750beb2b50117390c609e3ee" + integrity sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw== + lodash.assignin@^4.0.9: version "4.2.0" resolved "https://registry.yarnpkg.com/lodash.assignin/-/lodash.assignin-4.2.0.tgz#ba8df5fb841eb0a3e8044232b0e263a8dc6a28a2" @@ -6208,6 +6949,11 @@ lodash.foreach@^4.3.0: resolved "https://registry.yarnpkg.com/lodash.foreach/-/lodash.foreach-4.5.0.tgz#1a6a35eace401280c7f06dddec35165ab27e3e53" integrity sha512-aEXTF4d+m05rVOAUG3z4vZZ4xVexLKZGF0lIxuHZ1Hplpk/3B6Z1+/ICICYRLm7c41Z2xiejbkCkJoTlypoXhQ== +lodash.isequal@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/lodash.isequal/-/lodash.isequal-4.5.0.tgz#415c4478f2bcc30120c22ce10ed3226f7d3e18e0" + integrity sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ== + lodash.map@^4.4.0: version "4.6.0" resolved "https://registry.yarnpkg.com/lodash.map/-/lodash.map-4.6.0.tgz#771ec7839e3473d9c4cde28b19394c3562f4f6d3" @@ -6248,7 +6994,7 @@ lodash.uniq@4.5.0, lodash.uniq@^4.5.0: resolved "https://registry.yarnpkg.com/lodash.uniq/-/lodash.uniq-4.5.0.tgz#d0225373aeb652adc1bc82e4945339a842754773" integrity sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ== -lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.20, lodash@^4.17.21: +lodash@4.17.21, lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.20, lodash@^4.17.21, lodash@^4.17.4: version "4.17.21" resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c" integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg== @@ -6277,6 +7023,13 @@ lowercase-keys@^2.0.0: resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-2.0.0.tgz#2603e78b7b4b0006cbca2fbcc8a3202558ac9479" integrity sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA== +lru-cache@^5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-5.1.1.tgz#1da27e6710271947695daf6848e847f01d84b920" + integrity sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w== + dependencies: + yallist "^3.0.2" + lru-cache@^6.0.0: version "6.0.0" resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94" @@ -6310,6 +7063,33 @@ mdast-util-definitions@^4.0.0: dependencies: unist-util-visit "^2.0.0" +mdast-util-definitions@^5.0.0: + version "5.1.2" + resolved "https://registry.yarnpkg.com/mdast-util-definitions/-/mdast-util-definitions-5.1.2.tgz#9910abb60ac5d7115d6819b57ae0bcef07a3f7a7" + integrity sha512-8SVPMuHqlPME/z3gqVwWY4zVXn8lqKv/pAhC57FuJ40ImXyBpmO5ukh98zB2v7Blql2FiHjHv9LVztSIqjY+MA== + dependencies: + "@types/mdast" "^3.0.0" + "@types/unist" "^2.0.0" + unist-util-visit "^4.0.0" + +mdast-util-from-markdown@^1.0.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/mdast-util-from-markdown/-/mdast-util-from-markdown-1.3.0.tgz#0214124154f26154a2b3f9d401155509be45e894" + integrity sha512-HN3W1gRIuN/ZW295c7zi7g9lVBllMgZE40RxCX37wrTPWXCWtpvOZdfnuK+1WNpvZje6XuJeI3Wnb4TJEUem+g== + dependencies: + "@types/mdast" "^3.0.0" + "@types/unist" "^2.0.0" + decode-named-character-reference "^1.0.0" + mdast-util-to-string "^3.1.0" + micromark "^3.0.0" + micromark-util-decode-numeric-character-reference "^1.0.0" + micromark-util-decode-string "^1.0.0" + micromark-util-normalize-identifier "^1.0.0" + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.0" + unist-util-stringify-position "^3.0.0" + uvu "^0.5.0" + mdast-util-to-hast@10.0.1: version "10.0.1" resolved "https://registry.yarnpkg.com/mdast-util-to-hast/-/mdast-util-to-hast-10.0.1.tgz#0cfc82089494c52d46eb0e3edb7a4eb2aea021eb" @@ -6324,11 +7104,32 @@ mdast-util-to-hast@10.0.1: unist-util-position "^3.0.0" unist-util-visit "^2.0.0" +mdast-util-to-hast@^12.1.0: + version "12.3.0" + resolved "https://registry.yarnpkg.com/mdast-util-to-hast/-/mdast-util-to-hast-12.3.0.tgz#045d2825fb04374e59970f5b3f279b5700f6fb49" + integrity sha512-pits93r8PhnIoU4Vy9bjW39M2jJ6/tdHyja9rrot9uujkN7UTU9SDnE6WNJz/IGyQk3XHX6yNNtrBH6cQzm8Hw== + dependencies: + "@types/hast" "^2.0.0" + "@types/mdast" "^3.0.0" + mdast-util-definitions "^5.0.0" + micromark-util-sanitize-uri "^1.1.0" + trim-lines "^3.0.0" + unist-util-generated "^2.0.0" + unist-util-position "^4.0.0" + unist-util-visit "^4.0.0" + mdast-util-to-string@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/mdast-util-to-string/-/mdast-util-to-string-2.0.0.tgz#b8cfe6a713e1091cb5b728fc48885a4767f8b97b" integrity sha512-AW4DRS3QbBayY/jJmD8437V1Gombjf8RSOUCMFBuo5iHi58AGEgVCKQ+ezHkZZDpAQS75hcBMpLqjpJTjtUL7w== +mdast-util-to-string@^3.1.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/mdast-util-to-string/-/mdast-util-to-string-3.1.1.tgz#db859050d79d48cf9896d294de06f3ede7474d16" + integrity sha512-tGvhT94e+cVnQt8JWE9/b3cUQZWS732TJxXHktvP+BYo62PpYD53Ls/6cC60rW21dW+txxiM4zMdc6abASvZKA== + dependencies: + "@types/mdast" "^3.0.0" + mdn-data@2.0.14: version "2.0.14" resolved "https://registry.yarnpkg.com/mdn-data/-/mdn-data-2.0.14.tgz#7113fc4281917d63ce29b43446f701e68c25ba50" @@ -6350,14 +7151,14 @@ media-typer@0.3.0: integrity sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ== medium-zoom@^1.0.4, medium-zoom@^1.0.6: - version "1.0.6" - resolved "https://registry.yarnpkg.com/medium-zoom/-/medium-zoom-1.0.6.tgz#9247f21ca9313d8bbe9420aca153a410df08d027" - integrity sha512-UdiUWfvz9fZMg1pzf4dcuqA0W079o0mpqbTnOz5ip4VGYX96QjmbM+OgOU/0uOzAytxC0Ny4z+VcYQnhdifimg== + version "1.0.8" + resolved "https://registry.yarnpkg.com/medium-zoom/-/medium-zoom-1.0.8.tgz#2bd1fbcf2961fa7b0e318fe284462aa9b8608ed2" + integrity sha512-CjFVuFq/IfrdqesAXfg+hzlDKu6A2n80ZIq0Kl9kWjoHh9j1N9Uvk5X0/MmN0hOfm5F9YBswlClhcwnmtwz7gA== memfs@^3.1.2, memfs@^3.4.1, memfs@^3.4.3: - version "3.4.10" - resolved "https://registry.yarnpkg.com/memfs/-/memfs-3.4.10.tgz#4cdff7cfd21351a85e11b08aa276ebf100210a4d" - integrity sha512-0bCUP+L79P4am30yP1msPzApwuMQG23TjwlwdHeEV5MxioDR1a0AgB0T9FfggU52eJuDCq8WVwb5ekznFyWiTQ== + version "3.4.13" + resolved "https://registry.yarnpkg.com/memfs/-/memfs-3.4.13.tgz#248a8bd239b3c240175cd5ec548de5227fc4f345" + integrity sha512-omTM41g3Skpvx5dSYeZIbXKcXoAVc/AoMNwn9TKx++L/gaen/+4TTttmu8ZSch5vfVJ8uJvGbroTsIlslRg6lg== dependencies: fs-monkey "^1.0.3" @@ -6377,25 +7178,226 @@ merge2@^1.3.0, merge2@^1.4.1: integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== mermaid@^9.1.2: - version "9.1.2" - resolved "https://registry.yarnpkg.com/mermaid/-/mermaid-9.1.2.tgz#98cdc55603464240987fe1a15f68dd06304c07f1" - integrity sha512-RVf3hBKqiMfyORHboCaEjOAK1TomLO50hYRPvlTrZCXlCniM5pRpe8UlkHBjjpaLtioZnbdYv/vEVj7iKnwkJQ== + version "9.4.0" + resolved "https://registry.yarnpkg.com/mermaid/-/mermaid-9.4.0.tgz#ff9afcac9f565a358fa8fc39135dec2c842c3b8f" + integrity sha512-4PWbOND7CNRbjHrdG3WUUGBreKAFVnMhdlPjttuUkeHbCQmAHkwzSh5dGwbrKmXGRaR4uTvfFVYzUcg++h0DkA== dependencies: "@braintree/sanitize-url" "^6.0.0" + cytoscape "^3.23.0" + cytoscape-cose-bilkent "^4.1.0" + cytoscape-fcose "^2.1.0" d3 "^7.0.0" - dagre "^0.8.5" - dagre-d3 "^0.6.4" - dompurify "2.3.8" - graphlib "^2.1.8" + dagre-d3-es "7.0.8" + dompurify "2.4.3" + elkjs "^0.8.2" khroma "^2.0.0" - moment-mini "^2.24.0" - stylis "^4.0.10" + lodash-es "^4.17.21" + moment "^2.29.4" + non-layered-tidy-tree-layout "^2.0.2" + stylis "^4.1.2" + ts-dedent "^2.2.0" + uuid "^9.0.0" -methods@~1.1.2: +methods@^1.1.2, methods@~1.1.2: version "1.1.2" resolved "https://registry.yarnpkg.com/methods/-/methods-1.1.2.tgz#5529a4d67654134edcc5266656835b0f851afcee" integrity sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w== +micromark-core-commonmark@^1.0.1: + version "1.0.6" + resolved "https://registry.yarnpkg.com/micromark-core-commonmark/-/micromark-core-commonmark-1.0.6.tgz#edff4c72e5993d93724a3c206970f5a15b0585ad" + integrity sha512-K+PkJTxqjFfSNkfAhp4GB+cZPfQd6dxtTXnf+RjZOV7T4EEXnvgzOcnp+eSTmpGk9d1S9sL6/lqrgSNn/s0HZA== + dependencies: + decode-named-character-reference "^1.0.0" + micromark-factory-destination "^1.0.0" + micromark-factory-label "^1.0.0" + micromark-factory-space "^1.0.0" + micromark-factory-title "^1.0.0" + micromark-factory-whitespace "^1.0.0" + micromark-util-character "^1.0.0" + micromark-util-chunked "^1.0.0" + micromark-util-classify-character "^1.0.0" + micromark-util-html-tag-name "^1.0.0" + micromark-util-normalize-identifier "^1.0.0" + micromark-util-resolve-all "^1.0.0" + micromark-util-subtokenize "^1.0.0" + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.1" + uvu "^0.5.0" + +micromark-factory-destination@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/micromark-factory-destination/-/micromark-factory-destination-1.0.0.tgz#fef1cb59ad4997c496f887b6977aa3034a5a277e" + integrity sha512-eUBA7Rs1/xtTVun9TmV3gjfPz2wEwgK5R5xcbIM5ZYAtvGF6JkyaDsj0agx8urXnO31tEO6Ug83iVH3tdedLnw== + dependencies: + micromark-util-character "^1.0.0" + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.0" + +micromark-factory-label@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/micromark-factory-label/-/micromark-factory-label-1.0.2.tgz#6be2551fa8d13542fcbbac478258fb7a20047137" + integrity sha512-CTIwxlOnU7dEshXDQ+dsr2n+yxpP0+fn271pu0bwDIS8uqfFcumXpj5mLn3hSC8iw2MUr6Gx8EcKng1dD7i6hg== + dependencies: + micromark-util-character "^1.0.0" + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.0" + uvu "^0.5.0" + +micromark-factory-space@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/micromark-factory-space/-/micromark-factory-space-1.0.0.tgz#cebff49968f2b9616c0fcb239e96685cb9497633" + integrity sha512-qUmqs4kj9a5yBnk3JMLyjtWYN6Mzfcx8uJfi5XAveBniDevmZasdGBba5b4QsvRcAkmvGo5ACmSUmyGiKTLZew== + dependencies: + micromark-util-character "^1.0.0" + micromark-util-types "^1.0.0" + +micromark-factory-title@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/micromark-factory-title/-/micromark-factory-title-1.0.2.tgz#7e09287c3748ff1693930f176e1c4a328382494f" + integrity sha512-zily+Nr4yFqgMGRKLpTVsNl5L4PMu485fGFDOQJQBl2NFpjGte1e86zC0da93wf97jrc4+2G2GQudFMHn3IX+A== + dependencies: + micromark-factory-space "^1.0.0" + micromark-util-character "^1.0.0" + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.0" + uvu "^0.5.0" + +micromark-factory-whitespace@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/micromark-factory-whitespace/-/micromark-factory-whitespace-1.0.0.tgz#e991e043ad376c1ba52f4e49858ce0794678621c" + integrity sha512-Qx7uEyahU1lt1RnsECBiuEbfr9INjQTGa6Err+gF3g0Tx4YEviPbqqGKNv/NrBaE7dVHdn1bVZKM/n5I/Bak7A== + dependencies: + micromark-factory-space "^1.0.0" + micromark-util-character "^1.0.0" + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.0" + +micromark-util-character@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/micromark-util-character/-/micromark-util-character-1.1.0.tgz#d97c54d5742a0d9611a68ca0cd4124331f264d86" + integrity sha512-agJ5B3unGNJ9rJvADMJ5ZiYjBRyDpzKAOk01Kpi1TKhlT1APx3XZk6eN7RtSz1erbWHC2L8T3xLZ81wdtGRZzg== + dependencies: + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.0" + +micromark-util-chunked@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-chunked/-/micromark-util-chunked-1.0.0.tgz#5b40d83f3d53b84c4c6bce30ed4257e9a4c79d06" + integrity sha512-5e8xTis5tEZKgesfbQMKRCyzvffRRUX+lK/y+DvsMFdabAicPkkZV6gO+FEWi9RfuKKoxxPwNL+dFF0SMImc1g== + dependencies: + micromark-util-symbol "^1.0.0" + +micromark-util-classify-character@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-classify-character/-/micromark-util-classify-character-1.0.0.tgz#cbd7b447cb79ee6997dd274a46fc4eb806460a20" + integrity sha512-F8oW2KKrQRb3vS5ud5HIqBVkCqQi224Nm55o5wYLzY/9PwHGXC01tr3d7+TqHHz6zrKQ72Okwtvm/xQm6OVNZA== + dependencies: + micromark-util-character "^1.0.0" + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.0" + +micromark-util-combine-extensions@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-combine-extensions/-/micromark-util-combine-extensions-1.0.0.tgz#91418e1e74fb893e3628b8d496085639124ff3d5" + integrity sha512-J8H058vFBdo/6+AsjHp2NF7AJ02SZtWaVUjsayNFeAiydTxUwViQPxN0Hf8dp4FmCQi0UUFovFsEyRSUmFH3MA== + dependencies: + micromark-util-chunked "^1.0.0" + micromark-util-types "^1.0.0" + +micromark-util-decode-numeric-character-reference@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-1.0.0.tgz#dcc85f13b5bd93ff8d2868c3dba28039d490b946" + integrity sha512-OzO9AI5VUtrTD7KSdagf4MWgHMtET17Ua1fIpXTpuhclCqD8egFWo85GxSGvxgkGS74bEahvtM0WP0HjvV0e4w== + dependencies: + micromark-util-symbol "^1.0.0" + +micromark-util-decode-string@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/micromark-util-decode-string/-/micromark-util-decode-string-1.0.2.tgz#942252ab7a76dec2dbf089cc32505ee2bc3acf02" + integrity sha512-DLT5Ho02qr6QWVNYbRZ3RYOSSWWFuH3tJexd3dgN1odEuPNxCngTCXJum7+ViRAd9BbdxCvMToPOD/IvVhzG6Q== + dependencies: + decode-named-character-reference "^1.0.0" + micromark-util-character "^1.0.0" + micromark-util-decode-numeric-character-reference "^1.0.0" + micromark-util-symbol "^1.0.0" + +micromark-util-encode@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-encode/-/micromark-util-encode-1.0.1.tgz#2c1c22d3800870ad770ece5686ebca5920353383" + integrity sha512-U2s5YdnAYexjKDel31SVMPbfi+eF8y1U4pfiRW/Y8EFVCy/vgxk/2wWTxzcqE71LHtCuCzlBDRU2a5CQ5j+mQA== + +micromark-util-html-tag-name@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/micromark-util-html-tag-name/-/micromark-util-html-tag-name-1.1.0.tgz#eb227118befd51f48858e879b7a419fc0df20497" + integrity sha512-BKlClMmYROy9UiV03SwNmckkjn8QHVaWkqoAqzivabvdGcwNGMMMH/5szAnywmsTBUzDsU57/mFi0sp4BQO6dA== + +micromark-util-normalize-identifier@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-1.0.0.tgz#4a3539cb8db954bbec5203952bfe8cedadae7828" + integrity sha512-yg+zrL14bBTFrQ7n35CmByWUTFsgst5JhA4gJYoty4Dqzj4Z4Fr/DHekSS5aLfH9bdlfnSvKAWsAgJhIbogyBg== + dependencies: + micromark-util-symbol "^1.0.0" + +micromark-util-resolve-all@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-resolve-all/-/micromark-util-resolve-all-1.0.0.tgz#a7c363f49a0162e931960c44f3127ab58f031d88" + integrity sha512-CB/AGk98u50k42kvgaMM94wzBqozSzDDaonKU7P7jwQIuH2RU0TeBqGYJz2WY1UdihhjweivStrJ2JdkdEmcfw== + dependencies: + micromark-util-types "^1.0.0" + +micromark-util-sanitize-uri@^1.0.0, micromark-util-sanitize-uri@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-1.1.0.tgz#f12e07a85106b902645e0364feb07cf253a85aee" + integrity sha512-RoxtuSCX6sUNtxhbmsEFQfWzs8VN7cTctmBPvYivo98xb/kDEoTCtJQX5wyzIYEmk/lvNFTat4hL8oW0KndFpg== + dependencies: + micromark-util-character "^1.0.0" + micromark-util-encode "^1.0.0" + micromark-util-symbol "^1.0.0" + +micromark-util-subtokenize@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/micromark-util-subtokenize/-/micromark-util-subtokenize-1.0.2.tgz#ff6f1af6ac836f8bfdbf9b02f40431760ad89105" + integrity sha512-d90uqCnXp/cy4G881Ub4psE57Sf8YD0pim9QdjCRNjfas2M1u6Lbt+XZK9gnHL2XFhnozZiEdCa9CNfXSfQ6xA== + dependencies: + micromark-util-chunked "^1.0.0" + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.0" + uvu "^0.5.0" + +micromark-util-symbol@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-symbol/-/micromark-util-symbol-1.0.1.tgz#b90344db62042ce454f351cf0bebcc0a6da4920e" + integrity sha512-oKDEMK2u5qqAptasDAwWDXq0tG9AssVwAx3E9bBF3t/shRIGsWIRG+cGafs2p/SnDSOecnt6hZPCE2o6lHfFmQ== + +micromark-util-types@^1.0.0, micromark-util-types@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/micromark-util-types/-/micromark-util-types-1.0.2.tgz#f4220fdb319205812f99c40f8c87a9be83eded20" + integrity sha512-DCfg/T8fcrhrRKTPjRrw/5LLvdGV7BHySf/1LOZx7TzWZdYRjogNtyNq885z3nNallwr3QUKARjqvHqX1/7t+w== + +micromark@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/micromark/-/micromark-3.1.0.tgz#eeba0fe0ac1c9aaef675157b52c166f125e89f62" + integrity sha512-6Mj0yHLdUZjHnOPgr5xfWIMqMWS12zDN6iws9SLuSz76W8jTtAv24MN4/CL7gJrl5vtxGInkkqDv/JIoRsQOvA== + dependencies: + "@types/debug" "^4.0.0" + debug "^4.0.0" + decode-named-character-reference "^1.0.0" + micromark-core-commonmark "^1.0.1" + micromark-factory-space "^1.0.0" + micromark-util-character "^1.0.0" + micromark-util-chunked "^1.0.0" + micromark-util-combine-extensions "^1.0.0" + micromark-util-decode-numeric-character-reference "^1.0.0" + micromark-util-encode "^1.0.0" + micromark-util-normalize-identifier "^1.0.0" + micromark-util-resolve-all "^1.0.0" + micromark-util-sanitize-uri "^1.0.0" + micromark-util-subtokenize "^1.0.0" + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.1" + uvu "^0.5.0" + micromatch@^4.0.2, micromatch@^4.0.4, micromatch@^4.0.5: version "4.0.5" resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.5.tgz#bc8999a7cbbf77cdc89f132f6e467051b49090c6" @@ -6404,6 +7406,11 @@ micromatch@^4.0.2, micromatch@^4.0.4, micromatch@^4.0.5: braces "^3.0.2" picomatch "^2.3.1" +mime-db@1.51.0: + version "1.51.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.51.0.tgz#d9ff62451859b18342d960850dc3cfb77e63fb0c" + integrity sha512-5y8A56jg7XVQx2mbv1lu49NR4dokRnhZYTtL+KGfaa27uq4pSTXkwQkFJl4pkRMyNFz/EtYDSkiiEHx3F7UN6g== + mime-db@1.52.0, "mime-db@>= 1.43.0 < 2": version "1.52.0" resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70" @@ -6414,6 +7421,13 @@ mime-db@~1.33.0: resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.33.0.tgz#a3492050a5cb9b63450541e39d9788d2272783db" integrity sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ== +mime-format@2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mime-format/-/mime-format-2.0.1.tgz#1274876d58bc803332427a515f5f7036e07b9413" + integrity sha512-XxU3ngPbEnrYnNbIX+lYSaYg0M01v6p2ntd2YaFksTu0vayaw5OJvbdRyWs07EYRlLED5qadUZ+xo+XhOvFhwg== + dependencies: + charset "^1.0.0" + mime-types@2.1.18: version "2.1.18" resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.18.tgz#6f323f60a83d11146f831ff11fd66e2fe5503bb8" @@ -6421,7 +7435,14 @@ mime-types@2.1.18: dependencies: mime-db "~1.33.0" -mime-types@^2.1.27, mime-types@^2.1.31, mime-types@~2.1.17, mime-types@~2.1.24, mime-types@~2.1.34: +mime-types@2.1.34: + version "2.1.34" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.34.tgz#5a712f9ec1503511a945803640fafe09d3793c24" + integrity sha512-6cP692WwGIs9XXdOO4++N+7qjqv0rqxxVvJ3VHPh/Sc9mVZcQP+ZGhkKiTvWMQRr2tbHkJP/Yn7Y0npb3ZBs4A== + dependencies: + mime-db "1.51.0" + +mime-types@^2.1.12, mime-types@^2.1.27, mime-types@^2.1.31, mime-types@~2.1.17, mime-types@~2.1.24, mime-types@~2.1.34: version "2.1.35" resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.35.tgz#381a871b62a734450660ae3deee44813f70d959a" integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== @@ -6433,6 +7454,11 @@ mime@1.6.0: resolved "https://registry.yarnpkg.com/mime/-/mime-1.6.0.tgz#32cd9e5c64553bd58d19a568af452acff04981b1" integrity sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg== +mime@2.6.0: + version "2.6.0" + resolved "https://registry.yarnpkg.com/mime/-/mime-2.6.0.tgz#a2a682a95cd4d0cb1d6257e28f83da7e35800367" + integrity sha512-USPkMeET31rOMiarsBNIHZKLGgvKc/LrjofAnBlOttf5ajRvqiRA8QsenbcooctK6d6Ts6aqZXBA+XbkKthiQg== + mimic-fn@^2.1.0: version "2.1.0" resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b" @@ -6451,9 +7477,9 @@ mini-css-extract-plugin@2.6.0: schema-utils "^4.0.0" mini-css-extract-plugin@^2.6.1: - version "2.6.1" - resolved "https://registry.yarnpkg.com/mini-css-extract-plugin/-/mini-css-extract-plugin-2.6.1.tgz#9a1251d15f2035c342d99a468ab9da7a0451b71e" - integrity sha512-wd+SD57/K6DiV7jIR34P+s3uckTRuQvx0tKPcvjFlrEylk6P4mQ2KSWk1hblj1Kxaqok7LogKOieygXqBczNlg== + version "2.7.2" + resolved "https://registry.yarnpkg.com/mini-css-extract-plugin/-/mini-css-extract-plugin-2.7.2.tgz#e049d3ea7d3e4e773aad585c6cb329ce0c7b72d7" + integrity sha512-EdlUizq13o0Pd+uCp+WO/JpkLvHRVGt97RqfeGhXqAcorYo1ypJSpkV+WDT0vY/kmh/p7wRdJNJtuyK540PXDw== dependencies: schema-utils "^4.0.0" @@ -6469,15 +7495,27 @@ minimatch@3.1.2, minimatch@^3.0.4, minimatch@^3.0.5, minimatch@^3.1.1: dependencies: brace-expansion "^1.1.7" -minimist@^1.2.0, minimist@^1.2.5, minimist@^1.2.6: - version "1.2.7" - resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.7.tgz#daa1c4d91f507390437c6a8bc01078e7000c4d18" - integrity sha512-bzfL1YUZsP41gmu/qjrEk0Q6i2ix/cVeAhbCbqH9u3zYutS1cLg00qhrD0M2MVdCcx4Sc0UpP2eBWo9rotpq6g== +minimatch@^5.0.1: + version "5.1.6" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-5.1.6.tgz#1cfcb8cf5522ea69952cd2af95ae09477f122a96" + integrity sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g== + dependencies: + brace-expansion "^2.0.1" -moment-mini@^2.24.0: +minimist@^1.2.0, minimist@^1.2.5, minimist@^1.2.6: + version "1.2.8" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c" + integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA== + +moment@^2.29.4: version "2.29.4" - resolved "https://registry.yarnpkg.com/moment-mini/-/moment-mini-2.29.4.tgz#cbbcdc58ce1b267506f28ea6668dbe060a32758f" - integrity sha512-uhXpYwHFeiTbY9KSgPPRoo1nt8OxNVdMVoTBYHfSEKeRkIkwGpO+gERmhuhBtzfaeOyTkykSrm2+noJBgqt3Hg== + resolved "https://registry.yarnpkg.com/moment/-/moment-2.29.4.tgz#3dbe052889fe7c1b2ed966fcb3a77328964ef108" + integrity sha512-5LC9SOxjSc2HF6vO2CyuTDNivEdoz2IvyJJGj6X8DJ0eFyfszE0QiEd+iXmBvUP3WHxSjFH/vIsA0EN00cgr8w== + +mri@^1.1.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/mri/-/mri-1.2.0.tgz#6721480fec2a11a4889861115a48b6cbe7cc8f0b" + integrity sha512-tzzskb3bG8LvYGFF/mDTpq3jpI6Q9wc3LEmBaghu+DdCssd1FakN7Bc0hVNmEyGq1bq3RgfkCb3cmQLpNPOroA== mrmime@^1.0.0: version "1.0.1" @@ -6515,11 +7553,30 @@ multicast-dns@^7.2.4, multicast-dns@^7.2.5: dns-packet "^5.2.2" thunky "^1.0.2" +mustache@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/mustache/-/mustache-4.2.0.tgz#e5892324d60a12ec9c2a73359edca52972bf6f64" + integrity sha512-71ippSywq5Yb7/tVYyGbkBggbU8H3u5Rz56fH60jGFgr8uHwxs+aSKeqmluIVzM0m0kB7xQjKS6qPfd0b2ZoqQ== + +mz@^2.7.0: + version "2.7.0" + resolved "https://registry.yarnpkg.com/mz/-/mz-2.7.0.tgz#95008057a56cafadc2bc63dde7f9ff6955948e32" + integrity sha512-z81GNO7nnYMEhrGh9LeymoE4+Yr0Wn5McHIZMK5cfQCl+NDX08sCZgUc9/6MHni9IWuFLm1Z3HTCXu2z9fN62Q== + dependencies: + any-promise "^1.0.0" + object-assign "^4.0.1" + thenify-all "^1.0.0" + nanoid@3.3.4, nanoid@^3.3.4: version "3.3.4" resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.4.tgz#730b67e3cd09e2deacf03c027c81c9d9dbc5e8ab" integrity sha512-MqBkQh/OHTS2egovRtLk45wEyNXwF+cokD+1YPf9u5VfJiRdAiRwB2froX5Co9Rh20xs4siNPm8naNotSD6RBw== +native-promise-only@^0.8.1: + version "0.8.1" + resolved "https://registry.yarnpkg.com/native-promise-only/-/native-promise-only-0.8.1.tgz#20a318c30cb45f71fe7adfbf7b21c99c1472ef11" + integrity sha512-zkVhZUA3y8mbz652WrL5x0fB0ehrBkulWT3TomAQ9iDtyXZvzKeEA6GPxAItBYeNYl5yngKRX612qHOhvMkDeg== + negotiator@0.6.3: version "0.6.3" resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-0.6.3.tgz#58e323a72fedc0d6f9cd4d31fe49f51479590ccd" @@ -6545,6 +7602,13 @@ node-emoji@^1.10.0: dependencies: lodash "^4.17.21" +node-fetch-h2@^2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/node-fetch-h2/-/node-fetch-h2-2.3.0.tgz#c6188325f9bd3d834020bf0f2d6dc17ced2241ac" + integrity sha512-ofRW94Ab0T4AOh5Fk8t0h8OBWrmjb0SSB20xh1H8YnPV9EJ+f5AMoYSUQ2zgJ4Iq2HAK0I2l5/Nequ8YzFS3Hg== + dependencies: + http2-client "^1.2.5" + node-fetch@2.6.7: version "2.6.7" resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.7.tgz#24de9fba827e3b4ae44dc8b20256a379160052ad" @@ -6552,15 +7616,34 @@ node-fetch@2.6.7: dependencies: whatwg-url "^5.0.0" +node-fetch@^2.6.1: + version "2.6.9" + resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.9.tgz#7c7f744b5cc6eb5fd404e0c7a9fec630a55657e6" + integrity sha512-DJm/CJkZkRjKKj4Zi4BsKVZh3ValV5IR5s7LVZnW+6YMh0W1BfNA8XSs6DLMGYlId5F3KnA70uu2qepcR08Qqg== + dependencies: + whatwg-url "^5.0.0" + node-forge@1.3.1, node-forge@^1: version "1.3.1" resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.1.tgz#be8da2af243b2417d5f646a770663a92b7e9ded3" integrity sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA== -node-releases@^2.0.6: - version "2.0.6" - resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.6.tgz#8a7088c63a55e493845683ebf3c828d8c51c5503" - integrity sha512-PiVXnNuFm5+iYkLBNeq5211hvO38y63T0i2KKh2KnUs3RpzJ+JtODFjkD8yjLwnDkTYF1eKXheUwdssR+NRZdg== +node-readfiles@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/node-readfiles/-/node-readfiles-0.2.0.tgz#dbbd4af12134e2e635c245ef93ffcf6f60673a5d" + integrity sha512-SU00ZarexNlE4Rjdm83vglt5Y9yiQ+XI1XpflWlb7q7UTN1JUItm69xMeiQCTxtTfnzt+83T8Cx+vI2ED++VDA== + dependencies: + es6-promise "^3.2.1" + +node-releases@^2.0.8: + version "2.0.10" + resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.10.tgz#c311ebae3b6a148c89b1813fd7c4d3c024ef537f" + integrity sha512-5GFldHPXVG/YZmFzJvKK2zDSzPKhEp0+ZR5SVaoSag9fsL5YgHbUHDfnG5494ISANDcK4KwPXAx2xqVEydmd7w== + +non-layered-tidy-tree-layout@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/non-layered-tidy-tree-layout/-/non-layered-tidy-tree-layout-2.0.2.tgz#57d35d13c356643fc296a55fb11ac15e74da7804" + integrity sha512-gkXMxRzUH+PB0ax9dUN0yYF0S25BqeAYqhgMaLUFmpXLEk7Fcu8f4emJuOAY0V8kjDICxROIKsTAKsV/v355xw== normalize-path@^3.0.0, normalize-path@~3.0.0: version "3.0.0" @@ -6608,7 +7691,65 @@ nth-check@~1.0.1: dependencies: boolbase "~1.0.0" -object-assign@^4.1.0, object-assign@^4.1.1: +oas-kit-common@^1.0.8: + version "1.0.8" + resolved "https://registry.yarnpkg.com/oas-kit-common/-/oas-kit-common-1.0.8.tgz#6d8cacf6e9097967a4c7ea8bcbcbd77018e1f535" + integrity sha512-pJTS2+T0oGIwgjGpw7sIRU8RQMcUoKCDWFLdBqKB2BNmGpbBMH2sdqAaOXUg8OzonZHU0L7vfJu1mJFEiYDWOQ== + dependencies: + fast-safe-stringify "^2.0.7" + +oas-linter@^3.2.2: + version "3.2.2" + resolved "https://registry.yarnpkg.com/oas-linter/-/oas-linter-3.2.2.tgz#ab6a33736313490659035ca6802dc4b35d48aa1e" + integrity sha512-KEGjPDVoU5K6swgo9hJVA/qYGlwfbFx+Kg2QB/kd7rzV5N8N5Mg6PlsoCMohVnQmo+pzJap/F610qTodKzecGQ== + dependencies: + "@exodus/schemasafe" "^1.0.0-rc.2" + should "^13.2.1" + yaml "^1.10.0" + +oas-resolver-browser@2.5.2: + version "2.5.2" + resolved "https://registry.yarnpkg.com/oas-resolver-browser/-/oas-resolver-browser-2.5.2.tgz#d972525a840d7a74ab1aa43e215e9531a99412ba" + integrity sha512-L3ugWyBHOpKLT+lb+pFXCOpk3byh6usis5T9u9mfu92jH5bR6YK8MA2bebUTIjY7I4415PzDeZcmcc+i7X05MA== + dependencies: + node-fetch-h2 "^2.3.0" + oas-kit-common "^1.0.8" + path-browserify "^1.0.1" + reftools "^1.1.6" + yaml "^1.10.0" + yargs "^15.3.1" + +oas-resolver@^2.5.6: + version "2.5.6" + resolved "https://registry.yarnpkg.com/oas-resolver/-/oas-resolver-2.5.6.tgz#10430569cb7daca56115c915e611ebc5515c561b" + integrity sha512-Yx5PWQNZomfEhPPOphFbZKi9W93CocQj18NlD2Pa4GWZzdZpSJvYwoiuurRI7m3SpcChrnO08hkuQDL3FGsVFQ== + dependencies: + node-fetch-h2 "^2.3.0" + oas-kit-common "^1.0.8" + reftools "^1.1.9" + yaml "^1.10.0" + yargs "^17.0.1" + +oas-schema-walker@^1.1.5: + version "1.1.5" + resolved "https://registry.yarnpkg.com/oas-schema-walker/-/oas-schema-walker-1.1.5.tgz#74c3cd47b70ff8e0b19adada14455b5d3ac38a22" + integrity sha512-2yucenq1a9YPmeNExoUa9Qwrt9RFkjqaMAA1X+U7sbb0AqBeTIdMHky9SQQ6iN94bO5NW0W4TRYXerG+BdAvAQ== + +oas-validator@^5.0.8: + version "5.0.8" + resolved "https://registry.yarnpkg.com/oas-validator/-/oas-validator-5.0.8.tgz#387e90df7cafa2d3ffc83b5fb976052b87e73c28" + integrity sha512-cu20/HE5N5HKqVygs3dt94eYJfBi0TsZvPVXDhbXQHiEityDN+RROTleefoKRKKJ9dFAF2JBkDHgvWj0sjKGmw== + dependencies: + call-me-maybe "^1.0.1" + oas-kit-common "^1.0.8" + oas-linter "^3.2.2" + oas-resolver "^2.5.6" + oas-schema-walker "^1.1.5" + reftools "^1.1.9" + should "^13.2.1" + yaml "^1.10.0" + +object-assign@^4.0.1, object-assign@^4.1.0, object-assign@^4.1.1: version "4.1.1" resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863" integrity sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg== @@ -6624,9 +7765,9 @@ object-inspect@1.12.0: integrity sha512-Ho2z80bVIvJloH+YzRmpZVQe87+qASmBUKZDWgx9cu+KDrX2ZDH/3tMy+gXbZETVGs2M8YdxObOh7XAtim9Y0g== object-inspect@^1.9.0: - version "1.12.2" - resolved "https://registry.yarnpkg.com/object-inspect/-/object-inspect-1.12.2.tgz#c0641f26394532f28ab8d796ab954e43c009a8ea" - integrity sha512-z+cPxW0QGUp0mcqcsgQyLVRDoXFQbXOwBaqyF7VIgI4TWNQsDHrBpUQslRmIfAoYWdYzs6UlKJtB2XJpTaNSpQ== + version "1.12.3" + resolved "https://registry.yarnpkg.com/object-inspect/-/object-inspect-1.12.3.tgz#ba62dffd67ee256c8c086dfae69e016cd1f198b9" + integrity sha512-geUvdk7c+eizMNUDkRpW1wJwgfOiOeHbxBR/hLXK1aT6zmVSO0jsQcs7fj6MGw89jC/cjGfLcNOrtMYtGqm81g== object-keys@^1.1.1: version "1.1.1" @@ -6675,9 +7816,9 @@ onetime@^5.1.2: mimic-fn "^2.1.0" open@^8.0.9, open@^8.4.0: - version "8.4.0" - resolved "https://registry.yarnpkg.com/open/-/open-8.4.0.tgz#345321ae18f8138f82565a910fdc6b39e8c244f8" - integrity sha512-XgFPPM+B28FtCCgSb9I+s9szOC1vZRSwgWsRUA5ylIxRTgKozqjOCrVOqGsYABPYK5qnfqClxZTFBa8PKt2v6Q== + version "8.4.2" + resolved "https://registry.yarnpkg.com/open/-/open-8.4.2.tgz#5b5ffe2a8f793dcd2aad73e550cb87b59cb084f9" + integrity sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ== dependencies: define-lazy-prop "^2.0.0" is-docker "^2.1.1" @@ -6814,9 +7955,9 @@ parse5@^6.0.0: integrity sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw== parse5@^7.0.0: - version "7.1.1" - resolved "https://registry.yarnpkg.com/parse5/-/parse5-7.1.1.tgz#4649f940ccfb95d8754f37f73078ea20afe0c746" - integrity sha512-kwpuwzB+px5WUg9pyK0IcK/shltJN5/OVhQagxhCQNtT9Y9QRZqNY2e1cmbu/paRh5LMnz/oVTVLBpjFmMZhSg== + version "7.1.2" + resolved "https://registry.yarnpkg.com/parse5/-/parse5-7.1.2.tgz#0736bebbfd77793823240a23b7fc5e010b7f8e32" + integrity sha512-Czj1WaSVpaoj0wbhMzLmWD69anp2WH7FXMB9n1Sy8/ZFF9jolSQVMu1Ij5WIyGmcBmhk7EOndpO4mIpihVqAXw== dependencies: entities "^4.4.0" @@ -6833,6 +7974,11 @@ pascal-case@^3.1.2: no-case "^3.0.4" tslib "^2.0.3" +path-browserify@1.0.1, path-browserify@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/path-browserify/-/path-browserify-1.0.1.tgz#d98454a9c3753d5790860f16f68867b9e46be1fd" + integrity sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g== + path-exists@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-3.0.0.tgz#ce0ebeaa5f78cb18925ea7d810d7b59b010fd515" @@ -6858,6 +8004,14 @@ path-key@^3.0.0, path-key@^3.1.0: resolved "https://registry.yarnpkg.com/path-key/-/path-key-3.1.1.tgz#581f6ade658cbba65a0d3380de7753295054f375" integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== +path-loader@^1.0.10: + version "1.0.12" + resolved "https://registry.yarnpkg.com/path-loader/-/path-loader-1.0.12.tgz#c5a99d464da27cfde5891d158a68807abbdfa5f5" + integrity sha512-n7oDG8B+k/p818uweWrOixY9/Dsr89o2TkCm6tOTex3fpdo2+BFDgR+KpB37mGKBRsBAlR8CIJMFN0OEy/7hIQ== + dependencies: + native-promise-only "^0.8.1" + superagent "^7.1.6" + path-parse@^1.0.7: version "1.0.7" resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735" @@ -6885,6 +8039,14 @@ path-type@^4.0.0: resolved "https://registry.yarnpkg.com/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b" integrity sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw== +path@^0.12.7: + version "0.12.7" + resolved "https://registry.yarnpkg.com/path/-/path-0.12.7.tgz#d4dc2a506c4ce2197eb481ebfcd5b36c0140b10f" + integrity sha512-aXXC6s+1w7otVF9UletFkFcDsJeO7lSZBPUQhtb5O0xJe8LtYhj/GxldoL09bBj9+ZmE2hNoHqQSFMN5fikh4Q== + dependencies: + process "^0.11.1" + util "^0.10.3" + picocolors@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.0.0.tgz#cb5bdc74ff3f51892236eaf79d68bc44564ab81c" @@ -6900,6 +8062,11 @@ pify@^2.3.0: resolved "https://registry.yarnpkg.com/pify/-/pify-2.3.0.tgz#ed141a6ac043a849ea588498e7dca8b15330e90c" integrity sha512-udgsAY+fTnvv7kI7aaxbqwWNb0AHiB0qBO89PZKPkoTmGOgdbrHDKD+0B2X4uTfJ/FT1R09r9gTsjUjNJotuog== +pirates@^4.0.1: + version "4.0.5" + resolved "https://registry.yarnpkg.com/pirates/-/pirates-4.0.5.tgz#feec352ea5c3268fb23a37c702ab1699f35a5f3b" + integrity sha512-8V9+HQPupnaXMA23c5hvl69zXvTwTzyAYasnkb0Tts4XvO4CliqONMOnvlq26rkhLC3nWDFBJf73LU1e1VZLaQ== + pkg-dir@^4.1.0: version "4.2.0" resolved "https://registry.yarnpkg.com/pkg-dir/-/pkg-dir-4.2.0.tgz#f099133df7ede422e81d1d8448270eeb3e4261f3" @@ -6920,6 +8087,11 @@ plugin-image-zoom@ataft/plugin-image-zoom: dependencies: medium-zoom "^1.0.4" +pluralize@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/pluralize/-/pluralize-8.0.0.tgz#1a6fa16a38d12a1901e0320fa017051c539ce3b1" + integrity sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA== + postcss-calc@8.2.4, postcss-calc@^8.2.3: version "8.2.4" resolved "https://registry.yarnpkg.com/postcss-calc/-/postcss-calc-8.2.4.tgz#77b9c29bfcbe8a07ff6693dc87050828889739a5" @@ -6928,7 +8100,7 @@ postcss-calc@8.2.4, postcss-calc@^8.2.3: postcss-selector-parser "^6.0.9" postcss-value-parser "^4.2.0" -postcss-colormin@5.3.0, postcss-colormin@^5.3.0: +postcss-colormin@5.3.0: version "5.3.0" resolved "https://registry.yarnpkg.com/postcss-colormin/-/postcss-colormin-5.3.0.tgz#3cee9e5ca62b2c27e84fce63affc0cfb5901956a" integrity sha512-WdDO4gOFG2Z8n4P8TWBpshnL3JpmNmJwdnfP2gbk2qBA8PWwOYcmjmI/t3CmMeL72a7Hkd+x/Mg9O2/0rD54Pg== @@ -6938,6 +8110,16 @@ postcss-colormin@5.3.0, postcss-colormin@^5.3.0: colord "^2.9.1" postcss-value-parser "^4.2.0" +postcss-colormin@^5.3.1: + version "5.3.1" + resolved "https://registry.yarnpkg.com/postcss-colormin/-/postcss-colormin-5.3.1.tgz#86c27c26ed6ba00d96c79e08f3ffb418d1d1988f" + integrity sha512-UsWQG0AqTFQmpBegeLLc1+c3jIqBNB0zlDGRWR+dQ3pRKJL1oeMzyqmH3o2PIfn9MBdNrVPWhDbT769LxCTLJQ== + dependencies: + browserslist "^4.21.4" + caniuse-api "^3.0.0" + colord "^2.9.1" + postcss-value-parser "^4.2.0" + postcss-convert-values@5.1.0: version "5.1.0" resolved "https://registry.yarnpkg.com/postcss-convert-values/-/postcss-convert-values-5.1.0.tgz#f8d3abe40b4ce4b1470702a0706343eac17e7c10" @@ -6995,9 +8177,9 @@ postcss-import@^14.1.0: resolve "^1.1.7" postcss-js@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/postcss-js/-/postcss-js-4.0.0.tgz#31db79889531b80dc7bc9b0ad283e418dce0ac00" - integrity sha512-77QESFBwgX4irogGVPgQ5s07vLvFqWr228qZY+w6lW599cRlK/HmnlivnnVUxkjHnCu4J16PDMHcH+e+2HbvTQ== + version "4.0.1" + resolved "https://registry.yarnpkg.com/postcss-js/-/postcss-js-4.0.1.tgz#61598186f3703bab052f1c4f7d805f3991bee9d2" + integrity sha512-dDLF8pEO191hJMtlHFPRa8xsizHaM82MLfNkUHdUtVEV3tgTp5oj+8qbEqYM57SLfc74KSbw//4SeJma2LRVIw== dependencies: camelcase-css "^2.0.1" @@ -7019,13 +8201,13 @@ postcss-loader@6.2.1: semver "^7.3.5" postcss-loader@^7.0.0: - version "7.0.1" - resolved "https://registry.yarnpkg.com/postcss-loader/-/postcss-loader-7.0.1.tgz#4c883cc0a1b2bfe2074377b7a74c1cd805684395" - integrity sha512-VRviFEyYlLjctSM93gAZtcJJ/iSkPZ79zWbN/1fSH+NisBByEiVLqpdVDrPLVSi8DX0oJo12kL/GppTBdKVXiQ== + version "7.0.2" + resolved "https://registry.yarnpkg.com/postcss-loader/-/postcss-loader-7.0.2.tgz#b53ff44a26fba3688eee92a048c7f2d4802e23bb" + integrity sha512-fUJzV/QH7NXUAqV8dWJ9Lg4aTkDCezpTS5HgJ2DvqznexTbSTxgi/dTECvTZ15BwKTtk8G/bqI/QTu2HPd3ZCg== dependencies: cosmiconfig "^7.0.0" klona "^2.0.5" - semver "^7.3.7" + semver "^7.3.8" postcss-merge-idents@5.1.1, postcss-merge-idents@^5.1.1: version "5.1.1" @@ -7061,10 +8243,10 @@ postcss-merge-rules@5.1.1: cssnano-utils "^3.1.0" postcss-selector-parser "^6.0.5" -postcss-merge-rules@^5.1.3: - version "5.1.3" - resolved "https://registry.yarnpkg.com/postcss-merge-rules/-/postcss-merge-rules-5.1.3.tgz#8f97679e67cc8d08677a6519afca41edf2220894" - integrity sha512-LbLd7uFC00vpOuMvyZop8+vvhnfRGpp2S+IMQKeuOZZapPRY4SMq5ErjQeHbHsjCUgJkRNrlU+LmxsKIqPKQlA== +postcss-merge-rules@^5.1.4: + version "5.1.4" + resolved "https://registry.yarnpkg.com/postcss-merge-rules/-/postcss-merge-rules-5.1.4.tgz#2f26fa5cacb75b1402e213789f6766ae5e40313c" + integrity sha512-0R2IuYpgU93y9lhVbO/OylTtKMVcHb67zjWIfCiKR9rWL3GUk1677LAqD/BcHizukdZEjT8Ru3oHRoAYoJy44g== dependencies: browserslist "^4.21.4" caniuse-api "^3.0.0" @@ -7270,10 +8452,10 @@ postcss-reduce-initial@5.1.0: browserslist "^4.16.6" caniuse-api "^3.0.0" -postcss-reduce-initial@^5.1.1: - version "5.1.1" - resolved "https://registry.yarnpkg.com/postcss-reduce-initial/-/postcss-reduce-initial-5.1.1.tgz#c18b7dfb88aee24b1f8e4936541c29adbd35224e" - integrity sha512-//jeDqWcHPuXGZLoolFrUXBDyuEGbr9S2rMo19bkTIjBQ4PqkaO+oI8wua5BOUxpfi97i3PCoInsiFIEBfkm9w== +postcss-reduce-initial@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/postcss-reduce-initial/-/postcss-reduce-initial-5.1.2.tgz#798cd77b3e033eae7105c18c9d371d989e1382d6" + integrity sha512-dE/y2XRaqAi6OvjzD22pjTUQ8eOfc6m/natGHgKFBK9DxFmIm69YmaRVQrGgFlEfc1HePIurY0TmDeROK05rIg== dependencies: browserslist "^4.21.4" caniuse-api "^3.0.0" @@ -7285,7 +8467,7 @@ postcss-reduce-transforms@5.1.0, postcss-reduce-transforms@^5.1.0: dependencies: postcss-value-parser "^4.2.0" -postcss-selector-parser@^6.0.10: +postcss-selector-parser@^6.0.10, postcss-selector-parser@^6.0.11, postcss-selector-parser@^6.0.2, postcss-selector-parser@^6.0.4, postcss-selector-parser@^6.0.5, postcss-selector-parser@^6.0.9: version "6.0.11" resolved "https://registry.yarnpkg.com/postcss-selector-parser/-/postcss-selector-parser-6.0.11.tgz#2e41dc39b7ad74046e1615185185cd0b17d0c8dc" integrity sha512-zbARubNdogI9j7WY4nQJBiNqQf3sLS3wCP4WfOidu+p28LofJqDH1tcXypGrcmMHhDk2t9wGhCsYe/+szLTy1g== @@ -7293,14 +8475,6 @@ postcss-selector-parser@^6.0.10: cssesc "^3.0.0" util-deprecate "^1.0.2" -postcss-selector-parser@^6.0.2, postcss-selector-parser@^6.0.4, postcss-selector-parser@^6.0.5, postcss-selector-parser@^6.0.9: - version "6.0.10" - resolved "https://registry.yarnpkg.com/postcss-selector-parser/-/postcss-selector-parser-6.0.10.tgz#79b61e2c0d1bfc2602d549e11d0876256f8df88d" - integrity sha512-IQ7TZdoaqbT+LCpShg46jnZVlhWD2w6iQYAcYXfHARZ7X1t/UGhhceQDs5X0cGqKvYlHNOuv7Oa1xmb0oQuA3w== - dependencies: - cssesc "^3.0.0" - util-deprecate "^1.0.2" - postcss-sort-media-queries@4.2.1: version "4.2.1" resolved "https://registry.yarnpkg.com/postcss-sort-media-queries/-/postcss-sort-media-queries-4.2.1.tgz#a99bae69ef1098ee3b64a5fa94d258ec240d0355" @@ -7340,23 +8514,21 @@ postcss-zindex@5.1.0, postcss-zindex@^5.1.0: resolved "https://registry.yarnpkg.com/postcss-zindex/-/postcss-zindex-5.1.0.tgz#4a5c7e5ff1050bd4c01d95b1847dfdcc58a496ff" integrity sha512-fgFMf0OtVSBR1va1JNHYgMxYk73yhn/qb4uQDq1DLGYolz8gHCyr/sesEuGUaYs58E3ZJRcpoGuPVoB7Meiq9A== -postcss@^8.3.11, postcss@^8.3.5, postcss@^8.4.14, postcss@^8.4.17, postcss@^8.4.7: - version "8.4.18" - resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.4.18.tgz#6d50046ea7d3d66a85e0e782074e7203bc7fbca2" - integrity sha512-Wi8mWhncLJm11GATDaQKobXSNEYGUHeQLiQqDFG1qQ5UTDPTEvKw0Xt5NsTpktGTwLps3ByrWsBrG0rB8YQ9oA== +postcss@^8.0.9, postcss@^8.3.11, postcss@^8.3.5, postcss@^8.4.14, postcss@^8.4.17, postcss@^8.4.19, postcss@^8.4.7: + version "8.4.21" + resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.4.21.tgz#c639b719a57efc3187b13a1d765675485f4134f4" + integrity sha512-tP7u/Sn/dVxK2NnruI4H9BG+x+Wxz6oeZ1cJ8P6G/PZY0IKk4k/63TDsQf2kQq3+qoJeLm2kIBUNlZe3zgb4Zg== dependencies: nanoid "^3.3.4" picocolors "^1.0.0" source-map-js "^1.0.2" -postcss@^8.4.18, postcss@^8.4.19: - version "8.4.19" - resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.4.19.tgz#61178e2add236b17351897c8bcc0b4c8ecab56fc" - integrity sha512-h+pbPsyhlYj6N2ozBmHhHrs9DzGmbaarbLvWipMRO7RLS+v4onj26MPFXA5OBYFxyqYhUJK456SwDcY9H2/zsA== +postman-url-encoder@3.0.5: + version "3.0.5" + resolved "https://registry.yarnpkg.com/postman-url-encoder/-/postman-url-encoder-3.0.5.tgz#af2efee3bb7644e2b059d8a78bc8070fae0467a5" + integrity sha512-jOrdVvzUXBC7C+9gkIkpDJ3HIxOHTIqjpQ4C1EMt1ZGeMvSEpbFCKq23DEfgsj46vMnDgyQf+1ZLp2Wm+bKSsA== dependencies: - nanoid "^3.3.4" - picocolors "^1.0.0" - source-map-js "^1.0.2" + punycode "^2.1.1" prepend-http@^2.0.0: version "2.0.0" @@ -7376,7 +8548,7 @@ pretty-time@^1.1.0: resolved "https://registry.yarnpkg.com/pretty-time/-/pretty-time-1.1.0.tgz#ffb7429afabb8535c346a34e41873adf3d74dd0e" integrity sha512-28iF6xPQrP8Oa6uxE6a1biz+lWeTOAPKggvjB8HAs6nVMKZwf5bG++632Dx614hIWgUPkgivRfG+a8uAXGTIbA== -prism-react-renderer@^1.3.5: +prism-react-renderer@^1.3.1, prism-react-renderer@^1.3.5: version "1.3.5" resolved "https://registry.yarnpkg.com/prism-react-renderer/-/prism-react-renderer-1.3.5.tgz#786bb69aa6f73c32ba1ee813fbe17a0115435085" integrity sha512-IJ+MSwBWKG+SM3b2SUfdrhC+gu01QkV2KmRQgREThBfSQRoufqRfxfHUxpG1WcaFjP+kojcFyO9Qqtpgt3qLCg== @@ -7396,6 +8568,11 @@ process-nextick-args@~2.0.0: resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-2.0.1.tgz#7820d9b16120cc55ca9ae7792680ae7dba6d7fe2" integrity sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag== +process@^0.11.1, process@^0.11.10: + version "0.11.10" + resolved "https://registry.yarnpkg.com/process/-/process-0.11.10.tgz#7332300e840161bda3e69a1d1d91a7d4bc16f182" + integrity sha512-cdGef/drWFoydD1JsMzuFf8100nZl+GT+yacc2bEced5f9Rjk4z+WtFUTBu9PhOi9j/jfmBPu0mMEY4wIdAF8A== + promise@^7.1.1: version "7.3.1" resolved "https://registry.yarnpkg.com/promise/-/promise-7.3.1.tgz#064b72602b18f90f29192b8b1bc418ffd1ebd3bf" @@ -7411,7 +8588,7 @@ prompts@^2.4.2: kleur "^3.0.3" sisteransi "^1.0.5" -prop-types@^15.6.2, prop-types@^15.7.2: +prop-types@^15.0.0, prop-types@^15.6.2, prop-types@^15.7.2: version "15.8.1" resolved "https://registry.yarnpkg.com/prop-types/-/prop-types-15.8.1.tgz#67d87bf1a694f48435cf332c24af10214a3140b5" integrity sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg== @@ -7427,6 +8604,11 @@ property-information@^5.0.0, property-information@^5.3.0: dependencies: xtend "^4.0.0" +property-information@^6.0.0: + version "6.2.0" + resolved "https://registry.yarnpkg.com/property-information/-/property-information-6.2.0.tgz#b74f522c31c097b5149e3c3cb8d7f3defd986a1d" + integrity sha512-kma4U7AFCTwpqq5twzC1YVIDXSqg6qQK6JN0smOw8fgRy1OkMi0CYSzFmsy6dnqSenamAtj0CyXMUJ1Mf6oROg== + proxy-addr@~2.0.7: version "2.0.7" resolved "https://registry.yarnpkg.com/proxy-addr/-/proxy-addr-2.0.7.tgz#f19fe69ceab311eeb94b42e70e8c2070f9ba1025" @@ -7453,10 +8635,10 @@ punycode@^1.3.2: resolved "https://registry.yarnpkg.com/punycode/-/punycode-1.4.1.tgz#c0d5a63b2718800ad8e1eb0fa5269c84dd41845e" integrity sha512-jmYNElW7yvO7TV33CjSmvSiE2yco3bV2czu/OzDKdMNVZQWfxCblURLhf+47syQRBntjfLdd/H0egrzIG+oaFQ== -punycode@^2.1.0: - version "2.1.1" - resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.1.1.tgz#b58b010ac40c22c5657616c8d2c2c02c7bf479ec" - integrity sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A== +punycode@^2.1.0, punycode@^2.1.1: + version "2.3.0" + resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.0.tgz#f67fa67c94da8f4d0cfff981aee4118064199b8f" + integrity sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA== pupa@^2.1.1: version "2.1.1" @@ -7477,7 +8659,7 @@ qs@6.10.3: dependencies: side-channel "^1.0.4" -qs@6.11.0: +qs@6.11.0, qs@^6.10.3, qs@^6.11.0: version "6.11.0" resolved "https://registry.yarnpkg.com/qs/-/qs-6.11.0.tgz#fd0d963446f7a65e1367e01abd85429453f0c37a" integrity sha512-MvjoMCJwEarSbUYk5O+nmoSzSutSsTwF85zcHPQ9OrlFoZOYIjaqBAJIqIXjptyD5vThxGq52Xu/MaJzRkIk4Q== @@ -7626,6 +8808,16 @@ react-is@^16.13.1, react-is@^16.6.0, react-is@^16.7.0: resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.13.1.tgz#789729a4dc36de2999dc156dd6c1d9c18cea56a4" integrity sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ== +react-is@^17.0.2: + version "17.0.2" + resolved "https://registry.yarnpkg.com/react-is/-/react-is-17.0.2.tgz#e691d4a8e9c789365655539ab372762b0efb54f0" + integrity sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w== + +react-is@^18.0.0: + version "18.2.0" + resolved "https://registry.yarnpkg.com/react-is/-/react-is-18.2.0.tgz#199431eeaaa2e09f86427efbb4f1473edb47609b" + integrity sha512-xWGDIW6x921xtzPkhiULtthJHoJvBbF3q26fzloPCK0hsvxtPVelvftw3zjbHWSkR2km9Z+4uxbDDK/6Zw9B8w== + react-json-view@^1.21.3: version "1.21.3" resolved "https://registry.yarnpkg.com/react-json-view/-/react-json-view-1.21.3.tgz#f184209ee8f1bf374fb0c41b0813cff54549c475" @@ -7636,11 +8828,20 @@ react-json-view@^1.21.3: react-lifecycles-compat "^3.0.4" react-textarea-autosize "^8.3.2" -react-lifecycles-compat@^3.0.4: +react-lifecycles-compat@^3.0.0, react-lifecycles-compat@^3.0.4: version "3.0.4" resolved "https://registry.yarnpkg.com/react-lifecycles-compat/-/react-lifecycles-compat-3.0.4.tgz#4f1a273afdfc8f3488a8c516bfda78f872352362" integrity sha512-fBASbA6LnOU9dOU2eW7aQ8xmYBSXUIWr+UmF9b1efZBazGNO+rcXT/icdKnYm2pTwcRylVUYwW7H1PHfLekVzA== +react-live@^3.1.1: + version "3.1.2" + resolved "https://registry.yarnpkg.com/react-live/-/react-live-3.1.2.tgz#1927e429afce12c82f8236f96125fb930c50252a" + integrity sha512-U9LhpvOBd1o9ajylgk6yyM7sfkMv0CM6Ya40DBlp4QcPlvwKH6tbDnGXyA5qv/wx1dwIj+cYhAzn3YoxPeMaAw== + dependencies: + prism-react-renderer "^1.3.1" + sucrase "^3.21.0" + use-editable "^2.3.3" + react-loadable-ssr-addon-v5-slorber@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/react-loadable-ssr-addon-v5-slorber/-/react-loadable-ssr-addon-v5-slorber-1.0.1.tgz#2cdc91e8a744ffdf9e3556caabeb6e4278689883" @@ -7648,6 +8849,54 @@ react-loadable-ssr-addon-v5-slorber@^1.0.1: dependencies: "@babel/runtime" "^7.10.3" +react-magic-dropzone@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/react-magic-dropzone/-/react-magic-dropzone-1.0.1.tgz#bfd25b77b57e7a04aaef0a28910563b707ee54df" + integrity sha512-0BIROPARmXHpk4AS3eWBOsewxoM5ndk2psYP/JmbCq8tz3uR2LIV1XiroZ9PKrmDRMctpW+TvsBCtWasuS8vFA== + +react-markdown@^8.0.1: + version "8.0.5" + resolved "https://registry.yarnpkg.com/react-markdown/-/react-markdown-8.0.5.tgz#c9a70a33ca9aeeafb769c6582e7e38843b9d70ad" + integrity sha512-jGJolWWmOWAvzf+xMdB9zwStViODyyFQhNB/bwCerbBKmrTmgmA599CGiOlP58OId1IMoIRsA8UdI1Lod4zb5A== + dependencies: + "@types/hast" "^2.0.0" + "@types/prop-types" "^15.0.0" + "@types/unist" "^2.0.0" + comma-separated-tokens "^2.0.0" + hast-util-whitespace "^2.0.0" + prop-types "^15.0.0" + property-information "^6.0.0" + react-is "^18.0.0" + remark-parse "^10.0.0" + remark-rehype "^10.0.0" + space-separated-tokens "^2.0.0" + style-to-object "^0.4.0" + unified "^10.0.0" + unist-util-visit "^4.0.0" + vfile "^5.0.0" + +react-modal@^3.15.1: + version "3.16.1" + resolved "https://registry.yarnpkg.com/react-modal/-/react-modal-3.16.1.tgz#34018528fc206561b1a5467fc3beeaddafb39b2b" + integrity sha512-VStHgI3BVcGo7OXczvnJN7yT2TWHJPDXZWyI/a0ssFNhGZWsPmB8cF0z33ewDXq4VfYMO1vXgiv/g8Nj9NDyWg== + dependencies: + exenv "^1.2.0" + prop-types "^15.7.2" + react-lifecycles-compat "^3.0.0" + warning "^4.0.3" + +react-redux@^7.2.0: + version "7.2.9" + resolved "https://registry.yarnpkg.com/react-redux/-/react-redux-7.2.9.tgz#09488fbb9416a4efe3735b7235055442b042481d" + integrity sha512-Gx4L3uM182jEEayZfRbI/G11ZpYdNAnBs70lFVMNdHJI76XYtR+7m0MN+eAs7UHBPhWXcnFPaS+9owSCJQHNpQ== + dependencies: + "@babel/runtime" "^7.15.4" + "@types/react-redux" "^7.1.20" + hoist-non-react-statics "^3.3.2" + loose-envify "^1.4.0" + prop-types "^15.7.2" + react-is "^17.0.2" + react-router-config@^5.1.1: version "5.1.1" resolved "https://registry.yarnpkg.com/react-router-config/-/react-router-config-5.1.1.tgz#0f4263d1a80c6b2dc7b9c1902c9526478194a988" @@ -7684,9 +8933,9 @@ react-router@5.3.4, react-router@^5.3.3: tiny-warning "^1.0.0" react-textarea-autosize@^8.3.2: - version "8.3.4" - resolved "https://registry.yarnpkg.com/react-textarea-autosize/-/react-textarea-autosize-8.3.4.tgz#270a343de7ad350534141b02c9cb78903e553524" - integrity sha512-CdtmP8Dc19xL8/R6sWvtknD/eCXkQr30dtvC4VmGInhRsfF8X/ihXCq6+9l9qbxmKRiq407/7z5fxE7cVWQNgQ== + version "8.4.0" + resolved "https://registry.yarnpkg.com/react-textarea-autosize/-/react-textarea-autosize-8.4.0.tgz#4d0244d6a50caa897806b8c44abc0540a69bfc8c" + integrity sha512-YrTFaEHLgJsi8sJVYHBzYn+mkP3prGkmP2DKb/tm0t7CLJY5t1Rxix8070LAKb0wby7bl/lf2EeHkuMihMZMwQ== dependencies: "@babel/runtime" "^7.10.2" use-composed-ref "^1.3.0" @@ -7720,7 +8969,7 @@ readable-stream@^2.0.1: string_decoder "~1.1.1" util-deprecate "~1.0.1" -readable-stream@^3.0.6, readable-stream@^3.1.1: +readable-stream@^3.0.6, readable-stream@^3.1.1, readable-stream@^3.6.0: version "3.6.0" resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.6.0.tgz#337bbda3adc0706bd3e024426a286d4b4b2c9198" integrity sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA== @@ -7755,6 +9004,28 @@ recursive-readdir@^2.2.2: dependencies: minimatch "^3.0.5" +redux-devtools-extension@^2.13.8: + version "2.13.9" + resolved "https://registry.yarnpkg.com/redux-devtools-extension/-/redux-devtools-extension-2.13.9.tgz#6b764e8028b507adcb75a1cae790f71e6be08ae7" + integrity sha512-cNJ8Q/EtjhQaZ71c8I9+BPySIBVEKssbPpskBfsXqb8HJ002A3KRVHfeRzwRo6mGPqsm7XuHTqNSNeS1Khig0A== + +redux-thunk@^2.4.2: + version "2.4.2" + resolved "https://registry.yarnpkg.com/redux-thunk/-/redux-thunk-2.4.2.tgz#b9d05d11994b99f7a91ea223e8b04cf0afa5ef3b" + integrity sha512-+P3TjtnP0k/FEjcBL5FZpoovtvrTNT/UXd4/sluaSyrURlSlhLSzEdfsTBW7WsKB6yPvgd7q/iZPICFjW4o57Q== + +redux@^4.0.0, redux@^4.2.0: + version "4.2.1" + resolved "https://registry.yarnpkg.com/redux/-/redux-4.2.1.tgz#c08f4306826c49b5e9dc901dee0452ea8fce6197" + integrity sha512-LAUYz4lc+Do8/g7aeRa8JkyDErK6ekstQaqWQrNRW//MY1TvCEpMtpTWvlQ+FPbWCx+Xixu/6SHt5N0HR+SB4w== + dependencies: + "@babel/runtime" "^7.9.2" + +reftools@^1.1.6, reftools@^1.1.9: + version "1.1.9" + resolved "https://registry.yarnpkg.com/reftools/-/reftools-1.1.9.tgz#e16e19f662ccd4648605312c06d34e5da3a2b77e" + integrity sha512-OVede/NQE13xBQ+ob5CKd5KyeJYU2YInb1bmV4nRoOfquZPkAkxuOXicSe1PvqIuZZ4kD13sPKBbR7UFDmli6w== + regenerate-unicode-properties@^10.1.0: version "10.1.0" resolved "https://registry.yarnpkg.com/regenerate-unicode-properties/-/regenerate-unicode-properties-10.1.0.tgz#7c3192cab6dd24e21cb4461e5ddd7dd24fa8374c" @@ -7767,29 +9038,36 @@ regenerate@^1.4.2: resolved "https://registry.yarnpkg.com/regenerate/-/regenerate-1.4.2.tgz#b9346d8827e8f5a32f7ba29637d398b69014848a" integrity sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A== -regenerator-runtime@^0.13.10, regenerator-runtime@^0.13.4: - version "0.13.10" - resolved "https://registry.yarnpkg.com/regenerator-runtime/-/regenerator-runtime-0.13.10.tgz#ed07b19616bcbec5da6274ebc75ae95634bfc2ee" - integrity sha512-KepLsg4dU12hryUO7bp/axHAKvwGOCV0sGloQtpagJ12ai+ojVDqkeGSiRX1zlq+kjIMZ1t7gpze+26QqtdGqw== +regenerator-runtime@^0.13.11, regenerator-runtime@^0.13.4: + version "0.13.11" + resolved "https://registry.yarnpkg.com/regenerator-runtime/-/regenerator-runtime-0.13.11.tgz#f6dca3e7ceec20590d07ada785636a90cdca17f9" + integrity sha512-kY1AZVr2Ra+t+piVaJ4gxaFaReZVH40AKNo7UCX6W+dEwBo/2oZJzqfuN1qLq1oL45o56cPaTXELwrTh8Fpggg== -regenerator-transform@0.15.0, regenerator-transform@^0.15.0: +regenerator-transform@0.15.0: version "0.15.0" resolved "https://registry.yarnpkg.com/regenerator-transform/-/regenerator-transform-0.15.0.tgz#cbd9ead5d77fae1a48d957cf889ad0586adb6537" integrity sha512-LsrGtPmbYg19bcPHwdtmXwbW+TqNvtY4riE3P83foeHRroMbH6/2ddFBfab3t7kbzc7v7p4wbkIecHImqt0QNg== dependencies: "@babel/runtime" "^7.8.4" -regexpu-core@^5.1.0: - version "5.2.1" - resolved "https://registry.yarnpkg.com/regexpu-core/-/regexpu-core-5.2.1.tgz#a69c26f324c1e962e9ffd0b88b055caba8089139" - integrity sha512-HrnlNtpvqP1Xkb28tMhBUO2EbyUHdQlsnlAhzWcwHy8WJR53UWr7/MAvqrsQKMbV4qdpv03oTMG8iIhfsPFktQ== +regenerator-transform@^0.15.0, regenerator-transform@^0.15.1: + version "0.15.1" + resolved "https://registry.yarnpkg.com/regenerator-transform/-/regenerator-transform-0.15.1.tgz#f6c4e99fc1b4591f780db2586328e4d9a9d8dc56" + integrity sha512-knzmNAcuyxV+gQCufkYcvOqX/qIIfHLv0u5x79kRxuGojfYVky1f15TzZEu2Avte8QGepvUNTnLskf8E6X6Vyg== dependencies: + "@babel/runtime" "^7.8.4" + +regexpu-core@^5.3.1: + version "5.3.1" + resolved "https://registry.yarnpkg.com/regexpu-core/-/regexpu-core-5.3.1.tgz#66900860f88def39a5cb79ebd9490e84f17bcdfb" + integrity sha512-nCOzW2V/X15XpLsK2rlgdwrysrBq+AauCn+omItIz4R1pIcmeot5zvjdmOBRLzEH/CkC6IxMJVmxDe3QcMuNVQ== + dependencies: + "@babel/regjsgen" "^0.8.0" regenerate "^1.4.2" regenerate-unicode-properties "^10.1.0" - regjsgen "^0.7.1" regjsparser "^0.9.1" unicode-match-property-ecmascript "^2.0.0" - unicode-match-property-value-ecmascript "^2.0.0" + unicode-match-property-value-ecmascript "^2.1.0" registry-auth-token@^4.0.0: version "4.2.2" @@ -7805,11 +9083,6 @@ registry-url@^5.0.0: dependencies: rc "^1.2.8" -regjsgen@^0.7.1: - version "0.7.1" - resolved "https://registry.yarnpkg.com/regjsgen/-/regjsgen-0.7.1.tgz#ee5ef30e18d3f09b7c369b76e7c2373ed25546f6" - integrity sha512-RAt+8H2ZEzHeYWxZ3H2z6tF18zyyOnlcdaafLrm21Bguj7uZy6ULibiAFdXEtKQY4Sy7wDTwDiOazasMLc4KPA== - regjsparser@^0.9.1: version "0.9.1" resolved "https://registry.yarnpkg.com/regjsparser/-/regjsparser-0.9.1.tgz#272d05aa10c7c1f67095b1ff0addae8442fc5709" @@ -7817,6 +9090,15 @@ regjsparser@^0.9.1: dependencies: jsesc "~0.5.0" +rehype-raw@^6.1.1: + version "6.1.1" + resolved "https://registry.yarnpkg.com/rehype-raw/-/rehype-raw-6.1.1.tgz#81bbef3793bd7abacc6bf8335879d1b6c868c9d4" + integrity sha512-d6AKtisSRtDRX4aSPsJGTfnzrX2ZkHQLE5kiUuGOeEoLpbEulFF4hj0mLPbsa+7vmguDKOVVEQdHKDSwoaIDsQ== + dependencies: + "@types/hast" "^2.0.0" + hast-util-raw "^7.2.0" + unified "^10.0.0" + relateurl@^0.2.7: version "0.2.7" resolved "https://registry.yarnpkg.com/relateurl/-/relateurl-0.2.7.tgz#54dbf377e51440aca90a4cd274600d3ff2d888a9" @@ -7872,6 +9154,25 @@ remark-parse@8.0.3: vfile-location "^3.0.0" xtend "^4.0.1" +remark-parse@^10.0.0: + version "10.0.1" + resolved "https://registry.yarnpkg.com/remark-parse/-/remark-parse-10.0.1.tgz#6f60ae53edbf0cf38ea223fe643db64d112e0775" + integrity sha512-1fUyHr2jLsVOkhbvPRBJ5zTKZZyD6yZzYaWCS6BPBdQ8vEMBCH+9zNCDA6tET/zHCi/jLqjCWtlJZUPk+DbnFw== + dependencies: + "@types/mdast" "^3.0.0" + mdast-util-from-markdown "^1.0.0" + unified "^10.0.0" + +remark-rehype@^10.0.0: + version "10.1.0" + resolved "https://registry.yarnpkg.com/remark-rehype/-/remark-rehype-10.1.0.tgz#32dc99d2034c27ecaf2e0150d22a6dcccd9a6279" + integrity sha512-EFmR5zppdBp0WQeDVZ/b66CWJipB2q2VLNFMabzDSGR66Z2fQii83G5gTBbgGEnEEA0QRussvrFHxk1HWGJskw== + dependencies: + "@types/hast" "^2.0.0" + "@types/mdast" "^3.0.0" + mdast-util-to-hast "^12.1.0" + unified "^10.0.0" + remark-squeeze-paragraphs@4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/remark-squeeze-paragraphs/-/remark-squeeze-paragraphs-4.0.0.tgz#76eb0e085295131c84748c8e43810159c5653ead" @@ -7895,6 +9196,11 @@ repeat-string@^1.5.4: resolved "https://registry.yarnpkg.com/repeat-string/-/repeat-string-1.6.1.tgz#8dcae470e1c88abc2d600fff4a776286da75e637" integrity sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w== +require-directory@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/require-directory/-/require-directory-2.1.1.tgz#8c64ad5fd30dab1c976e2344ffe7f792a6a6df42" + integrity sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q== + require-from-string@^2.0.2: version "2.0.2" resolved "https://registry.yarnpkg.com/require-from-string/-/require-from-string-2.0.2.tgz#89a7fdd938261267318eafe14f9c32e598c36909" @@ -7905,11 +9211,21 @@ require-from-string@^2.0.2: resolved "https://registry.yarnpkg.com/require-like/-/require-like-0.1.2.tgz#ad6f30c13becd797010c468afa775c0c0a6b47fa" integrity sha512-oyrU88skkMtDdauHDuKVrgR+zuItqr6/c//FXzvmxRGMexSDc6hNvJInGW3LL46n+8b50RykrvwSUIIQH2LQ5A== +require-main-filename@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/require-main-filename/-/require-main-filename-2.0.0.tgz#d0b329ecc7cc0f61649f62215be69af54aa8989b" + integrity sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg== + requires-port@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/requires-port/-/requires-port-1.0.0.tgz#925d2601d39ac485e091cf0da5c6e694dc3dcaff" integrity sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ== +reselect@^4.1.7: + version "4.1.7" + resolved "https://registry.yarnpkg.com/reselect/-/reselect-4.1.7.tgz#56480d9ff3d3188970ee2b76527bd94a95567a42" + integrity sha512-Zu1xbUt3/OPwsXL46hvOOoQrap2azE7ZQbokq61BQfiXvhewsKDwhMeZjTX9sX0nvw1t/U5Audyn1I9P/m9z0A== + resolve-from@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-4.0.0.tgz#4abcd852ad32dd7baabfe9b40e00a36db5f392e6" @@ -7993,12 +9309,19 @@ rxjs@7.5.5: tslib "^2.1.0" rxjs@^7.5.4: - version "7.5.7" - resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-7.5.7.tgz#2ec0d57fdc89ece220d2e702730ae8f1e49def39" - integrity sha512-z9MzKh/UcOqB3i20H6rtrlaE/CgjLOvheWK/9ILrbhROGTweAi1BaFsTT9FbwZi5Trr1qNRs+MXkhmR06awzQA== + version "7.8.0" + resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-7.8.0.tgz#90a938862a82888ff4c7359811a595e14e1e09a4" + integrity sha512-F2+gxDshqmIub1KdvZkaEfGDwLNpPvk9Fs6LD/MyQxNgMds/WH9OdDDXOmxUZpME+iSK3rQCctkL0DYyytUqMg== dependencies: tslib "^2.1.0" +sade@^1.7.3: + version "1.8.1" + resolved "https://registry.yarnpkg.com/sade/-/sade-1.8.1.tgz#0a78e81d658d394887be57d2a409bf703a3b2701" + integrity sha512-xal3CZX1Xlo/k4ApwCFrHVACi9fBqJ7V+mwhBsuf/1IOKbBy098Fex+Wa/5QMubw09pSZ/u8EY8PWgevJsXp1A== + dependencies: + mri "^1.1.0" + safe-buffer@5.1.2, safe-buffer@~5.1.0, safe-buffer@~5.1.1: version "5.1.2" resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d" @@ -8098,6 +9421,13 @@ semver-diff@^3.1.1: dependencies: semver "^6.3.0" +semver@7.3.5: + version "7.3.5" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.5.tgz#0b621c879348d8998e4b0e4be94b3f12e6018ef7" + integrity sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ== + dependencies: + lru-cache "^6.0.0" + semver@^5.4.1: version "5.7.1" resolved "https://registry.yarnpkg.com/semver/-/semver-5.7.1.tgz#a954f931aeba508d307bbf069eff0c01c96116f7" @@ -8108,7 +9438,7 @@ semver@^6.0.0, semver@^6.1.1, semver@^6.1.2, semver@^6.2.0, semver@^6.3.0: resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d" integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw== -semver@^7.3.2, semver@^7.3.4, semver@^7.3.5, semver@^7.3.7: +semver@^7.3.2, semver@^7.3.4, semver@^7.3.5, semver@^7.3.7, semver@^7.3.8: version "7.3.8" resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.8.tgz#07a78feafb3f7b32347d725e33de7e2a2df67798" integrity sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A== @@ -8135,9 +9465,9 @@ send@0.18.0: statuses "2.0.1" serialize-javascript@^6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/serialize-javascript/-/serialize-javascript-6.0.0.tgz#efae5d88f45d7924141da8b5c3a7a7e663fefeb8" - integrity sha512-Qr3TosvguFt8ePWqsvRfrKyQXIiW+nGbYpy8XK24NQHE83caxWt+mIymTT19DGFbNWNLfEwsrkSmN64lVWB9ag== + version "6.0.1" + resolved "https://registry.yarnpkg.com/serialize-javascript/-/serialize-javascript-6.0.1.tgz#b206efb27c3da0b0ab6b52f48d170b7996458e5c" + integrity sha512-owoXEFjWRllis8/M1Q+Cw5k8ZH40e3zhp/ovX+Xr/vi1qj6QesbyXXViFbpNvWvPNAD62SutwEXavefrLJWj7w== dependencies: randombytes "^2.1.0" @@ -8178,6 +9508,11 @@ serve-static@1.15.0: parseurl "~1.3.3" send "0.18.0" +set-blocking@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/set-blocking/-/set-blocking-2.0.0.tgz#045f9782d011ae9a6803ddd382b24392b3d890f7" + integrity sha512-KiKBS8AnWGEyLzofFfmvKwpdPzqiy16LvQfK3yv/fVH7Bj13/wl3JSR1J+rfgRE9q7xUJK4qvgS8raSOeLUehw== + setimmediate@^1.0.5: version "1.0.5" resolved "https://registry.yarnpkg.com/setimmediate/-/setimmediate-1.0.5.tgz#290cbb232e306942d7d7ea9b83732ab7856f8285" @@ -8218,9 +9553,9 @@ shebang-regex@^3.0.0: integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== shell-quote@^1.7.3: - version "1.7.4" - resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.7.4.tgz#33fe15dee71ab2a81fcbd3a52106c5cfb9fb75d8" - integrity sha512-8o/QEhSSRb1a5i7TFR0iM4G16Z0vYB2OQVs4G3aAFXjn3T6yEx8AZxy1PgDF7I00LZHYA3WxaSYIf5e5sAX8Rw== + version "1.8.0" + resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.8.0.tgz#20d078d0eaf71d54f43bd2ba14a1b5b9bfa5c8ba" + integrity sha512-QHsz8GgQIGKlRi24yFc6a6lN69Idnx634w49ay6+jA5yFh7a1UY+4Rp6HPx/L/1zcEDPEij8cIsiqR6bQsE5VQ== shelljs@^0.8.5: version "0.8.5" @@ -8231,6 +9566,50 @@ shelljs@^0.8.5: interpret "^1.0.0" rechoir "^0.6.2" +should-equal@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/should-equal/-/should-equal-2.0.0.tgz#6072cf83047360867e68e98b09d71143d04ee0c3" + integrity sha512-ZP36TMrK9euEuWQYBig9W55WPC7uo37qzAEmbjHz4gfyuXrEUgF8cUvQVO+w+d3OMfPvSRQJ22lSm8MQJ43LTA== + dependencies: + should-type "^1.4.0" + +should-format@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/should-format/-/should-format-3.0.3.tgz#9bfc8f74fa39205c53d38c34d717303e277124f1" + integrity sha512-hZ58adtulAk0gKtua7QxevgUaXTTXxIi8t41L3zo9AHvjXO1/7sdLECuHeIN2SRtYXpNkmhoUP2pdeWgricQ+Q== + dependencies: + should-type "^1.3.0" + should-type-adaptors "^1.0.1" + +should-type-adaptors@^1.0.1: + version "1.1.0" + resolved "https://registry.yarnpkg.com/should-type-adaptors/-/should-type-adaptors-1.1.0.tgz#401e7f33b5533033944d5cd8bf2b65027792e27a" + integrity sha512-JA4hdoLnN+kebEp2Vs8eBe9g7uy0zbRo+RMcU0EsNy+R+k049Ki+N5tT5Jagst2g7EAja+euFuoXFCa8vIklfA== + dependencies: + should-type "^1.3.0" + should-util "^1.0.0" + +should-type@^1.3.0, should-type@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/should-type/-/should-type-1.4.0.tgz#0756d8ce846dfd09843a6947719dfa0d4cff5cf3" + integrity sha512-MdAsTu3n25yDbIe1NeN69G4n6mUnJGtSJHygX3+oN0ZbO3DTiATnf7XnYJdGT42JCXurTb1JI0qOBR65shvhPQ== + +should-util@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/should-util/-/should-util-1.0.1.tgz#fb0d71338f532a3a149213639e2d32cbea8bcb28" + integrity sha512-oXF8tfxx5cDk8r2kYqlkUJzZpDBqVY/II2WhvU0n9Y3XYvAYRmeaf1PvvIvTgPnv4KJ+ES5M0PyDq5Jp+Ygy2g== + +should@^13.2.1: + version "13.2.3" + resolved "https://registry.yarnpkg.com/should/-/should-13.2.3.tgz#96d8e5acf3e97b49d89b51feaa5ae8d07ef58f10" + integrity sha512-ggLesLtu2xp+ZxI+ysJTmNjh2U0TsC+rQ/pfED9bUZZ4DKefP27D+7YJVVTvKsmjLpIi9jAa7itwDGkDDmt1GQ== + dependencies: + should-equal "^2.0.0" + should-format "^3.0.3" + should-type "^1.4.0" + should-type-adaptors "^1.0.1" + should-util "^1.0.0" + side-channel@1.0.4, side-channel@^1.0.4: version "1.0.4" resolved "https://registry.yarnpkg.com/side-channel/-/side-channel-1.0.4.tgz#efce5c8fdc104ee751b25c58d4290011fa5ea2cf" @@ -8279,6 +9658,11 @@ slash@^4.0.0: resolved "https://registry.yarnpkg.com/slash/-/slash-4.0.0.tgz#2422372176c4c6c5addb5e2ada885af984b396a7" integrity sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew== +slugify@^1.6.5: + version "1.6.5" + resolved "https://registry.yarnpkg.com/slugify/-/slugify-1.6.5.tgz#c8f5c072bf2135b80703589b39a3d41451fbe8c8" + integrity sha512-8mo9bslnBO3tr5PEVFzMPIWwWnipGS0xVbYf65zxDqfNwmzYn1LpiKNrR6DlClusuvo+hDHd1zKpmfAe83NQSQ== + sockjs@^0.3.21, sockjs@^0.3.24: version "0.3.24" resolved "https://registry.yarnpkg.com/sockjs/-/sockjs-0.3.24.tgz#c9bc8995f33a111bea0395ec30aa3206bdb5ccce" @@ -8331,6 +9715,11 @@ space-separated-tokens@^1.0.0: resolved "https://registry.yarnpkg.com/space-separated-tokens/-/space-separated-tokens-1.1.5.tgz#85f32c3d10d9682007e917414ddc5c26d1aa6899" integrity sha512-q/JSVd1Lptzhf5bkYm4ob4iWPjx0KiRe3sRFBNrVqbJkFaBm5vbbowy1mymoPNLRa52+oadOhJ+K49wsSeSjTA== +space-separated-tokens@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz#1ecd9d2350a3844572c3f4a312bceb018348859f" + integrity sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q== + spdy-transport@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/spdy-transport/-/spdy-transport-3.0.0.tgz#00d4863a6400ad75df93361a1608605e5dcdcf31" @@ -8380,11 +9769,11 @@ statuses@2.0.1: integrity sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA== std-env@^3.0.1: - version "3.3.0" - resolved "https://registry.yarnpkg.com/std-env/-/std-env-3.3.0.tgz#86b5b5d416c5744b3fdeac6893c2b98196fc1a55" - integrity sha512-cNNS+VYsXIs5gI6gJipO4qZ8YYT274JHvNnQ1/R/x8Q8mdP0qj0zoMchRXmBNPqp/0eOEhX+3g7g6Fgb7meLIQ== + version "3.3.2" + resolved "https://registry.yarnpkg.com/std-env/-/std-env-3.3.2.tgz#af27343b001616015534292178327b202b9ee955" + integrity sha512-uUZI65yrV2Qva5gqE0+A7uVAvO40iPo6jGhs7s8keRfHCmtg+uB2X6EiLGCI9IgL1J17xGhvoOqSz79lzICPTA== -string-width@^4.0.0, string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.2: +string-width@^4.0.0, string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.2, string-width@^4.2.3: version "4.2.3" resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== @@ -8466,6 +9855,13 @@ style-to-object@0.3.0, style-to-object@^0.3.0: dependencies: inline-style-parser "0.1.1" +style-to-object@^0.4.0: + version "0.4.1" + resolved "https://registry.yarnpkg.com/style-to-object/-/style-to-object-0.4.1.tgz#53cf856f7cf7f172d72939d9679556469ba5de37" + integrity sha512-HFpbb5gr2ypci7Qw+IOhnP2zOU7e77b+rzM+wTzXzfi1PrtBCX0E7Pk4wL4iTLnhzZ+JgEGAhX81ebTg/aYjQw== + dependencies: + inline-style-parser "0.1.1" + stylehacks@5.1.0: version "5.1.0" resolved "https://registry.yarnpkg.com/stylehacks/-/stylehacks-5.1.0.tgz#a40066490ca0caca04e96c6b02153ddc39913520" @@ -8482,11 +9878,40 @@ stylehacks@^5.1.0, stylehacks@^5.1.1: browserslist "^4.21.4" postcss-selector-parser "^6.0.4" -stylis@^4.0.10: +stylis@^4.1.2: version "4.1.3" resolved "https://registry.yarnpkg.com/stylis/-/stylis-4.1.3.tgz#fd2fbe79f5fed17c55269e16ed8da14c84d069f7" integrity sha512-GP6WDNWf+o403jrEp9c5jibKavrtLW+/qYGhFxFrG8maXhwTBI7gLLhiBb0o7uFccWN+EOS9aMO6cGHWAO07OA== +sucrase@^3.21.0: + version "3.29.0" + resolved "https://registry.yarnpkg.com/sucrase/-/sucrase-3.29.0.tgz#3207c5bc1b980fdae1e539df3f8a8a518236da7d" + integrity sha512-bZPAuGA5SdFHuzqIhTAqt9fvNEo9rESqXIG3oiKdF8K4UmkQxC4KlNL3lVyAErXp+mPvUqZ5l13qx6TrDIGf3A== + dependencies: + commander "^4.0.0" + glob "7.1.6" + lines-and-columns "^1.1.6" + mz "^2.7.0" + pirates "^4.0.1" + ts-interface-checker "^0.1.9" + +superagent@^7.1.6: + version "7.1.6" + resolved "https://registry.yarnpkg.com/superagent/-/superagent-7.1.6.tgz#64f303ed4e4aba1e9da319f134107a54cacdc9c6" + integrity sha512-gZkVCQR1gy/oUXr+kxJMLDjla434KmSOKbx5iGD30Ql+AkJQ/YlPKECJy2nhqOsHLjGHzoDTXNSjhnvWhzKk7g== + dependencies: + component-emitter "^1.3.0" + cookiejar "^2.1.3" + debug "^4.3.4" + fast-safe-stringify "^2.1.1" + form-data "^4.0.0" + formidable "^2.0.1" + methods "^1.1.2" + mime "2.6.0" + qs "^6.10.3" + readable-stream "^3.6.0" + semver "^7.3.7" + supports-color@^5.3.0: version "5.5.0" resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f" @@ -8531,10 +9956,32 @@ svgo@^2.5.0, svgo@^2.7.0, svgo@^2.8.0: picocolors "^1.0.0" stable "^0.1.8" +swagger2openapi@^7.0.8: + version "7.0.8" + resolved "https://registry.yarnpkg.com/swagger2openapi/-/swagger2openapi-7.0.8.tgz#12c88d5de776cb1cbba758994930f40ad0afac59" + integrity sha512-upi/0ZGkYgEcLeGieoz8gT74oWHA0E7JivX7aN9mAf+Tc7BQoRBvnIGHoPDw+f9TXTW4s6kGYCZJtauP6OYp7g== + dependencies: + call-me-maybe "^1.0.1" + node-fetch "^2.6.1" + node-fetch-h2 "^2.3.0" + node-readfiles "^0.2.0" + oas-kit-common "^1.0.8" + oas-resolver "^2.5.6" + oas-schema-walker "^1.1.5" + oas-validator "^5.0.8" + reftools "^1.1.9" + yaml "^1.10.0" + yargs "^17.0.1" + +swc-loader@^0.2.3: + version "0.2.3" + resolved "https://registry.yarnpkg.com/swc-loader/-/swc-loader-0.2.3.tgz#6792f1c2e4c9ae9bf9b933b3e010210e270c186d" + integrity sha512-D1p6XXURfSPleZZA/Lipb3A8pZ17fP4NObZvFCDjK/OKljroqDpPmsBdTraWhVBqUNpcWBQY1imWdoPScRlQ7A== + tailwindcss@^3.2.4: - version "3.2.4" - resolved "https://registry.yarnpkg.com/tailwindcss/-/tailwindcss-3.2.4.tgz#afe3477e7a19f3ceafb48e4b083e292ce0dc0250" - integrity sha512-AhwtHCKMtR71JgeYDaswmZXhPcW9iuI9Sp2LvZPo9upDZ7231ZJ7eA9RaURbhpXGVlrjX4cFNlB4ieTetEb7hQ== + version "3.2.7" + resolved "https://registry.yarnpkg.com/tailwindcss/-/tailwindcss-3.2.7.tgz#5936dd08c250b05180f0944500c01dce19188c07" + integrity sha512-B6DLqJzc21x7wntlH/GsZwEXTBttVSl1FtCzC8WP4oBc/NKef7kaax5jeihkkCEWc831/5NDJ9gRNDK6NEioQQ== dependencies: arg "^5.0.2" chokidar "^3.5.3" @@ -8550,12 +9997,12 @@ tailwindcss@^3.2.4: normalize-path "^3.0.0" object-hash "^3.0.0" picocolors "^1.0.0" - postcss "^8.4.18" + postcss "^8.0.9" postcss-import "^14.1.0" postcss-js "^4.0.0" postcss-load-config "^3.1.4" postcss-nested "6.0.0" - postcss-selector-parser "^6.0.10" + postcss-selector-parser "^6.0.11" postcss-value-parser "^4.2.0" quick-lru "^5.1.1" resolve "^1.22.1" @@ -8593,9 +10040,9 @@ terser-webpack-plugin@^5.1.3, terser-webpack-plugin@^5.3.3: terser "^5.14.1" terser@^5.10.0, terser@^5.14.1, terser@^5.7.2: - version "5.15.1" - resolved "https://registry.yarnpkg.com/terser/-/terser-5.15.1.tgz#8561af6e0fd6d839669c73b92bdd5777d870ed6c" - integrity sha512-K1faMUvpm/FBxjBXud0LWVAGxmvoPbZbfTCYbSgaaYQaIXI3/TdI7a7ZGA73Zrou6Q8Zmz3oeUTsp/dj+ag2Xw== + version "5.16.4" + resolved "https://registry.yarnpkg.com/terser/-/terser-5.16.4.tgz#51284b440b93242291a98f2a9903c024cfb70e6e" + integrity sha512-5yEGuZ3DZradbogeYQ1NaGz7rXVBDWujWlx1PT8efXO6Txn+eWbfKqB2bTDVmFXmePFkoLU6XI8UektMIEA0ug== dependencies: "@jridgewell/source-map" "^0.3.2" acorn "^8.5.0" @@ -8607,6 +10054,20 @@ text-table@^0.2.0: resolved "https://registry.yarnpkg.com/text-table/-/text-table-0.2.0.tgz#7f5ee823ae805207c00af2df4a84ec3fcfa570b4" integrity sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw== +thenify-all@^1.0.0: + version "1.6.0" + resolved "https://registry.yarnpkg.com/thenify-all/-/thenify-all-1.6.0.tgz#1a1918d402d8fc3f98fbf234db0bcc8cc10e9726" + integrity sha512-RNxQH/qI8/t3thXJDwcstUO4zeqo64+Uy/+sNVRBx4Xn2OX+OZ9oP+iJnNFqplFra2ZUVeKCSa2oVWi3T4uVmA== + dependencies: + thenify ">= 3.1.0 < 4" + +"thenify@>= 3.1.0 < 4": + version "3.3.1" + resolved "https://registry.yarnpkg.com/thenify/-/thenify-3.3.1.tgz#8932e686a4066038a016dd9e2ca46add9838a95f" + integrity sha512-RVZSIV5IG10Hk3enotrhvz0T9em6cyHBLkH/YAZuKqd8hRkKhSfCGIcP2KUY0EPxndzANBmNllzWPwak+bheSw== + dependencies: + any-promise "^1.0.0" + thunky@^1.0.2: version "1.1.0" resolved "https://registry.yarnpkg.com/thunky/-/thunky-1.1.0.tgz#5abaf714a9405db0504732bbccd2cedd9ef9537d" @@ -8654,6 +10115,11 @@ tr46@~0.0.3: resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a" integrity sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw== +trim-lines@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/trim-lines/-/trim-lines-3.0.1.tgz#d802e332a07df861c48802c04321017b1bd87338" + integrity sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg== + trim-trailing-lines@^1.0.0: version "1.1.4" resolved "https://registry.yarnpkg.com/trim-trailing-lines/-/trim-trailing-lines-1.1.4.tgz#bd4abbec7cc880462f10b2c8b5ce1d8d1ec7c2c0" @@ -8669,10 +10135,25 @@ trough@^1.0.0: resolved "https://registry.yarnpkg.com/trough/-/trough-1.0.5.tgz#b8b639cefad7d0bb2abd37d433ff8293efa5f406" integrity sha512-rvuRbTarPXmMb79SmzEp8aqXNKcK+y0XaB298IXueQ8I2PsrATcPBCSPyK/dDNa2iWOhKlfNnOjdAOTBU/nkFA== +trough@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/trough/-/trough-2.1.0.tgz#0f7b511a4fde65a46f18477ab38849b22c554876" + integrity sha512-AqTiAOLcj85xS7vQ8QkAV41hPDIJ71XJB4RCUrzo/1GM2CQwhkJGaf9Hgr7BOugMRpgGUrqRg/DrBDl4H40+8g== + +ts-dedent@^2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/ts-dedent/-/ts-dedent-2.2.0.tgz#39e4bd297cd036292ae2394eb3412be63f563bb5" + integrity sha512-q5W7tVM71e2xjHZTlgfTDoPF/SmqKG5hddq9SzR49CH2hayqRKJtQ4mtRlSxKaJlR/+9rEM+mnBHf7I2/BQcpQ== + +ts-interface-checker@^0.1.9: + version "0.1.13" + resolved "https://registry.yarnpkg.com/ts-interface-checker/-/ts-interface-checker-0.1.13.tgz#784fd3d679722bc103b1b4b8030bcddb5db2a699" + integrity sha512-Y/arvbn+rrz3JCKl9C4kVNfTfSm2/mEp5FSz5EsZSANGPSlQrpRI5M4PKF+mJnE52jOO90PnPSc3Ur3bTQw0gA== + tslib@^2.0.3, tslib@^2.1.0, tslib@^2.4.0: - version "2.4.1" - resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.4.1.tgz#0d0bfbaac2880b91e22df0768e55be9753a5b17e" - integrity sha512-tGyy4dAjRIEwI7BzsB0lynWgOpfqjUdq91XXAlIWD2OwKBH7oCl/GZG/HT4BOHrTlPMOASlMQ7veyTqpmRcrNA== + version "2.5.0" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.5.0.tgz#42bfed86f5787aeb41d031866c8f402429e0fddf" + integrity sha512-336iVw3rtn2BUK7ORdIAHTyxHGRIHVReokCR3XjbckJMK7ms8FysBfhLR8IXnAgy7T0PTPNBWKiH514FOW/WSg== type-fest@2.12.2: version "2.12.2" @@ -8730,10 +10211,10 @@ unicode-match-property-ecmascript@^2.0.0: unicode-canonical-property-names-ecmascript "^2.0.0" unicode-property-aliases-ecmascript "^2.0.0" -unicode-match-property-value-ecmascript@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.0.0.tgz#1a01aa57247c14c568b89775a54938788189a714" - integrity sha512-7Yhkc0Ye+t4PNYzOGKedDhXbYIBe1XEQYQxOPyhcXNMJ0WCABqqj6ckydd6pWRZTHV4GuCPKdBAUiMc60tsKVw== +unicode-match-property-value-ecmascript@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.1.0.tgz#cb5fffdcd16a05124f5a4b0bf7c3770208acbbe0" + integrity sha512-qxkjQt6qjg/mYscYMC0XKRn3Rh0wFPlfxB0xkt9CfyTvpX1Ra0+rAmdX2QyAobptSEvuy4RtpPRui6XkV+8wjA== unicode-property-aliases-ecmascript@^2.0.0: version "2.1.0" @@ -8752,6 +10233,19 @@ unified@9.2.0: trough "^1.0.0" vfile "^4.0.0" +unified@^10.0.0: + version "10.1.2" + resolved "https://registry.yarnpkg.com/unified/-/unified-10.1.2.tgz#b1d64e55dafe1f0b98bb6c719881103ecf6c86df" + integrity sha512-pUSWAi/RAnVy1Pif2kAoeWNBa3JVrx0MId2LASj8G+7AiHWoKZNTomq6LG326T68U7/e263X6fTdcXIy7XnF7Q== + dependencies: + "@types/unist" "^2.0.0" + bail "^2.0.0" + extend "^3.0.0" + is-buffer "^2.0.0" + is-plain-obj "^4.0.0" + trough "^2.0.0" + vfile "^5.0.0" + unified@^9.2.2: version "9.2.2" resolved "https://registry.yarnpkg.com/unified/-/unified-9.2.2.tgz#67649a1abfc3ab85d2969502902775eb03146975" @@ -8781,16 +10275,33 @@ unist-util-generated@^1.0.0: resolved "https://registry.yarnpkg.com/unist-util-generated/-/unist-util-generated-1.1.6.tgz#5ab51f689e2992a472beb1b35f2ce7ff2f324d4b" integrity sha512-cln2Mm1/CZzN5ttGK7vkoGw+RZ8VcUH6BtGbq98DDtRGquAAOXig1mrBQYelOwMXYS8rK+vZDyyojSjp7JX+Lg== +unist-util-generated@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/unist-util-generated/-/unist-util-generated-2.0.1.tgz#e37c50af35d3ed185ac6ceacb6ca0afb28a85cae" + integrity sha512-qF72kLmPxAw0oN2fwpWIqbXAVyEqUzDHMsbtPvOudIlUzXYFIeQIuxXQCRCFh22B7cixvU0MG7m3MW8FTq/S+A== + unist-util-is@^4.0.0: version "4.1.0" resolved "https://registry.yarnpkg.com/unist-util-is/-/unist-util-is-4.1.0.tgz#976e5f462a7a5de73d94b706bac1b90671b57797" integrity sha512-ZOQSsnce92GrxSqlnEEseX0gi7GH9zTJZ0p9dtu87WRb/37mMPO2Ilx1s/t9vBHrFhbgweUwb+t7cIn5dxPhZg== +unist-util-is@^5.0.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/unist-util-is/-/unist-util-is-5.2.0.tgz#37eed0617b76c114fd34d44c201aa96fd928b309" + integrity sha512-Glt17jWwZeyqrFqOK0pF1Ded5U3yzJnFr8CG1GMjCWTp9zDo2p+cmD6pWbZU8AgM5WU3IzRv6+rBwhzsGh6hBQ== + unist-util-position@^3.0.0: version "3.1.0" resolved "https://registry.yarnpkg.com/unist-util-position/-/unist-util-position-3.1.0.tgz#1c42ee6301f8d52f47d14f62bbdb796571fa2d47" integrity sha512-w+PkwCbYSFw8vpgWD0v7zRCl1FpY3fjDSQ3/N/wNd9Ffa4gPi8+4keqt99N3XW6F99t/mUzp2xAhNmfKWp95QA== +unist-util-position@^4.0.0: + version "4.0.4" + resolved "https://registry.yarnpkg.com/unist-util-position/-/unist-util-position-4.0.4.tgz#93f6d8c7d6b373d9b825844645877c127455f037" + integrity sha512-kUBE91efOWfIVBo8xzh/uZQ7p9ffYRtUbMRZBNFYwf0RK8koUMx6dGUfwylLOKmaT2cs4wSW96QoYUSXAyEtpg== + dependencies: + "@types/unist" "^2.0.0" + unist-util-remove-position@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/unist-util-remove-position/-/unist-util-remove-position-2.0.1.tgz#5d19ca79fdba712301999b2b73553ca8f3b352cc" @@ -8812,6 +10323,13 @@ unist-util-stringify-position@^2.0.0: dependencies: "@types/unist" "^2.0.2" +unist-util-stringify-position@^3.0.0: + version "3.0.3" + resolved "https://registry.yarnpkg.com/unist-util-stringify-position/-/unist-util-stringify-position-3.0.3.tgz#03ad3348210c2d930772d64b489580c13a7db39d" + integrity sha512-k5GzIBZ/QatR8N5X2y+drfpWG8IDBzdnVj6OInRNWm1oXrzydiaAT2OQiA8DPRRZyAKb9b6I2a6PxYklZD0gKg== + dependencies: + "@types/unist" "^2.0.0" + unist-util-visit-parents@^3.0.0: version "3.1.1" resolved "https://registry.yarnpkg.com/unist-util-visit-parents/-/unist-util-visit-parents-3.1.1.tgz#65a6ce698f78a6b0f56aa0e88f13801886cdaef6" @@ -8820,6 +10338,14 @@ unist-util-visit-parents@^3.0.0: "@types/unist" "^2.0.0" unist-util-is "^4.0.0" +unist-util-visit-parents@^5.1.1: + version "5.1.3" + resolved "https://registry.yarnpkg.com/unist-util-visit-parents/-/unist-util-visit-parents-5.1.3.tgz#b4520811b0ca34285633785045df7a8d6776cfeb" + integrity sha512-x6+y8g7wWMyQhL1iZfhIPhDAs7Xwbn9nRosDXl7qoPTSCy0yNxnKc+hWokFifWQIDGi154rdUqKvbCa4+1kLhg== + dependencies: + "@types/unist" "^2.0.0" + unist-util-is "^5.0.0" + unist-util-visit@2.0.3, unist-util-visit@^2.0.0, unist-util-visit@^2.0.3: version "2.0.3" resolved "https://registry.yarnpkg.com/unist-util-visit/-/unist-util-visit-2.0.3.tgz#c3703893146df47203bb8a9795af47d7b971208c" @@ -8829,6 +10355,15 @@ unist-util-visit@2.0.3, unist-util-visit@^2.0.0, unist-util-visit@^2.0.3: unist-util-is "^4.0.0" unist-util-visit-parents "^3.0.0" +unist-util-visit@^4.0.0: + version "4.1.2" + resolved "https://registry.yarnpkg.com/unist-util-visit/-/unist-util-visit-4.1.2.tgz#125a42d1eb876283715a3cb5cceaa531828c72e2" + integrity sha512-MSd8OUGISqHdVvfY9TPhyK2VdUrPgxkUtWSuMHF6XAAFuL4LokseigBnZtPnJMu+FbynTkFNnFlyjxpVKujMRg== + dependencies: + "@types/unist" "^2.0.0" + unist-util-is "^5.0.0" + unist-util-visit-parents "^5.1.1" + universalify@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/universalify/-/universalify-2.0.0.tgz#75a4984efedc4b08975c5aeb73f530d02df25717" @@ -8839,7 +10374,7 @@ unpipe@1.0.0, unpipe@~1.0.0: resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec" integrity sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ== -update-browserslist-db@^1.0.9: +update-browserslist-db@^1.0.10: version "1.0.10" resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.0.10.tgz#0f54b876545726f17d00cd9a2561e6dade943ff3" integrity sha512-OztqDenkfFkbSG+tRxBeAnCVPckDBcvibKd35yDONx6OU8N7sqgwc7rCbkJ/WcYtVRZ4ba68d6byhC21GFh7sQ== @@ -8890,6 +10425,11 @@ url-parse-lax@^3.0.0: dependencies: prepend-http "^2.0.0" +url-template@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/url-template/-/url-template-3.1.0.tgz#d9be13d342ad31fcedc3c0bd21405fd141d02ff1" + integrity sha512-vB/eHWttzhN+NZzk9FcQB2h1cSEgb7zDYyvyxPhw02LYw7YqIzO+w1AqkcKvZ51gPH8o4+nyiWve/xuQqMdJZw== + url@^0.11.0: version "0.11.0" resolved "https://registry.yarnpkg.com/url/-/url-0.11.0.tgz#3838e97cfc60521eb73c525a8e55bfdd9e2e28f1" @@ -8903,6 +10443,11 @@ use-composed-ref@^1.3.0: resolved "https://registry.yarnpkg.com/use-composed-ref/-/use-composed-ref-1.3.0.tgz#3d8104db34b7b264030a9d916c5e94fbe280dbda" integrity sha512-GLMG0Jc/jiKov/3Ulid1wbv3r54K9HlMW29IWcDFPEqFkSO2nS0MuefWgMJpeHQ9YJeXDL3ZUF+P3jdXlZX/cQ== +use-editable@^2.3.3: + version "2.3.3" + resolved "https://registry.yarnpkg.com/use-editable/-/use-editable-2.3.3.tgz#a292fe9ba4c291cd28d1cc2728c75a5fc8d9a33f" + integrity sha512-7wVD2JbfAFJ3DK0vITvXBdpd9JAz5BcKAAolsnLBuBn6UDDwBGuCIAGvR3yA2BNKm578vAMVHFCWaOcA+BhhiA== + use-isomorphic-layout-effect@^1.1.1: version "1.1.2" resolved "https://registry.yarnpkg.com/use-isomorphic-layout-effect/-/use-isomorphic-layout-effect-1.1.2.tgz#497cefb13d863d687b08477d9e5a164ad8c1a6fb" @@ -8920,6 +10465,13 @@ util-deprecate@^1.0.1, util-deprecate@^1.0.2, util-deprecate@~1.0.1: resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" integrity sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw== +util@^0.10.3: + version "0.10.4" + resolved "https://registry.yarnpkg.com/util/-/util-0.10.4.tgz#3aa0125bfe668a4672de58857d3ace27ecb76901" + integrity sha512-0Pm9hTQ3se5ll1XihRic3FDIku70C+iHUdT/W926rSgHV5QgXsYbKZN8MSC3tJtSkhuROzvsQjAaFENRXr+19A== + dependencies: + inherits "2.0.3" + utila@~0.4: version "0.4.0" resolved "https://registry.yarnpkg.com/utila/-/utila-0.4.0.tgz#8a16a05d445657a3aea5eecc5b12a4fa5379772c" @@ -8935,11 +10487,56 @@ utils-merge@1.0.1: resolved "https://registry.yarnpkg.com/utils-merge/-/utils-merge-1.0.1.tgz#9f95710f50a267947b2ccc124741c1028427e713" integrity sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA== -uuid@^8.3.2: +uuid@8.3.2, uuid@^8.3.2: version "8.3.2" resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2" integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg== +uuid@^9.0.0: + version "9.0.0" + resolved "https://registry.yarnpkg.com/uuid/-/uuid-9.0.0.tgz#592f550650024a38ceb0c562f2f6aa435761efb5" + integrity sha512-MXcSTerfPa4uqyzStbRoTgt5XIe3x5+42+q1sDuy3R5MDk66URdLMOZe5aPX/SQd+kuYAh0FdP/pO28IkQyTeg== + +uvu@^0.5.0: + version "0.5.6" + resolved "https://registry.yarnpkg.com/uvu/-/uvu-0.5.6.tgz#2754ca20bcb0bb59b64e9985e84d2e81058502df" + integrity sha512-+g8ENReyr8YsOc6fv/NVJs2vFdHBnBNdfE49rshrTzDWOlUx4Gq7KOS2GD8eqhy2j+Ejq29+SbKH8yjkAqXqoA== + dependencies: + dequal "^2.0.0" + diff "^5.0.0" + kleur "^4.0.3" + sade "^1.7.3" + +validate.io-array@^1.0.3: + version "1.0.6" + resolved "https://registry.yarnpkg.com/validate.io-array/-/validate.io-array-1.0.6.tgz#5b5a2cafd8f8b85abb2f886ba153f2d93a27774d" + integrity sha512-DeOy7CnPEziggrOO5CZhVKJw6S3Yi7e9e65R1Nl/RTN1vTQKnzjfvks0/8kQ40FP/dsjRAOd4hxmJ7uLa6vxkg== + +validate.io-function@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/validate.io-function/-/validate.io-function-1.0.2.tgz#343a19802ed3b1968269c780e558e93411c0bad7" + integrity sha512-LlFybRJEriSuBnUhQyG5bwglhh50EpTL2ul23MPIuR1odjO7XaMLFV8vHGwp7AZciFxtYOeiSCT5st+XSPONiQ== + +validate.io-integer-array@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/validate.io-integer-array/-/validate.io-integer-array-1.0.0.tgz#2cabde033293a6bcbe063feafe91eaf46b13a089" + integrity sha512-mTrMk/1ytQHtCY0oNO3dztafHYyGU88KL+jRxWuzfOmQb+4qqnWmI+gykvGp8usKZOM0H7keJHEbRaFiYA0VrA== + dependencies: + validate.io-array "^1.0.3" + validate.io-integer "^1.0.4" + +validate.io-integer@^1.0.4: + version "1.0.5" + resolved "https://registry.yarnpkg.com/validate.io-integer/-/validate.io-integer-1.0.5.tgz#168496480b95be2247ec443f2233de4f89878068" + integrity sha512-22izsYSLojN/P6bppBqhgUDjCkr5RY2jd+N2a3DCAUey8ydvrZ/OkGvFPR7qfOpwR2LC5p4Ngzxz36g5Vgr/hQ== + dependencies: + validate.io-number "^1.0.3" + +validate.io-number@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/validate.io-number/-/validate.io-number-1.0.3.tgz#f63ffeda248bf28a67a8d48e0e3b461a1665baf8" + integrity sha512-kRAyotcbNaSYoDnXvb4MHg/0a1egJdLwS6oJ38TJY7aw9n93Fl/3blIXdyYvPOp55CNxywooG/3BcrwNrBpcSg== + value-equal@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/value-equal/-/value-equal-1.0.1.tgz#1e0b794c734c5c0cade179c437d356d931a34d6c" @@ -8955,6 +10552,14 @@ vfile-location@^3.0.0, vfile-location@^3.2.0: resolved "https://registry.yarnpkg.com/vfile-location/-/vfile-location-3.2.0.tgz#d8e41fbcbd406063669ebf6c33d56ae8721d0f3c" integrity sha512-aLEIZKv/oxuCDZ8lkJGhuhztf/BW4M+iHdCwglA/eWc+vtuRFJj8EtgceYFX4LRjOhCAAiNHsKGssC6onJ+jbA== +vfile-location@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/vfile-location/-/vfile-location-4.1.0.tgz#69df82fb9ef0a38d0d02b90dd84620e120050dd0" + integrity sha512-YF23YMyASIIJXpktBa4vIGLJ5Gs88UB/XePgqPmTa7cDA+JeO3yclbpheQYCHjVHBn/yePzrXuygIL+xbvRYHw== + dependencies: + "@types/unist" "^2.0.0" + vfile "^5.0.0" + vfile-message@^2.0.0: version "2.0.4" resolved "https://registry.yarnpkg.com/vfile-message/-/vfile-message-2.0.4.tgz#5b43b88171d409eae58477d13f23dd41d52c371a" @@ -8963,6 +10568,14 @@ vfile-message@^2.0.0: "@types/unist" "^2.0.0" unist-util-stringify-position "^2.0.0" +vfile-message@^3.0.0: + version "3.1.4" + resolved "https://registry.yarnpkg.com/vfile-message/-/vfile-message-3.1.4.tgz#15a50816ae7d7c2d1fa87090a7f9f96612b59dea" + integrity sha512-fa0Z6P8HUrQN4BZaX05SIVXic+7kE3b05PWAtPuYP9QLHsLKYR7/AlLW3NtOrpXRLeawpDLMsVkmk5DG0NXgWw== + dependencies: + "@types/unist" "^2.0.0" + unist-util-stringify-position "^3.0.0" + vfile@^4.0.0: version "4.2.1" resolved "https://registry.yarnpkg.com/vfile/-/vfile-4.2.1.tgz#03f1dce28fc625c625bc6514350fbdb00fa9e624" @@ -8973,6 +10586,16 @@ vfile@^4.0.0: unist-util-stringify-position "^2.0.0" vfile-message "^2.0.0" +vfile@^5.0.0: + version "5.3.7" + resolved "https://registry.yarnpkg.com/vfile/-/vfile-5.3.7.tgz#de0677e6683e3380fafc46544cfe603118826ab7" + integrity sha512-r7qlzkgErKjobAmyNIkkSpizsFPYiUPuJb5pNW1RB4JcYVZhs4lIbVqk8XPk033CV/1z8ss5pkax8SuhGpcG8g== + dependencies: + "@types/unist" "^2.0.0" + is-buffer "^2.0.0" + unist-util-stringify-position "^3.0.0" + vfile-message "^3.0.0" + wait-on@6.0.1, wait-on@^6.0.1: version "6.0.1" resolved "https://registry.yarnpkg.com/wait-on/-/wait-on-6.0.1.tgz#16bbc4d1e4ebdd41c5b4e63a2e16dbd1f4e5601e" @@ -8984,6 +10607,13 @@ wait-on@6.0.1, wait-on@^6.0.1: minimist "^1.2.5" rxjs "^7.5.4" +warning@^4.0.3: + version "4.0.3" + resolved "https://registry.yarnpkg.com/warning/-/warning-4.0.3.tgz#16e9e077eb8a86d6af7d64aa1e05fd85b4678ca3" + integrity sha512-rpJyN222KWIvHJ/F53XSZv0Zl/accqHR8et1kpaMTD/fLCRxtV8iX8czMzY7sVZupTI3zcUTg8eycS2kNF9l6w== + dependencies: + loose-envify "^1.0.0" + watchpack@^2.4.0: version "2.4.0" resolved "https://registry.yarnpkg.com/watchpack/-/watchpack-2.4.0.tgz#fa33032374962c78113f93c7f2fb4c54c9862a5d" @@ -9004,6 +10634,11 @@ web-namespaces@^1.0.0: resolved "https://registry.yarnpkg.com/web-namespaces/-/web-namespaces-1.1.4.tgz#bc98a3de60dadd7faefc403d1076d529f5e030ec" integrity sha512-wYxSGajtmoP4WxfejAPIr4l0fVh+jeMXZb08wNc0tMg6xsfZXj3cECqIK0G7ZAqUq0PP8WlMDtaOGVBTAWztNw== +web-namespaces@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/web-namespaces/-/web-namespaces-2.0.1.tgz#1010ff7c650eccb2592cebeeaf9a1b253fd40692" + integrity sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ== + webidl-conversions@^3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-3.0.1.tgz#24534275e2a7bc6be7bc86611cc16ae0a5654871" @@ -9025,10 +10660,11 @@ webpack-bundle-analyzer@4.5.0: ws "^7.3.1" webpack-bundle-analyzer@^4.5.0: - version "4.7.0" - resolved "https://registry.yarnpkg.com/webpack-bundle-analyzer/-/webpack-bundle-analyzer-4.7.0.tgz#33c1c485a7fcae8627c547b5c3328b46de733c66" - integrity sha512-j9b8ynpJS4K+zfO5GGwsAcQX4ZHpWV+yRiHDiL+bE0XHJ8NiPYLTNVQdlFYWxtpg9lfAQNlwJg16J9AJtFSXRg== + version "4.8.0" + resolved "https://registry.yarnpkg.com/webpack-bundle-analyzer/-/webpack-bundle-analyzer-4.8.0.tgz#951b8aaf491f665d2ae325d8b84da229157b1d04" + integrity sha512-ZzoSBePshOKhr+hd8u6oCkZVwpVaXgpw23ScGLFpR6SjYI7+7iIWYarjN6OEYOfRt8o7ZyZZQk0DuMizJ+LEIg== dependencies: + "@discoveryjs/json-ext" "0.5.7" acorn "^8.0.4" acorn-walk "^8.0.0" chalk "^4.1.0" @@ -9151,10 +10787,10 @@ webpack-sources@^3.2.2, webpack-sources@^3.2.3: resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-3.2.3.tgz#2d4daab8451fd4b240cc27055ff6a0c2ccea0cde" integrity sha512-/DyMEOrDgLKKIG0fmvtz+4dUX/3Ghozwgm6iPp8KRhvn+eQf9+Q7GWxVNMk3+uCPWfdXYC4ExGBckIXdFEfH1w== -webpack@^5.73.0: - version "5.74.0" - resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.74.0.tgz#02a5dac19a17e0bb47093f2be67c695102a55980" - integrity sha512-A2InDwnhhGN4LYctJj6M1JEaGL7Luj6LOmyBHjcI8529cm5p6VXiTIW2sn6ffvEAKmveLzvu4jrihwXtPojlAA== +webpack@^5.61.0, webpack@^5.73.0: + version "5.75.0" + resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.75.0.tgz#1e440468647b2505860e94c9ff3e44d5b582c152" + integrity sha512-piaIaoVJlqMsPtX/+3KTTO6jfvrSYgauFVdt8cr9LTHKmcq/AMd4mhzsiP7ZF/PGRNPGA8336jldh9l2Kt2ogQ== dependencies: "@types/eslint-scope" "^3.7.3" "@types/estree" "^0.0.51" @@ -9213,6 +10849,11 @@ whatwg-url@^5.0.0: tr46 "~0.0.3" webidl-conversions "^3.0.0" +which-module@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/which-module/-/which-module-2.0.0.tgz#d9ef07dce77b9902b8a3a8fa4b31c3e3f7e6e87a" + integrity sha512-B+enWhmw6cjfVC7kS8Pj9pCrKSc5txArRyaYGe088shv/FGWH+0Rjx/xPgtsWfsUtS27FkP697E4DDhgrgoc0Q== + which@^1.3.1: version "1.3.1" resolved "https://registry.yarnpkg.com/which/-/which-1.3.1.tgz#a45043d54f5805316da8d62f9f50918d3da70b0a" @@ -9246,7 +10887,7 @@ wildcard@^2.0.0: resolved "https://registry.yarnpkg.com/wildcard/-/wildcard-2.0.0.tgz#a77d20e5200c6faaac979e4b3aadc7b3dd7f8fec" integrity sha512-JcKqAHLPxcdb9KM49dufGXn2x3ssnfjbcaQdLlfZsL9rH9wgDQjUtDxbo8NE0F6SFvydeu1VhZe7hZuHsB2/pw== -wrap-ansi@8.0.1, wrap-ansi@^8.0.1: +wrap-ansi@8.0.1: version "8.0.1" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-8.0.1.tgz#2101e861777fec527d0ea90c57c6b03aac56a5b3" integrity sha512-QFF+ufAqhoYHvoHdajT/Po7KoXVBPXS2bgjIam5isfWJPfIOnQZ50JtUiVvCv/sjgacf3yRrt2ZKUZ/V4itN4g== @@ -9255,6 +10896,15 @@ wrap-ansi@8.0.1, wrap-ansi@^8.0.1: string-width "^5.0.1" strip-ansi "^7.0.1" +wrap-ansi@^6.2.0: + version "6.2.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53" + integrity sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + wrap-ansi@^7.0.0: version "7.0.0" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" @@ -9264,6 +10914,15 @@ wrap-ansi@^7.0.0: string-width "^4.1.0" strip-ansi "^6.0.0" +wrap-ansi@^8.0.1: + version "8.1.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-8.1.0.tgz#56dc22368ee570face1b49819975d9b9a5ead214" + integrity sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ== + dependencies: + ansi-styles "^6.1.0" + string-width "^5.0.1" + strip-ansi "^7.0.1" + wrappy@1: version "1.0.2" resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" @@ -9285,15 +10944,22 @@ ws@^7.3.1: integrity sha512-F+P9Jil7UiSKSkppIiD94dN07AwvFixvLIj1Og1Rl9GGMuNipJnV9JzjD6XuqmAeiswGvUmNLjr5cFuXwNS77Q== ws@^8.4.2: - version "8.10.0" - resolved "https://registry.yarnpkg.com/ws/-/ws-8.10.0.tgz#00a28c09dfb76eae4eb45c3b565f771d6951aa51" - integrity sha512-+s49uSmZpvtAsd2h37vIPy1RBusaLawVe8of+GyEPsaJTCMpj/2v8NpeK1SHXjBlQ95lQTmQofOJnFiLoaN3yw== + version "8.12.1" + resolved "https://registry.yarnpkg.com/ws/-/ws-8.12.1.tgz#c51e583d79140b5e42e39be48c934131942d4a8f" + integrity sha512-1qo+M9Ba+xNhPB+YTWUlK6M17brTut5EXbcBaMRN5pH5dFrXz7lzz1ChFSUq3bOUl8yEvSenhHmYUNJxFzdJew== xdg-basedir@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/xdg-basedir/-/xdg-basedir-4.0.0.tgz#4bc8d9984403696225ef83a1573cbbcb4e79db13" integrity sha512-PSNhEJDejZYV7h50BohL09Er9VaIefr2LMAf3OEmpCkjOi34eYyQYAXUTjEQtZJTKcF0E2UKTh+osDLsgNim9Q== +xml-formatter@^2.6.1: + version "2.6.1" + resolved "https://registry.yarnpkg.com/xml-formatter/-/xml-formatter-2.6.1.tgz#066ef3a100bd58ee3b943f0c503be63176d3d497" + integrity sha512-dOiGwoqm8y22QdTNI7A+N03tyVfBlQ0/oehAzxIZtwnFAHGeSlrfjF73YQvzSsa/Kt6+YZasKsrdu6OIpuBggw== + dependencies: + xml-parser-xo "^3.2.0" + xml-js@^1.6.11: version "1.6.11" resolved "https://registry.yarnpkg.com/xml-js/-/xml-js-1.6.11.tgz#927d2f6947f7f1c19a316dd8eea3614e8b18f8e9" @@ -9301,21 +10967,89 @@ xml-js@^1.6.11: dependencies: sax "^1.2.4" +xml-parser-xo@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/xml-parser-xo/-/xml-parser-xo-3.2.0.tgz#c633ab55cf1976d6b03ab4a6a85045093ac32b73" + integrity sha512-8LRU6cq+d7mVsoDaMhnkkt3CTtAs4153p49fRo+HIB3I1FD1o5CeXRjRH29sQevIfVJIcPjKSsPU/+Ujhq09Rg== + xtend@^4.0.0, xtend@^4.0.1, xtend@^4.0.2: version "4.0.2" resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.2.tgz#bb72779f5fa465186b1f438f674fa347fdb5db54" integrity sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ== +y18n@^4.0.0: + version "4.0.3" + resolved "https://registry.yarnpkg.com/y18n/-/y18n-4.0.3.tgz#b5f259c82cd6e336921efd7bfd8bf560de9eeedf" + integrity sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ== + +y18n@^5.0.5: + version "5.0.8" + resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55" + integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA== + +yallist@^3.0.2: + version "3.1.1" + resolved "https://registry.yarnpkg.com/yallist/-/yallist-3.1.1.tgz#dbb7daf9bfd8bac9ab45ebf602b8cbad0d5d08fd" + integrity sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g== + yallist@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72" integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A== -yaml@^1.10.0, yaml@^1.10.2, yaml@^1.7.2: +yaml-ast-parser@0.0.43: + version "0.0.43" + resolved "https://registry.yarnpkg.com/yaml-ast-parser/-/yaml-ast-parser-0.0.43.tgz#e8a23e6fb4c38076ab92995c5dca33f3d3d7c9bb" + integrity sha512-2PTINUwsRqSd+s8XxKaJWQlUuEMHJQyEuh2edBbW8KNJz0SJPwUSD2zRWqezFEdN7IzAgeuYHFUCF7o8zRdZ0A== + +yaml@1.10.2, yaml@^1.10.0, yaml@^1.10.2, yaml@^1.7.2: version "1.10.2" resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b" integrity sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg== +yargs-parser@^18.1.2: + version "18.1.3" + resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-18.1.3.tgz#be68c4975c6b2abf469236b0c870362fab09a7b0" + integrity sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ== + dependencies: + camelcase "^5.0.0" + decamelize "^1.2.0" + +yargs-parser@^21.1.1: + version "21.1.1" + resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.1.1.tgz#9096bceebf990d21bb31fa9516e0ede294a77d35" + integrity sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw== + +yargs@^15.3.1: + version "15.4.1" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-15.4.1.tgz#0d87a16de01aee9d8bec2bfbf74f67851730f4f8" + integrity sha512-aePbxDmcYW++PaqBsJ+HYUFwCdv4LVvdnhBy78E57PIor8/OVvhMrADFFEDh8DHDFRv/O9i3lPhsENjO7QX0+A== + dependencies: + cliui "^6.0.0" + decamelize "^1.2.0" + find-up "^4.1.0" + get-caller-file "^2.0.1" + require-directory "^2.1.1" + require-main-filename "^2.0.0" + set-blocking "^2.0.0" + string-width "^4.2.0" + which-module "^2.0.0" + y18n "^4.0.0" + yargs-parser "^18.1.2" + +yargs@^17.0.1: + version "17.7.1" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-17.7.1.tgz#34a77645201d1a8fc5213ace787c220eabbd0967" + integrity sha512-cwiTb08Xuv5fqF4AovYacTFNxk62th7LKJ6BL9IGUpTJrWoU7/7WdQGTP2SjKf1dUNBGzDd28p/Yfs/GI6JrLw== + dependencies: + cliui "^8.0.1" + escalade "^3.1.1" + get-caller-file "^2.0.5" + require-directory "^2.1.1" + string-width "^4.2.3" + y18n "^5.0.5" + yargs-parser "^21.1.1" + yocto-queue@^0.1.0: version "0.1.0" resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b" @@ -9325,3 +11059,8 @@ zwitch@^1.0.0: version "1.0.5" resolved "https://registry.yarnpkg.com/zwitch/-/zwitch-1.0.5.tgz#d11d7381ffed16b742f6af7b3f223d5cd9fe9920" integrity sha512-V50KMwwzqJV0NpZIZFwfOD5/lyny3WlSzRiXgA0G7VUnRlqttta1L6UQIHzd6EuBY/cHGfwTIck7w1yH6Q5zUw== + +zwitch@^2.0.0: + version "2.0.4" + resolved "https://registry.yarnpkg.com/zwitch/-/zwitch-2.0.4.tgz#c827d4b0acb76fc3e685a4c6ec2902d51070e9d7" + integrity sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A== diff --git a/go.sum b/go.sum index b0523f0b8..86213ecc9 100644 --- a/go.sum +++ b/go.sum @@ -1483,6 +1483,7 @@ google.golang.org/grpc v1.41.0/go.mod h1:U3l9uK9J0sini8mHphKoXyaqDA/8VyGnDee1zzI google.golang.org/grpc v1.42.0/go.mod h1:k+4IHHFw41K8+bbowsex27ge2rCb65oeWqe4jJ590SU= google.golang.org/grpc v1.51.0 h1:E1eGv1FTqoLIdnBCZufiSHgKjlqG6fKFf6pPWtMTh8U= google.golang.org/grpc v1.51.0/go.mod h1:wgNDFcnuBGmxLKI/qn4T+m5BtEBYXJPvibbUPsAIPww= +google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0 h1:M1YKkFIboKNieVO5DLUEVzQfGwJD30Nv2jfUgzb5UcE= google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0/go.mod h1:6Kw0yEErY5E/yWrBtf03jp27GLLJujG4z/JK95pnjjw= google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= diff --git a/proto/zitadel/action.proto b/proto/zitadel/action.proto index 7907e7e83..43c9de261 100644 --- a/proto/zitadel/action.proto +++ b/proto/zitadel/action.proto @@ -74,7 +74,7 @@ message ActionNameQuery { ]; } -//ActionStateQuery is always equals +//ActionStateQuery always equals message ActionStateQuery { ActionState state = 1 [ (validate.rules).enum.defined_only = true, diff --git a/proto/zitadel/admin.proto b/proto/zitadel/admin.proto index 70754ee4f..98d9f96a7 100644 --- a/proto/zitadel/admin.proto +++ b/proto/zitadel/admin.proto @@ -16,6 +16,7 @@ import "zitadel/v1.proto"; import "zitadel/message.proto"; import "google/api/annotations.proto"; +import "google/api/field_behavior.proto"; import "google/protobuf/timestamp.proto"; import "google/protobuf/duration.proto"; @@ -33,7 +34,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { version: "1.0"; description: "This API is intended to configure and manage the IAM instance itself."; contact:{ - name: "CAOS developers of ZITADEL" + name: "ZITADEL" url: "https://zitadel.com" email: "hi@zitadel.com" } @@ -42,7 +43,81 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { url: "https://github.com/zitadel/zitadel/blob/main/LICENSE"; }; }; - + tags: [ + { + name: "Authentication Methods" + }, + { + name: "Branding", + description: "Defines the look of the login UI, E-Mails, and ZITADEL Console. For adding assets like logo, icon and font, have a look at the assets API." + }, + { + name: "Domain Settings" + }, + { + name: "Events" + }, + { + name: "Failed Events" + }, + { + name: "General" + }, + { + name: "Identity Providers" + }, + { + name: "Import/Export", + }, + { + name: "Instance" + }, + { + name: "Login Settings" + }, + { + name: "Login Texts", + }, + { + name: "Members", + }, + { + name: "Message Texts" + }, + { + name: "Notification Providers" + }, + { + name: "Notification Settings" + }, + { + name: "Organizations" + }, + { + name: "Password Settings", + }, + { + name: "Privacy Settings", + }, + { + name: "Secrets" + }, + { + name: "SMS Provider", + }, + { + name: "SMTP" + }, + { + name: "Settings" + }, + { + name: "Views/Projections" + }, + { + name: "ZITADEL Administrators" + } + ]; schemes: HTTPS; schemes: HTTP; @@ -55,7 +130,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { consumes: "application/grpc-web+proto"; produces: "application/grpc-web+proto"; - host: "api.zitadel.ch"; + host: "$ZITADEL_DOMAIN"; base_path: "/admin/v1"; external_docs: { @@ -75,30 +150,30 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { value: { type: TYPE_OAUTH2; flow: FLOW_ACCESS_CODE; - authorization_url: "https://accounts.zitadel.io/oauth/v2/authorize"; - token_url: "https://api.zitadel.io/oauth/v2/token"; - scopes: { + authorization_url: "$ZITADEL_DOMAIN/oauth/v2/authorize"; + token_url: "$ZITADEL_DOMAIN/oauth/v2/token"; + scopes: { scope: { key: "openid"; value: "openid"; } - scope: { - key: "urn:zitadel:iam:org:project:id:100992085158584780:aud"; - value: "urn:zitadel:iam:org:project:id:100992085158584780:aud"; - } + scope: { + key: "urn:zitadel:iam:org:project:id:zitadel:aud"; + value: "urn:zitadel:iam:org:project:id:zitadel:aud"; + } } } } } security: { - security_requirement: { - key: "OAuth2"; - value: { - scope: "openid"; - scope: "urn:zitadel:iam:org:project:id:100992085158584780:aud"; - } - } - } + security_requirement: { + key: "OAuth2"; + value: { + scope: "openid"; + scope: "urn:zitadel:iam:org:project:id:zitadel:aud"; + } + } + } responses: { key: "403"; value: { @@ -121,25 +196,18 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { } } } - - extensions: { - key: "x-zitadel-orgid"; - value: { - string_value: "your-org-id"; - } - } }; service AdminService { - //Indicates if ZITADEL is running. - // It respondes as soon as ZITADEL started rpc Healthz(HealthzRequest) returns (HealthzResponse) { option (google.api.http) = { get: "/healthz"; }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "probes"; + summary: "Healthz"; + description: "The health endpoint allows an external system to probe if ZITADEL system API is alive. Response as soon as ZITADLE is running." + tags: "General"; responses: { key: "200"; value: { @@ -155,7 +223,6 @@ service AdminService { }; } - // Returns the default languages rpc GetSupportedLanguages(GetSupportedLanguagesRequest) returns (GetSupportedLanguagesResponse) { option (google.api.http) = { get: "/languages"; @@ -164,9 +231,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "General"; + summary: "Supported Languages"; + description: "The supported/default languages of the system will be returned by the language abbreviation." + }; } - // Set the default language rpc SetDefaultLanguage(SetDefaultLanguageRequest) returns (SetDefaultLanguageResponse) { option (google.api.http) = { put: "/languages/default/{language}"; @@ -175,9 +247,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "General"; + summary: "Set Default Languages"; + description: "Set the language that is used as a fallback/default if the user has configured something that is not provided by ZITADEL." + }; } - // Set the default language rpc GetDefaultLanguage(GetDefaultLanguageRequest) returns (GetDefaultLanguageResponse) { option (google.api.http) = { get: "/languages/default"; @@ -186,9 +263,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "General"; + summary: "Get Default Languages"; + description: "Returns the language that is used as a fallback/default if the user has configured something that is not provided by ZITADEL." + }; } - // Returns the details of the instance rpc GetMyInstance(GetMyInstanceRequest) returns (GetMyInstanceResponse) { option (google.api.http) = { get: "/instances/me"; @@ -197,16 +279,26 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Instance"; + summary: "Get My Instance"; + description: "Returns the details about the current instance such as the name, version, domains, etc." + }; } - // Returns the domains of the instance rpc ListInstanceDomains(ListInstanceDomainsRequest) returns (ListInstanceDomainsResponse) { option (google.api.http) = { post: "/domains/_search"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Instance"; + summary: "List Instance Domains"; + description: "Returns a list of domains that are configured for this ZITADEL instance. These domains are the URLs where ZITADEL is running." + }; } - // Set the default language rpc ListSecretGenerators(ListSecretGeneratorsRequest) returns (ListSecretGeneratorsResponse) { option (google.api.http) = { post: "/secretgenerators/_search" @@ -216,9 +308,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Secrets"; + summary: "List Secret Generators"; + description: "Lists all the configured secret generators. The generators define how a secret should look when generated in ZITADEL. E.g Email verification code, phone verification code, etc." + }; } - // Get Secret Generator by type (e.g PasswordResetCode) rpc GetSecretGenerator(GetSecretGeneratorRequest) returns (GetSecretGeneratorResponse) { option (google.api.http) = { get: "/secretgenerators/{generator_type}"; @@ -227,9 +324,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Secrets"; + summary: "Get Secret Generator"; + description: "Get a specific secret generator by its type (e.g PasswordResetCode). A generator defines how a secret should look when generating in ZITADEL." + }; } - // Update secret generator configuration rpc UpdateSecretGenerator(UpdateSecretGeneratorRequest) returns (UpdateSecretGeneratorResponse) { option (google.api.http) = { put: "/secretgenerators/{generator_type}"; @@ -239,9 +341,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Secrets"; + summary: "Update Secret Generator"; + description: "Change a specific secret generator configuration by its type (e.g PasswordResetCode). A generator defines how a secret should look when generating in ZITADEL." + }; } - // Get system smtp configuration rpc GetSMTPConfig(GetSMTPConfigRequest) returns (GetSMTPConfigResponse) { option (google.api.http) = { get: "/smtp"; @@ -250,9 +357,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMTP"; + summary: "Get SMTP Configuration"; + description: "Returns the SMTP configuration from the system. This is used to send E-Mails to the users." + }; } - // Add system smtp configuration rpc AddSMTPConfig(AddSMTPConfigRequest) returns (AddSMTPConfigResponse) { option (google.api.http) = { post: "/smtp"; @@ -262,9 +374,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMTP"; + summary: "Add SMTP Configuration"; + description: "Add a new SMTP configuration if nothing is set yet." + }; } - // Update system smtp configuration rpc UpdateSMTPConfig(UpdateSMTPConfigRequest) returns (UpdateSMTPConfigResponse) { option (google.api.http) = { put: "/smtp"; @@ -274,9 +391,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMTP"; + summary: "Update SMTP Configuration"; + description: "Update the SMTP configuration, be aware that this will be activated as soon as it is saved. So the users will get notifications from the newly configured SMTP." + }; } - // Update system smtp configuration password for host rpc UpdateSMTPConfigPassword(UpdateSMTPConfigPasswordRequest) returns (UpdateSMTPConfigPasswordResponse) { option (google.api.http) = { put: "/smtp/password"; @@ -286,9 +408,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMTP"; + summary: "Update SMTP Password"; + description: "Update the SMTP password that is used for the host, be aware that this will be activated as soon as it is saved. So the users will get notifications from the newly configured SMTP." + }; } - // Remove system smtp configuration rpc RemoveSMTPConfig(RemoveSMTPConfigRequest) returns (RemoveSMTPConfigResponse) { option (google.api.http) = { delete: "/smtp"; @@ -297,9 +424,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMTP"; + summary: "Remove SMTP Configuration"; + description: "Remove the SMTP configuration, be aware that the users will not get an E-Mail if no SMTP is set." + }; } - // list sms provider configurations rpc ListSMSProviders(ListSMSProvidersRequest) returns (ListSMSProvidersResponse) { option (google.api.http) = { post: "/sms/_search" @@ -309,9 +441,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMS Provider"; + summary: "List SMS Providers"; + description: "Returns a list of configured SMS providers." + }; } - // Get sms provider rpc GetSMSProvider(GetSMSProviderRequest) returns (GetSMSProviderResponse) { option (google.api.http) = { get: "/sms/{id}"; @@ -320,9 +457,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMS Provider"; + summary: "Get SMS Provider"; + description: "Get a specific SMS provider by its ID." + }; } - // Add twilio sms provider rpc AddSMSProviderTwilio(AddSMSProviderTwilioRequest) returns (AddSMSProviderTwilioResponse) { option (google.api.http) = { post: "/sms/twilio"; @@ -332,9 +474,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMS Provider"; + summary: "Add Twilio SMS Provider"; + description: "Configure a new SMS provider of the type Twilio. A provider has to be activated to be able to send notifications." + }; } - // Update twilio sms provider rpc UpdateSMSProviderTwilio(UpdateSMSProviderTwilioRequest) returns (UpdateSMSProviderTwilioResponse) { option (google.api.http) = { put: "/sms/twilio/{id}"; @@ -344,9 +491,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMS Provider"; + summary: "Update Twilio SMS Provider"; + description: "Change the configuration of an SMS provider of the type Twilio. A provider has to be activated to be able to send notifications." + }; } - // Update twilio sms provider token rpc UpdateSMSProviderTwilioToken(UpdateSMSProviderTwilioTokenRequest) returns (UpdateSMSProviderTwilioTokenResponse) { option (google.api.http) = { put: "/sms/twilio/{id}/token"; @@ -356,9 +508,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMS Provider"; + summary: "Update Twilio SMS Provider Token"; + description: "Change the token of the SMS provider of the type Twilio." + }; } - // Activate sms provider rpc ActivateSMSProvider(ActivateSMSProviderRequest) returns (ActivateSMSProviderResponse) { option (google.api.http) = { post: "/sms/{id}/_activate"; @@ -368,9 +525,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMS Provider"; + summary: "Activate SMS Provider"; + description: "Activate an SMS provider. After activating a provider, the users will be able to receive SMS notifications." + }; } - // Deactivate sms provider rpc DeactivateSMSProvider(DeactivateSMSProviderRequest) returns (DeactivateSMSProviderResponse) { option (google.api.http) = { post: "/sms/{id}/_deactivate"; @@ -380,9 +542,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMS Provider"; + summary: "Deactivate SMS Provider"; + description: "Deactivate an SMS provider. After deactivating the provider, the users will not be able to receive SMS notifications from that provider anymore. If it was the last activated they will not get notifications at all" + }; } - // Remove sms provider token rpc RemoveSMSProvider(RemoveSMSProviderRequest) returns (RemoveSMSProviderResponse) { option (google.api.http) = { delete: "/sms/{id}"; @@ -391,9 +558,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "SMS Provider"; + summary: "Remove SMS Provider" ; + description: "Delete an SMS provider. If the provider was still active the users will not receive notifications from that provider anymore." + }; } - // Get OIDC settings (e.g token lifetimes, etc.) rpc GetOIDCSettings(GetOIDCSettingsRequest) returns (GetOIDCSettingsResponse) { option (google.api.http) = { get: "/settings/oidc"; @@ -402,9 +574,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + summary: "Get OIDC Settings"; + description: "The OIDC Settings define the lifetimes of the different tokens in OIDC." + }; } - // Add oidc settings (e.g token lifetimes, etc) rpc AddOIDCSettings(AddOIDCSettingsRequest) returns (AddOIDCSettingsResponse) { option (google.api.http) = { post: "/settings/oidc"; @@ -414,9 +591,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + summary: "Add OIDC Settings"; + description: "Create new OIDC settings. The OIDC Settings define the lifetimes of the different tokens in OIDC. These settings are used for all organizations and clients." + }; } - // Update oidc settings (e.g token lifetimes, etc) rpc UpdateOIDCSettings(UpdateOIDCSettingsRequest) returns (UpdateOIDCSettingsResponse) { option (google.api.http) = { put: "/settings/oidc"; @@ -426,9 +608,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + summary: "Add OIDC Settings"; + description: "Update existing OIDC settings. The OIDC Settings define the lifetimes of the different tokens in OIDC. These settings are used for all organizations and clients." + }; } - // Get file system notification provider rpc GetFileSystemNotificationProvider(GetFileSystemNotificationProviderRequest) returns (GetFileSystemNotificationProviderResponse) { option (google.api.http) = { get: "/notification/provider/file"; @@ -437,9 +624,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Notification Providers"; + summary: "Get Notification Provider Filesystem"; + description: "Returns a filesystem notification provider if configured. This provider is only used for testing purposes. The notifications will be written to the filesystem." + }; } - // Get log notification provider rpc GetLogNotificationProvider(GetLogNotificationProviderRequest) returns (GetLogNotificationProviderResponse) { option (google.api.http) = { get: "/notification/provider/log"; @@ -448,9 +640,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Notification Providers"; + summary: "Get Notification Provider Log"; + description: "Returns a log notification provider if configured. This provider is only used for testing purposes. The notifications will be written to the logs." + }; } - // Get the security policy rpc GetSecurityPolicy(GetSecurityPolicyRequest) returns (GetSecurityPolicyResponse) { option (google.api.http) = { get: "/policies/security"; @@ -459,9 +656,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + summary: "Get Security Settings"; + description: "Returns the security settings of the ZITADEL instance. The settings define if the iframe is allowed and from which origins." + }; } - // set the security policy rpc SetSecurityPolicy(SetSecurityPolicyRequest) returns (SetSecurityPolicyResponse) { option (google.api.http) = { put: "/policies/security"; @@ -471,9 +673,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + summary: "Set Security Settings"; + description: "Set the security settings of the ZITADEL instance. The settings define if the iframe is allowed and from which origins." + }; } - // Returns an organisation by id rpc GetOrgByID(GetOrgByIDRequest) returns (GetOrgByIDResponse) { option (google.api.http) = { get: "/orgs/{id}"; @@ -484,8 +691,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "orgs"; - tags: "global"; + tags: "Organizations"; + summary: "Get Organization By ID"; + description: "Returns an organization by its ID. Make sure the user has the permissions to access the organization." responses: { key: "200"; value: { @@ -495,7 +703,6 @@ service AdminService { }; } - //Checks whether an organisation exists by the given parameters rpc IsOrgUnique(IsOrgUniqueRequest) returns (IsOrgUniqueResponse) { option (google.api.http) = { get: "/orgs/_is_unique"; @@ -506,8 +713,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "orgs"; - tags: "global"; + tags: "Organizations"; + summary: "Is Organization Unique"; + description: "Checks if an organization with the searched parameters already exists or not." responses: { key: "200"; value: { @@ -523,7 +731,6 @@ service AdminService { }; } - // Set the default org rpc SetDefaultOrg(SetDefaultOrgRequest) returns (SetDefaultOrgResponse) { option (google.api.http) = { put: "/orgs/default/{org_id}"; @@ -532,9 +739,15 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + tags: "Settings"; + summary: "Set Default Organization"; + description: "Sets the default organization of the ZITADEL instance. If no specific organization is given on the register form, a user will be registered to the default organization." + }; } - // Set the default org rpc GetDefaultOrg(GetDefaultOrgRequest) returns (GetDefaultOrgResponse) { option (google.api.http) = { get: "/orgs/default"; @@ -543,10 +756,15 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + tags: "Settings"; + summary: "Get Default Organization"; + description: "Get the default organization of the ZITADEL instance. If no specific organization is given on the register form, a user will be registered to the default organization." + }; } - //Returns all organisations matching the request - // all queries need to match (AND) rpc ListOrgs(ListOrgsRequest) returns (ListOrgsResponse) { option (google.api.http) = { post: "/orgs/_search"; @@ -558,12 +776,13 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "orgs"; - tags: "global"; + tags: "Organizations"; + summary: "Search Organization"; + description: "Returns a list of organizations that match the requesting filters. All filters are applied with an AND condition." responses: { key: "200"; value: { - description: "list of organisations matching the query"; + description: "list of organizations matching the query"; }; }; responses: { @@ -580,8 +799,6 @@ service AdminService { }; } - //Creates a new org and user - // and adds the user to the orgs members as ORG_OWNER rpc SetUpOrg(SetUpOrgRequest) returns (SetUpOrgResponse) { option (google.api.http) = { post: "/orgs/_setup"; @@ -593,8 +810,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "orgs"; - tags: "global"; + tags: "Organizations"; + summary: "Setup Organization"; + description: "Create a new organization with an administrative user. If no specific roles are sent for the first user, the user will get the role ORG_OWNER." responses: { key: "200"; value: { @@ -615,9 +833,6 @@ service AdminService { }; } - - // Sets the state of the organisation and all its resource (Users, Projects, Grants to and from the org) to removed - // Users of this organisation will not be able login rpc RemoveOrg(RemoveOrgRequest) returns (RemoveOrgResponse) { option (google.api.http) = { delete: "/orgs/{org_id}" @@ -627,8 +842,9 @@ service AdminService { permission: "iam.write"; }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "orgs"; - tags: "global"; + tags: "Organizations"; + summary: "Remove Organization"; + description: "Sets the state of the organization and all its resource (Users, Projects, Grants to and from the org) to remove. Users of this organization will not be able to log in." responses: { key: "200"; value: { @@ -650,7 +866,6 @@ service AdminService { } - // Returns a identity provider configuration of the IAM instance rpc GetIDPByID(GetIDPByIDRequest) returns (GetIDPByIDResponse) { option (google.api.http) = { get: "/idps/{id}"; @@ -661,11 +876,13 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "identity provider"; + tags: "Identity Providers"; + summary: "Get Identity Provider (IDP) by ID"; + description: "Returns an identity provider (social/enterprise login) by its ID e.g Google, AzureAD, etc." responses: { key: "200"; value: { - description: "idp found"; + description: "IDP found"; }; }; responses: { @@ -682,7 +899,6 @@ service AdminService { }; } - // Returns all identity provider configurations of the IAM instance rpc ListIDPs(ListIDPsRequest) returns (ListIDPsResponse) { option (google.api.http) = { post: "/idps/_search"; @@ -694,7 +910,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "identity provider"; + tags: "Identity Providers"; + summary: "Search Identity Providers (IDP)"; + description: "Returns a list of identity providers (social/enterprise login) configured on an instance level. e.g Google, AzureAD, etc." responses: { key: "200"; value: { @@ -715,7 +933,6 @@ service AdminService { }; } - // Adds a new oidc identity provider configuration the IAM instance rpc AddOIDCIDP(AddOIDCIDPRequest) returns (AddOIDCIDPResponse) { option (google.api.http) = { post: "/idps/oidc"; @@ -727,9 +944,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "identity provider"; - tags: "oidc"; - + tags: "Identity Providers"; + summary: "Add OIDC Identity Provider (IDP)"; + description: "Create a new identity provider configuration to enable your users to log in with social/enterprise login. The provider has to be OIDC compliant." responses: { key: "200"; value: { @@ -750,7 +967,6 @@ service AdminService { }; } - // Adds a new jwt identity provider configuration the IAM instance rpc AddJWTIDP(AddJWTIDPRequest) returns (AddJWTIDPResponse) { option (google.api.http) = { post: "/idps/jwt"; @@ -762,9 +978,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "identity provider"; - tags: "jwt"; - + tags: "Identity Providers"; + summary: "Add JWT Identity Provider (IDP)"; + description: "Create a new identity provider configuration to enable your users to log in with social/enterprise login. JSON Web Token Identity Provider (JWT IDP) gives you the possibility to use an (existing) JWT as a federated identity. You have to provide an endpoint where ZITADEL can get the existing JWT token." responses: { key: "200"; value: { @@ -785,8 +1001,6 @@ service AdminService { }; } - //Updates the specified idp - // all fields are updated. If no value is provided the field will be empty afterwards. rpc UpdateIDP(UpdateIDPRequest) returns (UpdateIDPResponse) { option (google.api.http) = { put: "/idps/{idp_id}"; @@ -798,7 +1012,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "identity provider"; + tags: "Identity Providers"; + summary: "Update Identity Provider (IDP)"; + description: "Update an existing IDP. All fields are updated. If you do not send a value in a field, it will be empty afterward." responses: { key: "200"; value: { @@ -819,8 +1035,6 @@ service AdminService { }; } - //Sets the state of the idp to IDP_STATE_INACTIVE - // the state MUST be IDP_STATE_ACTIVE for this call rpc DeactivateIDP(DeactivateIDPRequest) returns (DeactivateIDPResponse) { option (google.api.http) = { post: "/idps/{idp_id}/_deactivate"; @@ -831,7 +1045,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "identity provider"; + tags: "Identity Providers"; + summary: "Deactivate Identity Provider (IDP)"; + description: "Sets the state of the provider to inactive. It can only be called for the provider with the state active. Users will not be able to log in with the given provider afterward. It might cause troubles if it is the only authentication method of the user." responses: { key: "200"; value: { @@ -841,7 +1057,7 @@ service AdminService { responses: { key: "400"; value: { - description: "unable to deactivate idp"; + description: "Unable to deactivate IDP"; schema: { json_schema: { ref: "#/definitions/rpcStatus"; @@ -852,8 +1068,6 @@ service AdminService { }; } - //Sets the state of the idp to IDP_STATE_ACTIVE - // the state MUST be IDP_STATE_INACTIVE for this call rpc ReactivateIDP(ReactivateIDPRequest) returns (ReactivateIDPResponse) { option (google.api.http) = { post: "/idps/{idp_id}/_reactivate"; @@ -864,7 +1078,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "identity provider"; + tags: "Identity Providers"; + summary: "Reactivate Identity Provider (IDP)"; + description: "Sets the state of the provider to active. It can only be called for providers with the state inactive. Users will not be able to log in again with the given provider." responses: { key: "200"; value: { @@ -874,7 +1090,7 @@ service AdminService { responses: { key: "400"; value: { - description: "unable to reactivate idp"; + description: "unable to reactivate IDP"; schema: { json_schema: { ref: "#/definitions/rpcStatus"; @@ -885,7 +1101,6 @@ service AdminService { }; } - //RemoveIDP deletes the IDP permanetly rpc RemoveIDP(RemoveIDPRequest) returns (RemoveIDPResponse) { option (google.api.http) = { delete: "/idps/{idp_id}"; @@ -896,7 +1111,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "identity provider"; + tags: "Identity Providers"; + summary: "Remove Identity Provider (IDP)"; + description: "Removes the identity provider permanently. All links to the given IDP on users will be deleted as well. They will not be able to log in with the provider afterward. If it is their only authentication possibility it might cause problems." responses: { key: "200"; value: { @@ -906,7 +1123,7 @@ service AdminService { responses: { key: "400"; value: { - description: "unable to remove idp"; + description: "unable to remove IDP"; schema: { json_schema: { ref: "#/definitions/rpcStatus"; @@ -917,8 +1134,6 @@ service AdminService { }; } - //Updates the oidc configuration of the specified idp - // all fields are updated. If no value is provided the field will be empty afterwards. rpc UpdateIDPOIDCConfig(UpdateIDPOIDCConfigRequest) returns (UpdateIDPOIDCConfigResponse) { option (google.api.http) = { put: "/idps/{idp_id}/oidc_config"; @@ -930,12 +1145,13 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "identity provider"; - tags: "oidc"; + tags: "Identity Providers"; + summary: "Update OIDC Identity Provider (IDP)"; + description: "Update the OIDC-specific configuration of an identity provider. All fields will be updated. If a field has no value it will be empty afterward." responses: { key: "200"; value: { - description: "oidc config updated"; + description: "OIDC config updated"; }; }; responses: { @@ -963,8 +1179,6 @@ service AdminService { }; } - //Updates the jwt configuration of the specified idp - // all fields are updated. If no value is provided the field will be empty afterwards. rpc UpdateIDPJWTConfig(UpdateIDPJWTConfigRequest) returns (UpdateIDPJWTConfigResponse) { option (google.api.http) = { put: "/idps/{idp_id}/jwt_config"; @@ -976,12 +1190,13 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "identity provider"; - tags: "jwt"; + tags: "Identity Providers"; + summary: "Update JWT Identity Provider (IDP)"; + description: "Update the JWT-specific configuration of an identity provider. All fields will be updated. If a field has no value it will be empty afterward." responses: { key: "200"; value: { - description: "jwt config updated"; + description: "JWT config updated"; }; }; responses: { @@ -1093,9 +1308,7 @@ service AdminService { }; } - //deprecated: please use DomainPolicy instead - //Returns the Org IAM policy defined by the administrators of ZITADEL - rpc GetOrgIAMPolicy(GetOrgIAMPolicyRequest) returns (GetOrgIAMPolicyResponse) { + rpc GetOrgIAMPolicy(GetOrgIAMPolicyRequest) returns (GetOrgIAMPolicyResponse) { option (google.api.http) = { get: "/policies/orgiam"; }; @@ -1105,20 +1318,14 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "domain policy"; - tags: "policy"; - responses: { - key: "200"; - value: { - description: "default domain policy"; - }; - }; + tags: "Settings"; + tags: "Domain Settings"; + summary: "Get Org IAM Policy"; + description: "Use Get Domain Settings instead" + deprecated: true; }; } - //deprecated: please use DomainPolicy instead - //Updates the default OrgIAM policy. - // it impacts all organisations without a customised policy rpc UpdateOrgIAMPolicy(UpdateOrgIAMPolicyRequest) returns (UpdateOrgIAMPolicyResponse) { option (google.api.http) = { put: "/policies/orgiam"; @@ -1130,19 +1337,14 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "domain policy"; - tags: "policy"; - responses: { - key: "200"; - value: { - description: "default domain policy updated"; - }; - }; + tags: "Settings"; + tags: "Domain Settings"; + summary: "Update Org IAM Policy"; + description: "Use Update Domain Settings instead"; + deprecated: true; }; } - //deprecated: please use DomainPolicy instead - //Returns the customised policy or the default if not customised rpc GetCustomOrgIAMPolicy(GetCustomOrgIAMPolicyRequest) returns (GetCustomOrgIAMPolicyResponse) { option (google.api.http) = { get: "/orgs/{org_id}/policies/orgiam"; @@ -1153,19 +1355,14 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "domain policy"; - tags: "policy"; - responses: { - key: "200"; - value: { - description: "domain policy of the org or the default policy if not customized"; - }; - }; + tags: "Settings"; + tags: "Domain Settings"; + summary: "Get Org IAM Policy"; + description: "Use GetDomain Settings for Organization instead"; + deprecated: true; }; } - //deprecated: please use DomainPolicy instead - //Defines a custom OrgIAM policy as specified rpc AddCustomOrgIAMPolicy(AddCustomOrgIAMPolicyRequest) returns (AddCustomOrgIAMPolicyResponse) { option (google.api.http) = { post: "/orgs/{org_id}/policies/orgiam"; @@ -1177,19 +1374,14 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "domain policy"; - tags: "policy"; - responses: { - key: "200"; - value: { - description: "domain policy created"; - }; - }; + tags: "Settings"; + tags: "Domain Settings"; + summary: "Add Custom Org IAM Policy"; + description: "Use Get Domain Settings for Organization instead" + deprecated: true; }; } - //deprecated: please use DomainPolicy instead - //Updates a custom OrgIAM policy as specified rpc UpdateCustomOrgIAMPolicy(UpdateCustomOrgIAMPolicyRequest) returns (UpdateCustomOrgIAMPolicyResponse) { option (google.api.http) = { put: "/orgs/{org_id}/policies/orgiam"; @@ -1201,20 +1393,14 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "domain policy"; - tags: "policy"; - responses: { - key: "200"; - value: { - description: "domain policy updated"; - }; - }; + tags: "Settings"; + tags: "Domain Settings"; + summary: "Update Custom Org IAM Policy"; + description: "Use Get Domain Settings for Organization instead" + deprecated: true; }; } - //deprecated: please use DomainPolicy instead - //Resets the org iam policy of the organisation to default - // ZITADEL will fallback to the default policy defined by the ZITADEL administrators rpc ResetCustomOrgIAMPolicyToDefault(ResetCustomOrgIAMPolicyToDefaultRequest) returns (ResetCustomOrgIAMPolicyToDefaultResponse) { option (google.api.http) = { delete: "/orgs/{org_id}/policies/orgiam"; @@ -1225,18 +1411,14 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "orgiam"; - tags: "policy"; - responses: { - key: "200"; - value: { - description: "resets the custom orgiam to the default policy"; - }; - }; + tags: "Settings"; + tags: "Domain Settings"; + summary: "Reset Domain Settings of Organization"; + description: "Use Reset Domain Settings of Organization instead" + deprecated: true; }; } - //Returns the Domain policy defined by the administrators of ZITADEL rpc GetDomainPolicy(GetDomainPolicyRequest) returns (GetDomainPolicyResponse) { option (google.api.http) = { get: "/policies/domain"; @@ -1247,8 +1429,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "domain policy"; - tags: "policy"; + tags: "Settings"; + tags: "Domain Settings"; + summary: "Get Domain Settings"; + description: "Returns the domain settings configured as default on the instance. Domain settings specify how ZITADEL should handle domains, in regards to usernames, emails and validation.." responses: { key: "200"; value: { @@ -1258,8 +1442,6 @@ service AdminService { }; } - //Updates the default Domain policy. - // it impacts all organisations without a customised policy rpc UpdateDomainPolicy(UpdateDomainPolicyRequest) returns (UpdateDomainPolicyResponse) { option (google.api.http) = { put: "/policies/domain"; @@ -1271,8 +1453,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "domain policy"; - tags: "policy"; + tags: "Settings"; + tags: "Domain Settings"; + summary: "Update Domain Settings"; + description: "Update the domain settings configured as default on the instance. Domain settings specify how ZITADEL should handle domains, usernames, emails and validation. It affects all organizations that do not have overwritten settings." responses: { key: "200"; value: { @@ -1282,7 +1466,6 @@ service AdminService { }; } - //Returns the customised policy or the default if not customised rpc GetCustomDomainPolicy(GetCustomDomainPolicyRequest) returns (GetCustomDomainPolicyResponse) { option (google.api.http) = { get: "/orgs/{org_id}/policies/domain"; @@ -1293,8 +1476,11 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "domain policy"; - tags: "policy"; + tags: "Settings"; + tags: "Domain Settings"; + tags: "Organizations"; + summary: "Get Domain Settings for Organization"; + description: "Get the domain settings configured on a specific organization. If the organization doesn't have a custom setting, the default will be returned. Domain settings specify how ZITADEL should handle domains, in regards to usernames, emails and validation." responses: { key: "200"; value: { @@ -1304,7 +1490,6 @@ service AdminService { }; } - //Defines a custom Domain policy as specified rpc AddCustomDomainPolicy(AddCustomDomainPolicyRequest) returns (AddCustomDomainPolicyResponse) { option (google.api.http) = { post: "/orgs/{org_id}/policies/domain"; @@ -1316,8 +1501,11 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "domain policy"; - tags: "policy"; + tags: "Settings"; + tags: "Domain Settings"; + tags: "Organizations"; + summary: "Get Domain Settings for Organization"; + description: "Create the domain settings configured on a specific organization. It will overwrite the settings specified on the instance. Domain settings specify how ZITADEL should handle domains, in regards to usernames, emails and validation." responses: { key: "200"; value: { @@ -1327,7 +1515,6 @@ service AdminService { }; } - //Updates a custom Domain policy as specified rpc UpdateCustomDomainPolicy(UpdateCustomDomainPolicyRequest) returns (UpdateCustomDomainPolicyResponse) { option (google.api.http) = { put: "/orgs/{org_id}/policies/domain"; @@ -1339,8 +1526,11 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "domain policy"; - tags: "policy"; + tags: "Settings"; + tags: "Domain Settings"; + tags: "Organizations"; + summary: "Update Domain Settings for Organization"; + description: "Update the domain settings configured on a specific organization. It will overwrite the settings specified on the instance. Domain settings specify how ZITADEL should handle domains, in regards to usernames, emails and validation." responses: { key: "200"; value: { @@ -1350,8 +1540,6 @@ service AdminService { }; } - //Resets the org iam policy of the organisation to default - // ZITADEL will fallback to the default policy defined by the ZITADEL administrators rpc ResetCustomDomainPolicyToDefault(ResetCustomDomainPolicyToDefaultRequest) returns (ResetCustomDomainPolicyToDefaultResponse) { option (google.api.http) = { delete: "/orgs/{org_id}/policies/domain"; @@ -1362,18 +1550,20 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "domainpolicy"; - tags: "policy"; + tags: "Settings"; + tags: "Domain Settings"; + tags: "Organizations"; + summary: "Reset Domain Settings of Organization"; + description: "Resets the domain settings configured on a specific organization to the settings configured on the instance. Domain settings specify how ZITADEL should handle domains, in regards to usernames, emails and validation." responses: { key: "200"; value: { - description: "resets the custom domainpolicy to the default policy"; + description: "resets the custom domain policy to the default policy"; }; }; }; } - //Returns the label policy defined by the administrators of ZITADEL rpc GetLabelPolicy(GetLabelPolicyRequest) returns (GetLabelPolicyResponse) { option (google.api.http) = { get: "/policies/label"; @@ -1384,8 +1574,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "label policy"; - tags: "policy"; + tags: "Settings"; + tags: "Branding"; + summary: "Get Private Labeling/Branding Settings"; + description: "Returns the currently active private labeling/branding configured on the instance level. The settings will trigger if the organization has not overwritten the settings or if no specific organization is called on the login UI. Define what colors, fonts, and logo should be used for the Login/Register UI, E-Mails and Console." responses: { key: "200"; value: { @@ -1395,7 +1587,6 @@ service AdminService { }; } - //Returns the preview label policy defined by the administrators of ZITADEL rpc GetPreviewLabelPolicy(GetPreviewLabelPolicyRequest) returns (GetPreviewLabelPolicyResponse) { option (google.api.http) = { get: "/policies/label/_preview"; @@ -1406,8 +1597,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "label policy"; - tags: "policy"; + tags: "Settings"; + tags: "Branding"; + summary: "Get Preview Private Labeling/Branding Settings"; + description: "Returns the preview private labeling/branding configured on the instance level. The preview is used to show you how it will look like, and not activate it directly for your users. In the future, it should be possible to send a preview mail and have a look at the preview login. The settings will trigger if the organization has not overwritten the settings or if no specific organization is called on the login UI. Define what colors, fonts, and logo should be used for the Login/Register UI, E-Mails and Console." responses: { key: "200"; value: { @@ -1417,9 +1610,7 @@ service AdminService { }; } - //Updates the default label policy of ZITADEL - // it impacts all organisations without a customised policy - rpc UpdateLabelPolicy(UpdateLabelPolicyRequest) returns (UpdateLabelPolicyResponse) { + rpc UpdateLabelPolicy(UpdateLabelPolicyRequest) returns (UpdateLabelPolicyResponse) { option (google.api.http) = { put: "/policies/label"; body: "*"; @@ -1430,8 +1621,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "label policy"; - tags: "policy"; + tags: "Settings"; + tags: "Branding"; + summary: "Update Labeling/Branding Settings"; + description: "Update the preview private labeling/branding configured on the instance level. It affects all organizations, that don't overwrite the settings. The preview is used to show you how it will look like, make sure to activate it as soon as you are happy with the configuration. Define what colors, fonts, and logo should be used for the Login/Register UI, E-Mails and Console." responses: { key: "200"; value: { @@ -1441,7 +1634,6 @@ service AdminService { }; } - // Activates all changes of the label policy rpc ActivateLabelPolicy(ActivateLabelPolicyRequest) returns (ActivateLabelPolicyResponse) { option (google.api.http) = { post: "/policies/label/_activate" @@ -1451,9 +1643,15 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "policy.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + tags: "Branding"; + summary: "Activate Labeling/Branding Settings"; + description: "Activates the preview private labeling/branding configured on the instance level. It will be shown to the users afterward. It affects all organizations, that don't overwrite the settings. Defines what colors, fonts, and logo should be used for the Login/Register UI, E-Mails and Console." + }; } - // Removes the logo of the label policy rpc RemoveLabelPolicyLogo(RemoveLabelPolicyLogoRequest) returns (RemoveLabelPolicyLogoResponse) { option (google.api.http) = { delete: "/policies/label/logo" @@ -1462,9 +1660,15 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "policy.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + tags: "Branding"; + summary: "Remove Logo Light"; + description: "Removes the logo of the light theme from the configured label policy/branding of the instance. It will only be shown on the preview. Make sure to activate your changes afterward." + }; } - // Removes the logo dark of the label policy rpc RemoveLabelPolicyLogoDark(RemoveLabelPolicyLogoDarkRequest) returns (RemoveLabelPolicyLogoDarkResponse) { option (google.api.http) = { delete: "/policies/label/logo_dark" @@ -1473,9 +1677,15 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "policy.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + tags: "Branding"; + summary: "Remove Logo Dark"; + description: "Removes the logo of the dark theme from the configured label policy/branding of the instance. It will only be shown on the preview. Make sure to activate your changes afterward." + }; } - // Removes the icon of the label policy rpc RemoveLabelPolicyIcon(RemoveLabelPolicyIconRequest) returns (RemoveLabelPolicyIconResponse) { option (google.api.http) = { delete: "/policies/label/icon" @@ -1484,9 +1694,15 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "policy.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + tags: "Branding"; + summary: "Remove Icon Light"; + description: "Removes the icon of the light theme from the configured label policy/branding of the instance. It will only be shown on the preview. Make sure to activate your changes afterward." + }; } - // Removes the logo dark of the label policy rpc RemoveLabelPolicyIconDark(RemoveLabelPolicyIconDarkRequest) returns (RemoveLabelPolicyIconDarkResponse) { option (google.api.http) = { delete: "/policies/label/icon_dark" @@ -1495,9 +1711,15 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "policy.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + tags: "Branding"; + summary: "Remove Icon Dark"; + description: "Removes the icon of the dark theme from the configured label policy/branding of the instance. It will only be shown on the preview. Make sure to activate your changes afterward." + }; } - // Removes the font of the label policy rpc RemoveLabelPolicyFont(RemoveLabelPolicyFontRequest) returns (RemoveLabelPolicyFontResponse) { option (google.api.http) = { delete: "/policies/label/font" @@ -1506,9 +1728,15 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "policy.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + tags: "Branding"; + summary: "Remove Font"; + description: "Removes the font from the configured label policy/branding of the instance. It will only be shown on the preview. Make sure to activate your changes afterward." + }; } - //Returns the login policy defined by the administrators of ZITADEL rpc GetLoginPolicy(GetLoginPolicyRequest) returns (GetLoginPolicyResponse) { option (google.api.http) = { get: "/policies/login"; @@ -1519,8 +1747,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "login policy"; - tags: "policy"; + tags: "Settings"; + tags: "Login Settings"; + summary: "Get Login Settings"; + description: "Returns the login settings defined on the instance level. It will trigger for all organizations, that don't overwrite the settings. The login policy defines what kind of authentication possibilities the user should have. Generally speaking the behavior of the login and register UI." responses: { key: "200"; value: { @@ -1530,8 +1760,6 @@ service AdminService { }; } - //Updates the default login policy of ZITADEL - // it impacts all organisations without a customised policy rpc UpdateLoginPolicy(UpdateLoginPolicyRequest) returns (UpdateLoginPolicyResponse) { option (google.api.http) = { put: "/policies/login"; @@ -1543,8 +1771,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "login policy"; - tags: "policy"; + tags: "Settings"; + tags: "Login Settings"; + summary: "Update Login Settings"; + description: "Update the default login settings defined on the instance level. It will trigger for all organizations, that don't overwrite the settings. The login policy defines what kind of authentication possibilities the user should have. Generally speaking the behavior of the login and register UI." responses: { key: "200"; value: { @@ -1554,8 +1784,6 @@ service AdminService { }; } - //Returns the idps linked to the default login policy, - // defined by the administrators of ZITADEL rpc ListLoginPolicyIDPs(ListLoginPolicyIDPsRequest) returns (ListLoginPolicyIDPsResponse) { option (google.api.http) = { post: "/policies/login/idps/_search"; @@ -1567,20 +1795,20 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "login policy"; - tags: "policy"; - tags: "identity provider"; + tags: "Settings"; + tags: "Login Settings"; + tags: "Identity Providers" + summary: "List Linked Identity Providers"; + description: "Returns a list of identity providers that are linked in the login policy. This means, that they are configured for the instance and will be shown to the users. It affects all organizations, without custom login settings." responses: { key: "200"; value: { - description: "identity poviders of default login policy"; + description: "Identity providers of default login policy"; }; }; }; } - //Adds the povided idp to the default login policy. - // It impacts all organisations without a customised policy rpc AddIDPToLoginPolicy(AddIDPToLoginPolicyRequest) returns (AddIDPToLoginPolicyResponse) { option (google.api.http) = { post: "/policies/login/idps"; @@ -1592,20 +1820,20 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "login policy"; - tags: "policy"; - tags: "identity provider"; + tags: "Settings"; + tags: "Login Settings"; + tags: "Identity Providers" + summary: "Add Linked Identity Providers"; + description: "Add/link a pre-configured identity provider to the login settings of the instance. This means that it will be shown to the users on the login page. It affects all organizations, without custom login settings." responses: { key: "200"; value: { - description: "identity poviders added to default login policy"; + description: "Identity providers added to default login policy"; }; }; }; } - //Removes the povided idp from the default login policy. - // It impacts all organisations without a customised policy rpc RemoveIDPFromLoginPolicy(RemoveIDPFromLoginPolicyRequest) returns (RemoveIDPFromLoginPolicyResponse) { option (google.api.http) = { delete: "/policies/login/idps/{idp_id}"; @@ -1616,19 +1844,20 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "login policy"; - tags: "policy"; - tags: "identity provider"; + tags: "Settings"; + tags: "Login Settings"; + tags: "Identity Providers" + summary: "Remove Linked Identity Providers"; + description: "Remove an identity provider from the login settings of the instance. This means that it will not be shown to the users on the login page. It affects all organizations, without custom login settings." responses: { key: "200"; value: { - description: "identity poviders removed from default login policy"; + description: "Identity providers removed from default login policy"; }; }; }; } - //Returns the available second factors defined by the administrators of ZITADEL rpc ListLoginPolicySecondFactors(ListLoginPolicySecondFactorsRequest) returns (ListLoginPolicySecondFactorsResponse) { option (google.api.http) = { post: "/policies/login/second_factors/_search"; @@ -1639,9 +1868,11 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "second factor"; - tags: "policy"; - tags: "identity provider"; + tags: "Settings"; + tags: "Login Settings"; + tags: "Authentication Methods" + summary: "List Second Factors (2FA)"; + description: "Returns a list of second factors (2FA) configured on the login settings of the instance. It affects all organizations, without custom login settings. Authentication factors are used as an additional layer of security for your users (e.g. Authentication App, FingerPrint, Windows Hello, etc). Per definition, it is called the second factor as it is used after a password. In the UI we generalize it as multi-factor." responses: { key: "200"; value: { @@ -1651,8 +1882,6 @@ service AdminService { }; } - //Adds a second factor to the default login policy. - // It impacts all organisations without a customised policy rpc AddSecondFactorToLoginPolicy(AddSecondFactorToLoginPolicyRequest) returns (AddSecondFactorToLoginPolicyResponse) { option (google.api.http) = { post: "/policies/login/second_factors"; @@ -1664,9 +1893,11 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "second factor"; - tags: "policy"; - tags: "identity provider"; + tags: "Settings"; + tags: "Login Settings"; + tags: "Authentication Methods" + summary: "Add Second Factor (2FA)"; + description: "Add a new second factor (2FA) to the login settings of the instance. Users will have the possibility to authenticate with the configured factor afterward. It affects all organizations, without custom login settings. Authentication factors are used as an additional factor to add more security to your users (e.g. Authentication App, FingerPrint, Windows Hello, etc). Per definition, it is called a second factor as it is used as an additional authentication after a password. In the UI we generalize this as multi-factor." responses: { key: "200"; value: { @@ -1676,7 +1907,7 @@ service AdminService { responses: { key: "400"; value: { - description: "invalid second factor type"; + description: "invalid second-factor type"; schema: { json_schema: { ref: "#/definitions/rpcStatus"; @@ -1687,8 +1918,6 @@ service AdminService { }; } - //Removes a second factor from the default login policy. - // It impacts all organisations without a customised policy rpc RemoveSecondFactorFromLoginPolicy(RemoveSecondFactorFromLoginPolicyRequest) returns (RemoveSecondFactorFromLoginPolicyResponse) { option (google.api.http) = { delete: "/policies/login/second_factors/{type}"; @@ -1699,9 +1928,11 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "second factor"; - tags: "policy"; - tags: "identity provider"; + tags: "Settings"; + tags: "Login Settings"; + tags: "Authentication Methods" + summary: "Remove Second Factor (2FA)"; + description: "Remove a configured second factor (2FA) from the login settings of the instance. It affects all organizations, without custom login settings. Users will not be able to authenticate with the configured factor afterward. Authentication factors are used as an additional layer of security for your users (e.g. Authentication App, FingerPrint, Windows Hello, etc). Per definition, it is called the second factor as it is used after a password. In the UI we generalize it as multi-factor." responses: { key: "200"; value: { @@ -1711,7 +1942,7 @@ service AdminService { responses: { key: "400"; value: { - description: "invalid second factor type"; + description: "Invalid second-factor type"; schema: { json_schema: { ref: "#/definitions/rpcStatus"; @@ -1722,7 +1953,6 @@ service AdminService { }; } - //Returns the available multi factors defined by the administrators of ZITADEL rpc ListLoginPolicyMultiFactors(ListLoginPolicyMultiFactorsRequest) returns (ListLoginPolicyMultiFactorsResponse) { option (google.api.http) = { post: "/policies/login/multi_factors/_search"; @@ -1733,9 +1963,11 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "multi factor"; - tags: "policy"; - tags: "identity provider"; + tags: "Settings"; + tags: "Login Settings"; + tags: "Authentication Methods" + summary: "List Multi Factors (MFA)"; + description: "Returns a list of multi factors (MFA) configured on the login settings of the instance. It affects all organizations, without custom login settings. Authentication factors are used as an additional layer of security for your users (e.g. Authentication App, FingerPrint, Windows Hello, etc). Per definition, it is called multifactor factor or passwordless as it is used as first and second authentication and a password is not necessary. In the UI we generalize it as passwordless or passkey." responses: { key: "200"; value: { @@ -1745,8 +1977,6 @@ service AdminService { }; } - //Adds a multi factor to the default login policy. - // It impacts all organisations without a customised policy rpc AddMultiFactorToLoginPolicy(AddMultiFactorToLoginPolicyRequest) returns (AddMultiFactorToLoginPolicyResponse) { option (google.api.http) = { post: "/policies/login/multi_factors"; @@ -1758,19 +1988,21 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "multi factor"; - tags: "policy"; - tags: "identity provider"; + tags: "Settings"; + tags: "Login Settings"; + tags: "Authentication Methods" + summary: "Add Multi-Factor (MFA)"; + description: "Add a multi-factor (MFA) to the login settings of the instance. It affects all organizations, without custom login settings. Authentication factors are used as an additional layer of security for your users (e.g. Authentication App, FingerPrint, Windows Hello, etc). Per definition, it is called multi-factor factor or passwordless as it is used as first and second authentication and a password is not necessary. In the UI we generalize it as passwordless or passkey." responses: { key: "200"; value: { - description: "multi factor added to default login policy"; + description: "multi-factor added to default login policy"; }; }; responses: { key: "400"; value: { - description: "invalid multi factor type"; + description: "invalid multi-factor type"; schema: { json_schema: { ref: "#/definitions/rpcStatus"; @@ -1781,8 +2013,6 @@ service AdminService { }; } - //Removes a multi factor from the default login policy. - // It impacts all organisations without a customised policy rpc RemoveMultiFactorFromLoginPolicy(RemoveMultiFactorFromLoginPolicyRequest) returns (RemoveMultiFactorFromLoginPolicyResponse) { option (google.api.http) = { delete: "/policies/login/multi_factors/{type}"; @@ -1793,9 +2023,11 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "multi factor"; - tags: "policy"; - tags: "identity provider"; + tags: "Settings"; + tags: "Login Settings"; + tags: "Authentication Methods" + summary: "Remove Multi Factor (MFA)"; + description: "Remove a multi-factor (MFA) from the login settings of the instance. It affects all organizations, without custom login settings. Authentication factors are used as an additional layer of security for your users (e.g. Authentication App, FingerPrint, Windows Hello, etc). Per definition, it is called multi-factor factor or passwordless as it is used as first and second authentication and a password is not necessary. In the UI we generalize it as passwordless or passkey." responses: { key: "200"; value: { @@ -1805,7 +2037,7 @@ service AdminService { responses: { key: "400"; value: { - description: "multi factor type not defined on policy"; + description: "multi-factor type not defined on policy"; schema: { json_schema: { ref: "#/definitions/rpcStatus"; @@ -1816,7 +2048,6 @@ service AdminService { }; } - //Returns the password complexity policy defined by the administrators of ZITADEL rpc GetPasswordComplexityPolicy(GetPasswordComplexityPolicyRequest) returns (GetPasswordComplexityPolicyResponse) { option (google.api.http) = { get: "/policies/password/complexity"; @@ -1827,9 +2058,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "policy"; - tags: "password policy"; - tags: "password complexity"; + tags: "Settings"; + tags: "Password Settings"; + summary: "Get Password Complexity Settings"; + description: "Returns the password complexity settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify how a password should look (characters, length, etc.)" responses: { key: "200"; value: { @@ -1839,8 +2071,6 @@ service AdminService { }; } - //Updates the default password complexity policy of ZITADEL - // it impacts all organisations without a customised policy rpc UpdatePasswordComplexityPolicy(UpdatePasswordComplexityPolicyRequest) returns (UpdatePasswordComplexityPolicyResponse) { option (google.api.http) = { put: "/policies/password/complexity"; @@ -1852,9 +2082,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "policy"; - tags: "password policy"; - tags: "password complexity"; + tags: "Settings"; + tags: "Password Settings"; + summary: "Update Password Complexity Settings"; + description: "Updates the default password complexity settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify how a password should look (characters, length, etc.)" responses: { key: "200"; value: { @@ -1875,7 +2106,6 @@ service AdminService { }; } - //Returns the password age policy defined by the administrators of ZITADEL rpc GetPasswordAgePolicy(GetPasswordAgePolicyRequest) returns (GetPasswordAgePolicyResponse) { option (google.api.http) = { get: "/policies/password/age"; @@ -1886,9 +2116,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "policy"; - tags: "password policy"; - tags: "password age"; + tags: "Settings"; + tags: "Password Settings"; + summary: "Get Password Age Settings"; + description: "Not implemented" responses: { key: "200"; value: { @@ -1898,8 +2129,6 @@ service AdminService { }; } - //Updates the default password age policy of ZITADEL - // it impacts all organisations without a customised policy rpc UpdatePasswordAgePolicy(UpdatePasswordAgePolicyRequest) returns (UpdatePasswordAgePolicyResponse) { option (google.api.http) = { put: "/policies/password/age"; @@ -1911,9 +2140,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "policy"; - tags: "password policy"; - tags: "password age"; + tags: "Settings"; + tags: "Password Settings"; + summary: "Update Password Age Settings"; + description: "Not implemented" responses: { key: "200"; value: { @@ -1934,7 +2164,6 @@ service AdminService { }; } - //Returns the lockout policy defined by the administrators of ZITADEL rpc GetLockoutPolicy(GetLockoutPolicyRequest) returns (GetLockoutPolicyResponse) { option (google.api.http) = { get: "/policies/lockout"; @@ -1945,8 +2174,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "policy"; - tags: "lockout policy"; + tags: "Settings"; + tags: "Password Settings"; + summary: "Get Password Lockout Settings"; + description: "Returns the password lockout settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify when a user should be locked (e.g how many password attempts). The user has to be unlocked by an administrator afterward." responses: { key: "200"; value: { @@ -1956,8 +2187,6 @@ service AdminService { }; } - //Updates the default lockout policy of ZITADEL - // it impacts all organisations without a customised policy rpc UpdateLockoutPolicy(UpdateLockoutPolicyRequest) returns (UpdateLockoutPolicyResponse) { option (google.api.http) = { put: "/policies/password/lockout"; @@ -1967,9 +2196,15 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Settings"; + tags: "Password Settings"; + summary: "Update Password Lockout Settings"; + description: "Update the password lockout settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify when a user should be locked (e.g how many password attempts). The user has to be unlocked by an administrator afterward." + }; } - //Returns the privacy policy defined by the administrators of ZITADEL rpc GetPrivacyPolicy(GetPrivacyPolicyRequest) returns (GetPrivacyPolicyResponse) { option (google.api.http) = { get: "/policies/privacy"; @@ -1980,9 +2215,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "policy"; - tags: "privacy policy"; - tags: "privacy"; + tags: "Settings"; + tags: "Privacy Settings"; + summary: "Get Privacy Settings"; + description: "Returns the privacy settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify the terms and services, privacy policy, etc. A registering user has to accept the configured settings." responses: { key: "200"; value: { @@ -1992,9 +2228,6 @@ service AdminService { }; } - //Updates the default privacy policy of ZITADEL - // it impacts all organisations without a customised policy - // Variable {{.Lang}} can be set to have different links based on the language rpc UpdatePrivacyPolicy(UpdatePrivacyPolicyRequest) returns (UpdatePrivacyPolicyResponse) { option (google.api.http) = { put: "/policies/privacy"; @@ -2006,9 +2239,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "policy"; - tags: "privacy policy"; - tags: "privacy"; + tags: "Settings"; + tags: "Privacy Settings"; + summary: "Update Privacy Settings"; + description: "Update the privacy settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify the terms and services, privacy policy, etc. A registering user has to accept the configured settings. Variable {{.Lang}} can be set to have different links based on the language." responses: { key: "200"; value: { @@ -2029,8 +2263,6 @@ service AdminService { }; } - //Add a default notification policy for ZITADEL - // it impacts all organisations without a customised policy rpc AddNotificationPolicy(AddNotificationPolicyRequest) returns (AddNotificationPolicyResponse) { option (google.api.http) = { post: "/policies/notification" @@ -2042,9 +2274,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "policy"; - tags: "notification policy"; - tags: "notification"; + tags: "Settings"; + tags: "Notification Settings"; + summary: "Add Notification Settings"; + description: "Add new notification settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify if notifications should be sent to the users on specific triggers (e.g password changed)." responses: { key: "200"; value: { @@ -2054,8 +2287,6 @@ service AdminService { }; } - - //Returns the notification policy defined by the administrators of ZITADEL rpc GetNotificationPolicy(GetNotificationPolicyRequest) returns (GetNotificationPolicyResponse) { option (google.api.http) = { get: "/policies/notification"; @@ -2066,9 +2297,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "policy"; - tags: "notification policy"; - tags: "notification"; + tags: "Settings"; + tags: "Notification Settings"; + summary: "Return Notification Settings"; + description: "Return the notification settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify if notifications should be sent to the users on specific triggers (e.g password changed)." responses: { key: "200"; value: { @@ -2078,8 +2310,6 @@ service AdminService { }; } - //Updates the default notification policy of ZITADEL - // it impacts all organisations without a customised policy rpc UpdateNotificationPolicy(UpdateNotificationPolicyRequest) returns (UpdateNotificationPolicyResponse) { option (google.api.http) = { put: "/policies/notification"; @@ -2091,9 +2321,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "policy"; - tags: "notification policy"; - tags: "notification"; + tags: "Settings"; + tags: "Notification Settings"; + summary: "Update Notification Settings"; + description: "Update the notification settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify if notifications should be sent to the users on specific triggers (e.g password changed)." responses: { key: "200"; value: { @@ -2114,7 +2345,6 @@ service AdminService { }; } - //Returns the default text for initial message (translation file) rpc GetDefaultInitMessageText(GetDefaultInitMessageTextRequest) returns (GetDefaultInitMessageTextResponse) { option (google.api.http) = { get: "/text/default/message/init/{language}"; @@ -2123,9 +2353,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Default Init Message Text"; + description: "Get the default text of the initialize-user message/email that is stored as translation files in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured. The email is sent when a user is created and has either no password or a non-verified email address." + }; } - //Returns the custom text for initial message (overwritten in eventstore) rpc GetCustomInitMessageText(GetCustomInitMessageTextRequest) returns (GetCustomInitMessageTextResponse) { option (google.api.http) = { get: "/text/message/init/{language}"; @@ -2134,13 +2369,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Custom Init Message Text"; + description: "Get the custom text of the initialize-user message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The email is sent when a user is created and has either no password or a non-verified email address." + }; } - - //Sets the default custom text for initial message - // it impacts all organisations without customized initial message text - // The Following Variables can be used: - // {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} rpc SetDefaultInitMessageText(SetDefaultInitMessageTextRequest) returns (SetDefaultInitMessageTextResponse) { option (google.api.http) = { put: "/text/message/init/{language}"; @@ -2150,10 +2386,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Set Default Custom Init Message Text"; + description: "Set the custom text of the initialize-user message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The email is sent when a user is created and has either no password or a non-verified email address. The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}}" + }; } - // Removes the custom init message text of the system - // The default text from the translation file will trigger after rpc ResetCustomInitMessageTextToDefault(ResetCustomInitMessageTextToDefaultRequest) returns (ResetCustomInitMessageTextToDefaultResponse) { option (google.api.http) = { delete: "/text/message/init/{language}" @@ -2162,9 +2402,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.delete" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Reset Custom Init Message Text to Default"; + description: "Removes the custom text of the initialize-user message/email that is overwritten on the instance and triggers the text from the translation files stored in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured." + }; } - //Returns the default text for password reset message (translation file) rpc GetDefaultPasswordResetMessageText(GetDefaultPasswordResetMessageTextRequest) returns (GetDefaultPasswordResetMessageTextResponse) { option (google.api.http) = { get: "/text/deafult/message/passwordreset/{language}"; @@ -2173,9 +2418,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Default Password Reset Message Text"; + description: "Get the default text of the password reset message/email that is stored as translation files in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured. The email is sent when a user triggers the password forgot-request." + }; } - //Returns the custom text for password reset message (overwritten in eventstore) rpc GetCustomPasswordResetMessageText(GetCustomPasswordResetMessageTextRequest) returns (GetCustomPasswordResetMessageTextResponse) { option (google.api.http) = { get: "/text/message/passwordreset/{language}"; @@ -2184,12 +2434,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Custom Password Reset Message Text"; + description: "Get the custom text of the password reset message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The email is sent when a user triggers the password forgot-request." + }; } - //Sets the default custom text for password reset message - // it impacts all organisations without customized password reset message text - // The Following Variables can be used: - // {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} rpc SetDefaultPasswordResetMessageText(SetDefaultPasswordResetMessageTextRequest) returns (SetDefaultPasswordResetMessageTextResponse) { option (google.api.http) = { put: "/text/message/passwordreset/{language}"; @@ -2200,10 +2452,13 @@ service AdminService { permission: "iam.policy.write"; }; + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Set Default Custom Password Reset Message Text"; + description: "Set the custom text of the password reset user message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The email is sent when a user triggers the password forgot-request. The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}}" + }; } - // Removes the custom password reset message text of the system - // The default text from the translation file will trigger after rpc ResetCustomPasswordResetMessageTextToDefault(ResetCustomPasswordResetMessageTextToDefaultRequest) returns (ResetCustomPasswordResetMessageTextToDefaultResponse) { option (google.api.http) = { delete: "/text/message/verifyemail/{language}" @@ -2212,9 +2467,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.delete" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Reset Custom Password Reset Message Text to Default"; + description: "Removes the custom text of the password reset user message/email that is overwritten on the instance and triggers the text from the translation files stored in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured." + }; } - //Returns the default text for verify email message (translation files) rpc GetDefaultVerifyEmailMessageText(GetDefaultVerifyEmailMessageTextRequest) returns (GetDefaultVerifyEmailMessageTextResponse) { option (google.api.http) = { get: "/text/default/message/verifyemail/{language}"; @@ -2223,9 +2483,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Default Verify Email Message Text"; + description: "Get the default text of the verify-email message/email that is stored as translation files in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured. The email is sent when a user adds a new non-verified email address." + }; } - //Returns the custom text for verify email message (overwritten in eventstore) rpc GetCustomVerifyEmailMessageText(GetCustomVerifyEmailMessageTextRequest) returns (GetCustomVerifyEmailMessageTextResponse) { option (google.api.http) = { get: "/text/message/verifyemail/{language}"; @@ -2234,12 +2499,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Custom Verify Email Message Text"; + description: "Get the custom text of the verify-email message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The email is sent when a user adds a new non-verified email address." + }; } - //Sets the default custom text for verify email message - // it impacts all organisations without customized verify email message text - // The Following Variables can be used: - // {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} rpc SetDefaultVerifyEmailMessageText(SetDefaultVerifyEmailMessageTextRequest) returns (SetDefaultVerifyEmailMessageTextResponse) { option (google.api.http) = { put: "/text/message/verifyemail/{language}"; @@ -2249,10 +2516,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Set Default Verify Email Reset Message Text"; + description: "Set the custom text of the verify email user message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The email is sent when a user adds a new nonverified email address. The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}}" + }; } - // Removes the custom verify email message text of the system - // The default text from the translation file will trigger after rpc ResetCustomVerifyEmailMessageTextToDefault(ResetCustomVerifyEmailMessageTextToDefaultRequest) returns (ResetCustomVerifyEmailMessageTextToDefaultResponse) { option (google.api.http) = { delete: "/text/message/verifyemail/{language}" @@ -2261,9 +2532,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.delete" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Reset Custom Verify Email Message Text to Default"; + description: "Removes the custom text of the email verify user message/email that is overwritten on the instance and triggers the text from the translation files stored in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured." + }; } - //Returns the default text for verify phone message (translation file) rpc GetDefaultVerifyPhoneMessageText(GetDefaultVerifyPhoneMessageTextRequest) returns (GetDefaultVerifyPhoneMessageTextResponse) { option (google.api.http) = { get: "/text/default/message/verifyphone/{language}"; @@ -2272,9 +2548,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Default Verify Phone Message Text"; + description: "Get the default text of the verify-phone message that is stored as translation files in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when a user adds a new non-verified phone number and a notification provider is configured." + }; } - //Returns the custom text for verify phone message rpc GetCustomVerifyPhoneMessageText(GetCustomVerifyPhoneMessageTextRequest) returns (GetCustomVerifyPhoneMessageTextResponse) { option (google.api.http) = { get: "/text/message/verifyphone/{language}"; @@ -2283,12 +2564,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Custom Verify Phone Message Text"; + description: "Get the custom text of the verify-phone message that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when a user adds a new non-verified phone number and a notification provider is configured." + }; } - //Sets the default custom text for verify phone message - // it impacts all organisations without customized verify phone message text - // The Following Variables can be used: - // {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} rpc SetDefaultVerifyPhoneMessageText(SetDefaultVerifyPhoneMessageTextRequest) returns (SetDefaultVerifyPhoneMessageTextResponse) { option (google.api.http) = { put: "/text/message/verifyphone/{language}"; @@ -2298,10 +2581,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Set Default Verify Phone Reset Message Text"; + description: "Set the custom text of the verify-phone user message that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when a user adds a new non-verified phone number and a notification provider is configured. The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}}" + }; } - // Removes the custom verify phone text of the system - // The default text from the translation file will trigger after rpc ResetCustomVerifyPhoneMessageTextToDefault(ResetCustomVerifyPhoneMessageTextToDefaultRequest) returns (ResetCustomVerifyPhoneMessageTextToDefaultResponse) { option (google.api.http) = { delete: "/text/message/verifyphone/{language}" @@ -2310,9 +2597,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.delete" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Reset Custom Verify Phone Message Text to Default"; + description: "Removes the custom text of the verify-phone message that is overwritten on the instance and triggers the text from the translation files stored in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured." + }; } - //Returns the default text for domain claimed message (translation file) rpc GetDefaultDomainClaimedMessageText(GetDefaultDomainClaimedMessageTextRequest) returns (GetDefaultDomainClaimedMessageTextResponse) { option (google.api.http) = { get: "/text/default/message/domainclaimed/{language}"; @@ -2321,9 +2613,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Default Domain Claimed Message Text"; + description: "Get the default text of the domain claimed message/email that is stored as translation files in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when an organization claims a domain and a user of this domain exists in another organization." + }; } - //Returns the custom text for domain claimed message (overwritten in eventstore) rpc GetCustomDomainClaimedMessageText(GetCustomDomainClaimedMessageTextRequest) returns (GetCustomDomainClaimedMessageTextResponse) { option (google.api.http) = { get: "/text/message/domainclaimed/{language}"; @@ -2332,12 +2629,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Custom Domain Claimed Message Text"; + description: "Get the custom text of the domain claimed message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when an organization claims a domain and a user of this domain exists in another organization." + }; } - //Sets the default custom text for domain claimed message - // it impacts all organisations without customized domain claimed message text - // The Following Variables can be used: - // {{.Domain}} {{.TempUsername}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} rpc SetDefaultDomainClaimedMessageText(SetDefaultDomainClaimedMessageTextRequest) returns (SetDefaultDomainClaimedMessageTextResponse) { option (google.api.http) = { put: "/text/message/domainclaimed/{language}"; @@ -2347,10 +2646,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Set Default Domain Claimed Message Text"; + description: "Set the custom text of the domain claimed message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The message/email is sent when an organization claims a domain and a user of this domain exists in another organization. The Following Variables can be used: {{.Domain}} {{.TempUsername}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}}" + }; } - // Removes the custom domain claimed message text of the system - // The default text from the translation file will trigger after rpc ResetCustomDomainClaimedMessageTextToDefault(ResetCustomDomainClaimedMessageTextToDefaultRequest) returns (ResetCustomDomainClaimedMessageTextToDefaultResponse) { option (google.api.http) = { delete: "/text/message/domainclaimed/{language}" @@ -2359,9 +2662,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.delete" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Reset Custom Domain Claimed Message Text to Default"; + description: "Removes the custom text of the domain claimed message that is overwritten on the instance and triggers the text from the translation files stored in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured." + }; } - //Returns the default text for passwordless registration message (translation file) rpc GetDefaultPasswordlessRegistrationMessageText(GetDefaultPasswordlessRegistrationMessageTextRequest) returns (GetDefaultPasswordlessRegistrationMessageTextResponse) { option (google.api.http) = { get: "/text/default/message/passwordless_registration/{language}"; @@ -2370,9 +2678,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Default Passwordless Registration Message Text"; + description: "Get the default text of the domain claimed message/email that is stored as translation files in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when a user requests passwordless/passkey registration as email, to be able to configure on another device." + }; } - //Returns the custom text for passwordless registration message (overwritten in eventstore) rpc GetCustomPasswordlessRegistrationMessageText(GetCustomPasswordlessRegistrationMessageTextRequest) returns (GetCustomPasswordlessRegistrationMessageTextResponse) { option (google.api.http) = { get: "/text/message/passwordless_registration/{language}"; @@ -2381,12 +2694,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Custom Passwordless Registration Message Text"; + description: "Get the custom text of the passwordless/passkey registration message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when a user requests passwordless/passkey registration as email, to be able to configure on another device." + }; } - //Sets the default custom text for passwordless registration message - // it impacts all organisations without customized passwordless registration message text - // The Following Variables can be used: - // {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} rpc SetDefaultPasswordlessRegistrationMessageText(SetDefaultPasswordlessRegistrationMessageTextRequest) returns (SetDefaultPasswordlessRegistrationMessageTextResponse) { option (google.api.http) = { put: "/text/message/passwordless_registration/{language}"; @@ -2396,10 +2711,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Set Default Passwordless Registration Message Text"; + description: "Set the custom text of the passwordless/passkey registration message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The message/email is sent when a user requests passwordless/passkey registration as email, to be able to configure on another device. The Following Variables can be used: {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}}" + }; } - // Removes the custom passwordless link message text of the system - // The default text from the translation file will trigger after rpc ResetCustomPasswordlessRegistrationMessageTextToDefault(ResetCustomPasswordlessRegistrationMessageTextToDefaultRequest) returns (ResetCustomPasswordlessRegistrationMessageTextToDefaultResponse) { option (google.api.http) = { delete: "/text/message/passwordless_registration/{language}" @@ -2408,10 +2727,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "policy.delete" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Reset Custom Passwordless Registration Message Text to Default"; + description: "Removes the custom text of the passwordless/passkey registration message that is overwritten on the instance and triggers the text from the translation files stored in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured." + }; } - - //Returns the default text for password change message (translation file) rpc GetDefaultPasswordChangeMessageText(GetDefaultPasswordChangeMessageTextRequest) returns (GetDefaultPasswordChangeMessageTextResponse) { option (google.api.http) = { get: "/text/default/message/password_change/{language}"; @@ -2420,9 +2743,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Default Password Change Message Text"; + description: "Get the default text of the password-changed message/email that is stored as translation files in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when the password of a user has been changed." + }; } - //Returns the custom text for password change message (overwritten in eventstore) rpc GetCustomPasswordChangeMessageText(GetCustomPasswordChangeMessageTextRequest) returns (GetCustomPasswordChangeMessageTextResponse) { option (google.api.http) = { get: "/text/message/password_change/{language}"; @@ -2431,12 +2759,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Get Custom Password Change Message Text"; + description: "Get the custom text of the password-changed message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when the password of a user has been changed." + }; } - //Sets the default custom text for password change message - // it impacts all organisations without customized password change message text - // The Following Variables can be used: - // {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} rpc SetDefaultPasswordChangeMessageText(SetDefaultPasswordChangeMessageTextRequest) returns (SetDefaultPasswordChangeMessageTextResponse) { option (google.api.http) = { put: "/text/message/password_change/{language}"; @@ -2446,10 +2776,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Set Default Password Changed Message Text"; + description: "Set the custom text of the password-changed message/email that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The message/email is sent when the password of a user has been changed. The Following Variables can be used: {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}}" + }; } - // Removes the custom password change message text of the system - // The default text from the translation file will trigger after rpc ResetCustomPasswordChangeMessageTextToDefault(ResetCustomPasswordChangeMessageTextToDefaultRequest) returns (ResetCustomPasswordChangeMessageTextToDefaultResponse) { option (google.api.http) = { delete: "/text/message/password_change/{language}" @@ -2458,10 +2792,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.delete" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Message Texts"; + summary: "Reset Custom Password Changed Message Text to Default"; + description: "Removes the custom text of the password-changed message that is overwritten on the instance and triggers the text from the translation files stored in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured." + }; } - - //Returns the default custom texts for login ui (translation file) rpc GetDefaultLoginTexts(GetDefaultLoginTextsRequest) returns (GetDefaultLoginTextsResponse) { option (google.api.http) = { get: "/text/default/login/{language}"; @@ -2470,9 +2808,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Login Texts"; + summary: "Get Default Login Text"; + description: "Get the default texts for the login and register U of ZITADEL, which are stored as translation files in ZITADEL itself. The text will be shown to the users of all organizations, that do not have a custom text configured." + }; } - //Returns the custom texts for login ui rpc GetCustomLoginTexts(GetCustomLoginTextsRequest) returns (GetCustomLoginTextsResponse) { option (google.api.http) = { get: "/text/login/{language}"; @@ -2481,10 +2824,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Login Texts"; + summary: "Get Custom Login Text"; + description: "Get the custom texts for the login and register UI of ZITADEL, which is overwritten on the instance as settings/database. The text will be shown to the users of all organizations, that do not have a custom text configured." + }; } - //Sets the custom text for login ui - //it impacts all organisations without customized login ui texts rpc SetCustomLoginText(SetCustomLoginTextsRequest) returns (SetCustomLoginTextsResponse) { option (google.api.http) = { put: "/text/login/{language}"; @@ -2494,11 +2841,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.policy.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Login Texts"; + summary: "Set Default Login Text"; + description: "Set the custom texts for the login and register UI of ZITADEL, which is overwritten on the instance as settings/database. The text will be shown to the users of all organizations, that do not have a custom text configured." + }; } - // Removes the custom texts for login ui - // it impacts all organisations without customized login ui texts - // The default text form translation file will trigger after rpc ResetCustomLoginTextToDefault(ResetCustomLoginTextsToDefaultRequest) returns (ResetCustomLoginTextsToDefaultResponse) { option (google.api.http) = { delete: "/text/login/{language}" @@ -2507,9 +2857,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "policy.delete" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Login Texts"; + summary: "Reset Custom Login Text to Default"; + description: "Removes the custom texts for the login and register UI of ZITADEL, which is overwritten on the instance and triggers the text from the translation files stored in ZITADEL itself. The text will be shown to the users of all organizations, that do not have a custom text configured." + }; } - //Returns the IAM roles visible for the requested user rpc ListIAMMemberRoles(ListIAMMemberRolesRequest) returns (ListIAMMemberRolesResponse) { option (google.api.http) = { post: "/members/roles/_search"; @@ -2520,9 +2875,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "iam"; - tags: "member"; - tags: "roles"; + tags: "Members"; + tags: "ZITADEL Administrators"; + summary: "List IAM Member Roles"; + description: "Members are users with permission to administrate ZITADEL on different levels. This request returns all roles possible for a ZITADEL member on the instance level." responses: { key: "200"; value: { @@ -2532,8 +2888,6 @@ service AdminService { }; } - //Returns all members matching the request - // all queries need to match (ANDed) rpc ListIAMMembers(ListIAMMembersRequest) returns (ListIAMMembersResponse) { option (google.api.http) = { post: "/members/_search"; @@ -2545,9 +2899,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "iam"; - tags: "member"; - tags: "iam member"; + tags: "Members"; + tags: "ZITADEL Administrators"; + summary: "List IAM Members"; + description: "Members are users with permission to administrate ZITADEL on different levels. This request returns all users with memberships on the instance level, matching the search queries. The search queries will be AND linked." responses: { key: "200"; value: { @@ -2570,9 +2925,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "iam"; - tags: "member"; - tags: "iam member"; + tags: "Members"; + tags: "ZITADEL Administrators"; + summary: "Add IAM Member"; + description: "Members are users with permission to administrate ZITADEL on different levels. This request adds a new user to the members list with one or multiple roles." responses: { key: "200"; value: { @@ -2593,8 +2949,6 @@ service AdminService { }; } - //Sets the given roles on a member. - // The member has only roles provided by this call rpc UpdateIAMMember(UpdateIAMMemberRequest) returns (UpdateIAMMemberResponse) { option (google.api.http) = { put: "/members/{user_id}"; @@ -2606,9 +2960,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "iam"; - tags: "member"; - tags: "iam member"; + tags: "Members"; + tags: "ZITADEL Administrators"; + summary: "Update IAM Member"; + description: "Members are users with permission to administrate ZITADEL on different levels. This request changes the roles of an existing member. The whole roles list will be updated. Make sure to include roles that you don't want to change (remove)." responses: { key: "200"; value: { @@ -2629,7 +2984,6 @@ service AdminService { }; } - //Removes the user from the membership list of ZITADEL rpc RemoveIAMMember(RemoveIAMMemberRequest) returns (RemoveIAMMemberResponse) { option (google.api.http) = { delete: "/members/{user_id}"; @@ -2640,9 +2994,10 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "iam"; - tags: "member"; - tags: "iam member"; + tags: "Members"; + tags: "ZITADEL Administrators"; + summary: "Remove IAM Member"; + description: "Members are users with permission to administrate ZITADEL on different levels. This request removes a user from the members list on an instance level. The user can still have roles on another level (organization, project)" responses: { key: "200"; value: { @@ -2663,9 +3018,6 @@ service AdminService { }; } - //Returns all stored read models of ZITADEL - // views are used for search optimisation and optimise request latencies - // they represent the delta of the event happend on the objects rpc ListViews(ListViewsRequest) returns (ListViewsResponse) { option (google.api.http) = { post: "/views/_search"; @@ -2676,7 +3028,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "views"; + tags: "Views/Projections"; + summary: "List Views/Projections"; + description: "Returns all stored read models of ZITADEL. Views are used for search optimization and optimizing request latencies. They represent the delta of the event that happened on the objects" responses: { key: "200"; value: { @@ -2686,9 +3040,6 @@ service AdminService { }; } - //Returns event descriptions which cannot be processed. - // It's possible that some events need some retries. - // For example if the SMTP-API wasn't able to send an email at the first time rpc ListFailedEvents(ListFailedEventsRequest) returns (ListFailedEventsResponse) { option (google.api.http) = { post: "/failedevents/_search"; @@ -2699,7 +3050,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "failed events"; + tags: "Failed Events"; + summary: "List Failed Events"; + description: "Returns a list of events that could not be proceeded in the views/projections. Some events need several retries till they succeed. For example, if the SMTP-API wasn't able to send an email the first time." responses: { key: "200"; value: { @@ -2709,11 +3062,6 @@ service AdminService { }; } - //Deletes the event from failed events view. - // the event is not removed from the change stream - // This call is usefull if the system was able to process the event later. - // e.g. if the second try of sending an email was successful. the first try produced a - // failed event. You can find out if it worked on the `failure_count` rpc RemoveFailedEvent(RemoveFailedEventRequest) returns (RemoveFailedEventResponse) { option (google.api.http) = { delete: "/failedevents/{database}/{view_name}/{failed_sequence}"; @@ -2724,7 +3072,9 @@ service AdminService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "failed events"; + tags: "Failed Events"; + summary: "Remove Failed Events"; + description: "Removes the event from the failed evens view, but not from the change stream. This call is useful if the system was able to process the event after some retries. e.g. if the second try of sending an email was successful. the first try produced a failed event. You can find out if it worked on the `failure_count` " responses: { key: "200"; value: { @@ -2745,7 +3095,7 @@ service AdminService { }; } - // Imports data into instance and creates different objects + // Imports data into an instance and creates different objects rpc ImportData(ImportDataRequest) returns (ImportDataResponse) { option (google.api.http) = { post: "/import"; @@ -2755,8 +3105,14 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.write"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Import/Export"; + summary: "Import Data"; + description: "Import data on an instance level to ZITADEL. It can be either directly in the request or you can point to a file on an S3 storage, from which the data should be loaded." + }; } - // Exports data from instance + rpc ExportData(ExportDataRequest) returns (ExportDataResponse) { option (google.api.http) = { post: "/export"; @@ -2766,6 +3122,12 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "iam.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Import/Export"; + summary: "Export Data"; + description: "Export data on an instance level to ZITADEL. It can be either directly exported in the response or you can point to a file on an S3 storage, where the data should be written." + }; } rpc ListEventTypes(ListEventTypesRequest) returns (ListEventTypesResponse) { @@ -2777,6 +3139,12 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "events.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Events"; + summary: "Event types"; + description: "Returns a list of the possible event types in ZITADEL. This is used to filter the event types in the list events request." + }; } rpc ListEvents(ListEventsRequest) returns (ListEventsResponse) { @@ -2788,6 +3156,12 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "events.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Events"; + summary: "Search Events"; + description: "Returns a list of the possible event types in ZITADEL. This is used to filter the event types in the list events request." + }; } rpc ListAggregateTypes(ListAggregateTypesRequest) returns (ListAggregateTypesResponse) { @@ -2799,6 +3173,12 @@ service AdminService { option (zitadel.v1.auth_option) = { permission: "events.read"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Events"; + summary: "List Aggregate Types"; + description: "Returns a list of the possible aggregate types in ZITADEL. This is used to filter the aggregate types in the list events request." + }; } } @@ -2813,11 +3193,23 @@ message HealthzResponse {} message GetSupportedLanguagesRequest {} message GetSupportedLanguagesResponse { - repeated string languages = 1; + repeated string languages = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"en\", \"de\", \"it\"]" + } + ]; } message SetDefaultLanguageRequest { - string language = 1 [(validate.rules).string = {min_len: 1, max_len: 10}]; + string language = 1 [ + (validate.rules).string = {min_len: 1, max_len: 10}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 10; + example: "\"en\""; + } + ]; } message SetDefaultLanguageResponse { @@ -2828,7 +3220,11 @@ message SetDefaultLanguageResponse { message GetDefaultLanguageRequest {} message GetDefaultLanguageResponse { - string language = 1; + string language = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"en\"" + } + ]; } message SetDefaultOrgRequest { @@ -2857,7 +3253,7 @@ message ListInstanceDomainsRequest { zitadel.v1.ListQuery query = 1; // the field the result is sorted zitadel.instance.v1.DomainFieldName sorting_column = 2; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.instance.v1.DomainSearchQuery queries = 3; } @@ -2870,7 +3266,7 @@ message ListInstanceDomainsResponse { message ListSecretGeneratorsRequest { //list limitations and ordering zitadel.v1.ListQuery query = 1; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.settings.v1.SecretGeneratorQuery queries = 2; } @@ -2889,8 +3285,16 @@ message GetSecretGeneratorResponse { message UpdateSecretGeneratorRequest { zitadel.settings.v1.SecretGeneratorType generator_type = 1 [(validate.rules).enum = {defined_only: true, not_in: [0]}]; - uint32 length = 2; - google.protobuf.Duration expiry = 3; + uint32 length = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "6"; + } + ]; + google.protobuf.Duration expiry = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"3600s\""; + } + ]; bool include_lower_letters = 4; bool include_upper_letters = 5; bool include_digits = 6; @@ -2909,12 +3313,45 @@ message GetSMTPConfigResponse { } message AddSMTPConfigRequest { - string sender_address = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string sender_name = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string sender_address = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"noreply@m.zitadel.cloud\""; + min_length: 1; + max_length: 200; + } + ]; + string sender_name = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ZITADEL\""; + min_length: 1; + max_length: 200; + } + ]; bool tls = 3; - string host = 4 [(validate.rules).string = {min_len: 1, max_len: 500}]; - string user = 5; - string password = 6; + string host = 4 [ + (validate.rules).string = {min_len: 1, max_len: 500}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"smtp.postmarkapp.com:587\""; + description: "Make sure to include the port."; + min_length: 1; + max_length: 500; + } + ]; + string user = 5 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"197f0117-529e-443d-bf6c-0292dd9a02b7\""; + } + ]; + string password = 6 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"this-is-my-password\""; + } + ]; } message AddSMTPConfigResponse { @@ -2922,11 +3359,40 @@ message AddSMTPConfigResponse { } message UpdateSMTPConfigRequest { - string sender_address = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string sender_name = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string sender_address = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"noreply@m.zitadel.cloud\""; + min_length: 1; + max_length: 200; + } + ]; + string sender_name = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ZITADEL\""; + min_length: 1; + max_length: 200; + } + ]; bool tls = 3; - string host = 4 [(validate.rules).string = {min_len: 1, max_len: 500}]; - string user = 5; + string host = 4 [ + (validate.rules).string = {min_len: 1, max_len: 500}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"smtp.postmarkapp.com:587\""; + description: "Make sure to include the port."; + min_length: 1; + max_length: 500; + } + ]; + string user = 5 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"197f0117-529e-443d-bf6c-0292dd9a02b7\""; + } + ]; } message UpdateSMTPConfigResponse { @@ -2934,14 +3400,18 @@ message UpdateSMTPConfigResponse { } message UpdateSMTPConfigPasswordRequest { - string password = 1; + string password = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"this-is-my-updated-password\""; + } + ]; } message UpdateSMTPConfigPasswordResponse { zitadel.v1.ObjectDetails details = 1; } -//this is en empty request +//this is an empty request message RemoveSMTPConfigRequest {} message RemoveSMTPConfigResponse { @@ -2967,9 +3437,32 @@ message GetSMSProviderResponse { } message AddSMSProviderTwilioRequest { - string sid = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string token = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string sender_number = 3 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string sid = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"AB123b9e61d238abae7d3be7b65ecbc987\""; + min_length: 1; + max_length: 200; + } + ]; + string token = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + } + ]; + string sender_number = 3 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"AB123b9e61d238abae7d3be7b65ecbc987\""; + min_length: 1; + max_length: 200; + } + ]; } message AddSMSProviderTwilioResponse { @@ -2979,8 +3472,24 @@ message AddSMSProviderTwilioResponse { message UpdateSMSProviderTwilioRequest { string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string sid = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string sender_number = 3 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string sid = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"AB123b9e61d238abae7d3be7b65ecbc987\""; + min_length: 1; + max_length: 200; + } + ]; + string sender_number = 3 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"AB123b9e61d238abae7d3be7b65ecbc987\""; + min_length: 1; + max_length: 200; + } + ]; } message UpdateSMSProviderTwilioResponse { @@ -3073,7 +3582,7 @@ message GetSecurityPolicyResponse{ message SetSecurityPolicyRequest{ // states if iframe embedding is enabled or disabled bool enable_iframe_embedding = 1; - // origins allowed to load ZITADEL in an iframe if enable_iframe_embedding is true + // origins allowed loading ZITADEL in an iframe if enable_iframe_embedding is true repeated string allowed_origins = 2; } @@ -3086,7 +3595,7 @@ message SetSecurityPolicyResponse{ message IsOrgUniqueRequest { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { json_schema: { - description: "All unique fields of an organisation"; + description: "All unique fields of an organization"; required: ["name", "domain"] }; }; @@ -3094,14 +3603,14 @@ message IsOrgUniqueRequest { string name = 1 [ (validate.rules).string = {max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"CAOS AG\""; + example: "\"ZITADEL\""; max_length: 200; } ]; string domain = 2 [ (validate.rules).string = {max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"caos.ch\""; + example: "\"zitadel.cloud\""; max_length: 200; } ]; @@ -3138,7 +3647,7 @@ message ListOrgsRequest { zitadel.v1.ListQuery query = 1; // the field the result is sorted zitadel.org.v1.OrgFieldName sorting_column = 2; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.org.v1.OrgQuery queries = 3; } @@ -3151,7 +3660,7 @@ message ListOrgsResponse { message SetUpOrgRequest { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { json_schema: { - description: "Request to set up an organisation. User is required"; + description: "Request to set up an organization. User is required"; required: ["org", "user"] }; }; @@ -3167,15 +3676,15 @@ message SetUpOrgRequest { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { min_length: 1; max_length: 200; - example: "\"CAOS AG\""; + example: "\"ZITADEL\""; } ]; string domain = 2 [ (validate.rules).string = {max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "ZITADEL generates a domain (.zitadel.ch) for an organisation, the field is not required"; + description: "ZITADEL generates a domain (.zitadel.ch) for an organization, the field is not required"; max_length: 200; - example: "\"caos.ch\""; + example: "\"zitadel.cloud\""; } ]; } @@ -3214,13 +3723,13 @@ message SetUpOrgRequest { (validate.rules).string = {max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { max_length: 200; - example: "\"long_neck\""; + example: "\"gigi-giraffe\""; } ]; string display_name = 4 [ (validate.rules).string = {max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "a user can set his display name, if nothing is set ZITADEL computes \"first_name last_name\""; + description: "a user can set his display name if nothing is set ZITADEL computes \"first_name last_name\""; max_length: 200; example: "\"Gigi Giraffe\""; } @@ -3247,7 +3756,7 @@ message SetUpOrgRequest { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { description: "email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)"; min_length: 1; - example: "\"gigi@caos.ch\""; + example: "\"gigi@zitadel.com\""; } ]; bool is_email_verified = 2; @@ -3276,7 +3785,7 @@ message SetUpOrgRequest { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { min_length: 1; max_length: 200; - example: "\"mr_long_neck\""; + example: "\"gigi-giraffe\""; } ]; @@ -3296,7 +3805,7 @@ message SetUpOrgRequest { oneof user { option (validate.required) = true; - // oneof field for the user managing the organisation + // oneof field for the user managing the organization Human human = 2; } // specify Org Member Roles for the provided user (default is ORG_OWNER if roles are empty) @@ -3351,7 +3860,7 @@ message ListIDPsRequest { zitadel.v1.ListQuery query = 1; // the field the result is sorted zitadel.idp.v1.IDPFieldName sorting_column = 2; - //criterias the client is looking for + //criteria the client is looking for repeated IDPQuery queries = 3; } @@ -3448,6 +3957,7 @@ message AddJWTIDPRequest { string name = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"google\""; min_length: 1; @@ -3462,30 +3972,41 @@ message AddJWTIDPRequest { ]; string jwt_endpoint = 3 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://custom.com/auth/jwt\""; description: "the endpoint where the jwt can be extracted"; + min_length: 1; + max_length: 200; } ]; string issuer = 4 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.custom.com\""; description: "the issuer of the jwt (for validation)"; + min_length: 1; + max_length: 200; } ]; string keys_endpoint = 5 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.custom.com/keys\""; - description: "the endpoint to the key (JWK) which are used to sign the JWT with"; + description: "the endpoint to the key (JWK) which is used to sign the JWT with"; + min_length: 1; + max_length: 200; } ]; string header_name = 6 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"x-auth-token\""; description: "the name of the header where the JWT is sent in, default is authorization"; + min_length: 1; max_length: 200; } ]; @@ -3494,13 +4015,17 @@ message AddJWTIDPRequest { message AddJWTIDPResponse { zitadel.v1.ObjectDetails details = 1; - string idp_id = 2; + string idp_id = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"69234230193872955\""; + } + ]; } message UpdateIDPRequest { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { json_schema: { - description: "Updates fields of an idp"; + description: "Updates fields of an IDP"; required: ["idp_id", "name"] }; }; @@ -3654,7 +4179,7 @@ message UpdateIDPOIDCConfigResponse { message UpdateIDPJWTConfigRequest { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { json_schema: { - required: ["idp_id", "issuer", "keys_endpoint"] + required: ["idp_id", "jwt_endpoint", "issuer", "keys_endpoint", "header_name"] }; }; @@ -3688,7 +4213,7 @@ message UpdateIDPJWTConfigRequest { (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.custom.com/keys\""; - description: "the endpoint to the key (JWK) which are used to sign the JWT with"; + description: "the endpoint to the key (JWK) which is used to sign the JWT with"; min_length: 1; max_length: 200; } @@ -3831,7 +4356,7 @@ message GetCustomOrgIAMPolicyRequest { string org_id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"#69629023906488334\""; + example: "\"69629023906488334\""; min_length: 1; max_length: 200; } @@ -3861,9 +4386,9 @@ message AddCustomOrgIAMPolicyRequest { ]; bool user_login_must_be_domain = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "the username has to end with the domain of it's organisation" + description: "the username has to end with the domain of its organization" } - ]; // the username has to end with the domain of it's organisation (uniqueness is organisation based) + ]; // the username has to end with the domain of its organization (uniqueness is organization based) } message AddCustomOrgIAMPolicyResponse { @@ -3887,7 +4412,7 @@ message UpdateCustomOrgIAMPolicyRequest { ]; bool user_login_must_be_domain = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "the username has to end with the domain of it's organisation" + description: "the username has to end with the domain of its organization" } ]; } @@ -3972,17 +4497,17 @@ message AddCustomDomainPolicyRequest { ]; bool user_login_must_be_domain = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "the username has to end with the domain of it's organisation" + description: "the username has to end with the domain of its organization" } - ]; // the username has to end with the domain of it's organisation (uniqueness is organisation based) + ]; // the username has to end with the domain of its organization (uniqueness is organization based) bool validate_org_domains = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if organisation domains should be validated org count as validated automatically" + description: "defines if organization domains should be validated org count as validated automatically" } ]; bool smtp_sender_address_matches_instance_domain = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the smtp sender address domain should match an existing domain on the instance" + description: "defines if the SMTP sender address domain should match an existing domain on the instance" } ]; } @@ -4008,17 +4533,17 @@ message UpdateCustomDomainPolicyRequest { ]; bool user_login_must_be_domain = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "the username has to end with the domain of it's organisation" + description: "the username has to end with the domain of its organization" } ]; bool validate_org_domains = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if organisation domains should be validated org count as validated automatically" + description: "defines if organization domains should be validated org count as validated automatically" } ]; bool smtp_sender_address_matches_instance_domain = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the smtp sender address domain should match an existing domain on the instance" + description: "defines if the SMTP sender address domain should match an existing domain on the instance" } ]; } @@ -4066,7 +4591,7 @@ message UpdateLabelPolicyRequest { string primary_color = 1 [ (validate.rules).string = {max_len: 50}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "respresents a color scheme" + description: "represents a color scheme" example: "\"#353535\""; max_length: 50; } @@ -4142,12 +4667,12 @@ message GetLoginPolicyResponse { message UpdateLoginPolicyRequest { bool allow_username_password = 1 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if a user is allowed to login with his username and password" + description: "defines if a user is allowed to log in with his username and password" } ]; bool allow_register = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if a person is allowed to register a user on this organisation" + description: "defines if a person is allowed to register a user on this organization" } ]; bool allow_external_idp = 3 [ @@ -4157,7 +4682,7 @@ message UpdateLoginPolicyRequest { ]; bool force_mfa = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if a user MUST use a multi factor to log in" + description: "defines if a user MUST use a multi-factor to log in" } ]; zitadel.policy.v1.PasswordlessType passwordless_type = 5 [ @@ -4172,7 +4697,7 @@ message UpdateLoginPolicyRequest { ]; bool ignore_unknown_usernames = 7 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if unknown username on login screen directly return an error or always display the password screen" + description: "defines if unknown username on login screen directly returns an error or always displays the password screen" } ]; string default_redirect_uri = 8 [ @@ -4185,20 +4710,20 @@ message UpdateLoginPolicyRequest { google.protobuf.Duration mfa_init_skip_lifetime = 11; google.protobuf.Duration second_factor_check_lifetime = 12; google.protobuf.Duration multi_factor_check_lifetime = 13; - // If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success. + // If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success. bool allow_domain_discovery = 14 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success." + description: "If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success." } ]; bool disable_login_with_email = 15 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if user can additionally (to the loginname) be identified by their verified email address" + description: "defines if the user can additionally (to the login name) be identified by their verified email address" } ]; bool disable_login_with_phone = 16 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if user can additionally (to the loginname) be identified by their verified phone number" + description: "defines if the user can additionally (to the login name) be identified by their verified phone number" } ]; } @@ -4226,12 +4751,14 @@ message AddIDPToLoginPolicyRequest { string idp_id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"69629023906488334\""; + description: "Id of the predefined idp configuration"; min_length: 1; max_length: 200; } - ]; // Id of the predefined idp configuration + ]; } message AddIDPToLoginPolicyResponse { @@ -4350,12 +4877,12 @@ message UpdatePasswordComplexityPolicyRequest { ]; bool has_lowercase = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the password MUST contain a lower case letter" + description: "defines if the password MUST contain a lowercase letter" } ]; bool has_number = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the password MUST contain a numer" + description: "defines if the password MUST contain a number" } ]; bool has_symbol = 5 [ @@ -4406,7 +4933,7 @@ message UpdateLockoutPolicyRequest { // failed attempts until a user gets locked uint32 max_password_attempts = 1 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset." + description: "Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset." example: "\"10\"" } ]; @@ -4424,9 +4951,21 @@ message GetPrivacyPolicyResponse { } message UpdatePrivacyPolicyRequest { - string tos_link = 1; - string privacy_link = 2; - string help_link = 3; + string tos_link = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"https://zitadel.com/docs/legal/terms-of-service\""; + } + ]; + string privacy_link = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"https://zitadel.com/docs/legal/privacy-policy\""; + } + ]; + string help_link = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"https://zitadel.com/docs/manuals/introduction\""; + } + ]; } message UpdatePrivacyPolicyResponse { @@ -4475,16 +5014,55 @@ message GetCustomInitMessageTextResponse { message SetDefaultInitMessageTextRequest { string language = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"de\"" + example: "\"de\""; + min_length: 1; + max_length: 200; + } + ]; + string title = 2 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ZITADEL - Initialize User\"" + max_length: 200; + } + ]; + string pre_header = 3 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Initialize User\"" + max_length: 200; + } + ]; + string subject = 4 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Initialize User\"" + max_length: 200; + } + ]; + string greeting = 5 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Hello {{.FirstName}} {{.LastName}},\"" + max_length: 200; + } + ]; + string text = 6 [ + (validate.rules).string = {max_len: 1000}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"This user was created in Zitadel. Use the username {{.PreferredLoginName}} to log in. Please click the button below to finish the initialization process. (Code {{.Code}}) If you didn't ask for this mail, please ignore it.\"" + max_length: 1000; + } + ]; + string button_text = 7 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Finish initialization\"" + max_length: 200; } ]; - string title = 2 [(validate.rules).string = {max_len: 200}]; - string pre_header = 3 [(validate.rules).string = {max_len: 200}]; - string subject = 4 [(validate.rules).string = {max_len: 200}]; - string greeting = 5 [(validate.rules).string = {max_len: 200}]; - string text = 6 [(validate.rules).string = {max_len: 1000}]; - string button_text = 7 [(validate.rules).string = {max_len: 200}]; string footer_text = 8 [(validate.rules).string = {max_len: 200}]; } @@ -4519,16 +5097,55 @@ message GetCustomPasswordResetMessageTextResponse { message SetDefaultPasswordResetMessageTextRequest { string language = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"de\"" + example: "\"de\""; + min_length: 1; + max_length: 200; + } + ]; + string title = 2 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ZITADEL - Reset Password\"" + max_length: 200; + } + ]; + string pre_header = 3 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Reset Password\"" + max_length: 200; + } + ]; + string subject = 4 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Reset Password\"" + max_length: 200; + } + ]; + string greeting = 5 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Hello {{.FirstName}} {{.LastName}},\"" + max_length: 200; + } + ]; + string text = 6 [ + (validate.rules).string = {max_len: 800}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"We received a password reset request. Please use the button below to reset your password. (Code {{.Code}}) If you didn't ask for this mail, please ignore it.\"" + max_length: 800; + } + ]; + string button_text = 7 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Reset Password\"" + max_length: 200; } ]; - string title = 2 [(validate.rules).string = {max_len: 200}]; - string pre_header = 3 [(validate.rules).string = {max_len: 200}]; - string subject = 4 [(validate.rules).string = {max_len: 200}]; - string greeting = 5 [(validate.rules).string = {max_len: 200}]; - string text = 6 [(validate.rules).string = {max_len: 800}]; - string button_text = 7 [(validate.rules).string = {max_len: 200}]; string footer_text = 8 [(validate.rules).string = {max_len: 200}]; } @@ -4563,16 +5180,55 @@ message GetCustomVerifyEmailMessageTextResponse { message SetDefaultVerifyEmailMessageTextRequest { string language = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"de\"" + example: "\"de\""; + min_length: 1; + max_length: 200; + } + ]; + string title = 2 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ZITADEL - Verify Email\"" + max_length: 200; + } + ]; + string pre_header = 3 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Verify Email\"" + max_length: 200; + } + ]; + string subject = 4 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Verify Email\"" + max_length: 200; + } + ]; + string greeting = 5 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Hello {{.FirstName}} {{.LastName}},\"" + max_length: 200; + } + ]; + string text = 6 [ + (validate.rules).string = {max_len: 800}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"A new email has been added. Please use the button below to verify your mail. (Code {{.Code}}) If you didn't add a new email, please ignore this email.\"" + max_length: 800; + } + ]; + string button_text = 7 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Verify Email\"" + max_length: 200; } ]; - string title = 2 [(validate.rules).string = {max_len: 200}]; - string pre_header = 3 [(validate.rules).string = {max_len: 200}]; - string subject = 4 [(validate.rules).string = {max_len: 200}]; - string greeting = 5 [(validate.rules).string = {max_len: 200}]; - string text = 6 [(validate.rules).string = {max_len: 800}]; - string button_text = 7 [(validate.rules).string = {max_len: 200}]; string footer_text = 8 [(validate.rules).string = {max_len: 200}]; } @@ -4607,16 +5263,55 @@ message GetCustomVerifyPhoneMessageTextResponse { message SetDefaultVerifyPhoneMessageTextRequest { string language = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"de\"" + example: "\"de\""; + min_length: 1; + max_length: 200; + } + ]; + string title = 2 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ZITADEL - Verify Phone\"" + max_length: 200; + } + ]; + string pre_header = 3 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Verify Phone\"" + max_length: 200; + } + ]; + string subject = 4 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Verify Phone\"" + max_length: 200; + } + ]; + string greeting = 5 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Hello {{.FirstName}} {{.LastName}},\"" + max_length: 200; + } + ]; + string text = 6 [ + (validate.rules).string = {max_len: 800}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"A new phone number has been added. Please use the following code to verify it {{.Code}}.\"" + max_length: 800; + } + ]; + string button_text = 7 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Verify Phone\"" + max_length: 200; } ]; - string title = 2 [(validate.rules).string = {max_len: 200}]; - string pre_header = 3 [(validate.rules).string = {max_len: 200}]; - string subject = 4 [(validate.rules).string = {max_len: 200}]; - string greeting = 5 [(validate.rules).string = {max_len: 200}]; - string text = 6 [(validate.rules).string = {max_len: 800}]; - string button_text = 7 [(validate.rules).string = {max_len: 200}]; string footer_text = 8 [(validate.rules).string = {max_len: 200}]; } @@ -4651,16 +5346,55 @@ message GetCustomDomainClaimedMessageTextResponse { message SetDefaultDomainClaimedMessageTextRequest { string language = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"de\"" + example: "\"de\""; + min_length: 1; + max_length: 200; + } + ]; + string title = 2 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ZITADEL - Domain has been claimed\"" + max_length: 200; + } + ]; + string pre_header = 3 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Change email / username\"" + max_length: 200; + } + ]; + string subject = 4 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Domain has been claimed\"" + max_length: 200; + } + ]; + string greeting = 5 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Hello {{.FirstName}} {{.LastName}},\"" + max_length: 200; + } + ]; + string text = 6 [ + (validate.rules).string = {max_len: 800}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"The domain {{.Domain}} has been claimed by an organization. Your current user {{.UserName}} is not part of this organization. Therefore you'll have to change your email when you log in. We have created a temporary username ({{.TempUsername}}) for this login.\"" + max_length: 800; + } + ]; + string button_text = 7 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Login\"" + max_length: 200; } ]; - string title = 2 [(validate.rules).string = {max_len: 200}]; - string pre_header = 3 [(validate.rules).string = {max_len: 200}]; - string subject = 4 [(validate.rules).string = {max_len: 200}]; - string greeting = 5 [(validate.rules).string = {max_len: 200}]; - string text = 6 [(validate.rules).string = {max_len: 800}]; - string button_text = 7 [(validate.rules).string = {max_len: 200}]; string footer_text = 8 [(validate.rules).string = {max_len: 200}]; } @@ -4695,16 +5429,55 @@ message GetCustomPasswordChangeMessageTextResponse { message SetDefaultPasswordChangeMessageTextRequest { string language = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"de\"" + example: "\"de\""; + min_length: 1; + max_length: 200; + } + ]; + string title = 2 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ZITADEL - Password of the user has changed\"" + max_length: 200; + } + ]; + string pre_header = 3 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Password Changed\"" + max_length: 200; + } + ]; + string subject = 4 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Password of user has changed\"" + max_length: 200; + } + ]; + string greeting = 5 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Hello {{.FirstName}} {{.LastName}},\"" + max_length: 200; + } + ]; + string text = 6 [ + (validate.rules).string = {max_len: 800}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"The password of your user has changed, if this change was not done by you, please be advised to immediately reset your password.\"" + max_length: 800; + } + ]; + string button_text = 7 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Login\"" + max_length: 200; } ]; - string title = 2 [(validate.rules).string = {max_len: 200}]; - string pre_header = 3 [(validate.rules).string = {max_len: 200}]; - string subject = 4 [(validate.rules).string = {max_len: 200}]; - string greeting = 5 [(validate.rules).string = {max_len: 200}]; - string text = 6 [(validate.rules).string = {max_len: 800}]; - string button_text = 7 [(validate.rules).string = {max_len: 200}]; string footer_text = 8 [(validate.rules).string = {max_len: 200}]; } @@ -4740,16 +5513,55 @@ message GetCustomPasswordlessRegistrationMessageTextResponse { message SetDefaultPasswordlessRegistrationMessageTextRequest { string language = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"de\"" + example: "\"de\""; + min_length: 1; + max_length: 200; + } + ]; + string title = 2 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ZITADEL - Add Passwordless Login\"" + max_length: 200; + } + ]; + string pre_header = 3 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Add Passwordless Login\"" + max_length: 200; + } + ]; + string subject = 4 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Add Passwordless Login\"" + max_length: 200; + } + ]; + string greeting = 5 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Hello {{.FirstName}} {{.LastName}},\"" + max_length: 200; + } + ]; + string text = 6 [ + (validate.rules).string = {max_len: 800}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"We received a request to add a token for passwordless login. Please use the button below to add your token or device for passwordless login.\"" + max_length: 800; + } + ]; + string button_text = 7 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Add Passwordless Login\"" + max_length: 200; } ]; - string title = 2 [(validate.rules).string = {max_len: 200}]; - string pre_header = 3 [(validate.rules).string = {max_len: 200}]; - string subject = 4 [(validate.rules).string = {max_len: 200}]; - string greeting = 5 [(validate.rules).string = {max_len: 200}]; - string text = 6 [(validate.rules).string = {max_len: 800}]; - string button_text = 7 [(validate.rules).string = {max_len: 200}]; string footer_text = 8 [(validate.rules).string = {max_len: 200}]; } @@ -4851,8 +5663,12 @@ message AddIAMMemberRequest { max_length: 200; } ]; - //if no roles provided the user won't have any rights - repeated string roles = 2; + repeated string roles = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"IAM_OWNER\"]"; + description: "If no roles are provided the user won't have any rights" + } + ]; } message AddIAMMemberResponse { @@ -4874,8 +5690,12 @@ message UpdateIAMMemberRequest { max_length: 200; } ]; - //if no roles provided the user won't have any rights - repeated string roles = 2; + repeated string roles = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"IAM_OWNER\"]"; + description: "If no roles are provided the user won't have any rights" + } + ]; } message UpdateIAMMemberResponse { @@ -4908,13 +5728,17 @@ message ListIAMMemberRolesRequest {} message ListIAMMemberRolesResponse { zitadel.v1.ListDetails details = 1; - repeated string roles = 2; + repeated string roles = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"IAM_OWNER\"]"; + } + ]; } message ListIAMMembersRequest { //list limitations and ordering zitadel.v1.ListQuery query = 1; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.member.v1.SearchQuery queries = 2; } @@ -5203,12 +6027,28 @@ message ExportDataRequest { string bucket = 6; } message GCSOutput{ - string bucket = 1; - string serviceaccount_json = 2; - string path = 3; + string bucket = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"zitadel-test-bucket\""; + } + ]; + string serviceaccount_json = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ewogICJ0eXFUJEfjjue9WFJishieWNjb3VudCIsCiAgInByb2plY3RfaWQiOiAiY2Fvcy0yNDA4MDkiLAogICJwcml2YXRlX2tleV9pZCI6ICJjMmFlYWQwZjYwODk5MGU4NzM0NjllYThiYWZlMjdhZGQ2YTAyMzY2IiwKICAicHJpdmF0ZV9rZXkiOiAiLS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tJFOgj8JeJFNOEFGQkFEQU5CZ2txaGtpRzl3MEJBUUVGQUFTQ0JLZ3dnZ1NrQWdFQUFvSUJBUUNZcHlqMDBqMnRCRThOXG5NYnNRSUk3dkhudG5oUW1QWThDcWZyTzduZXV1cHRuemphNGxJa0pLeDNmcFZFRDJUWXJySWUfh5JfsoixmXG42MTlTeTVLMWFYY05Xamx0Z1UyMVVvbjJLZzdBbi9BVWJkRDdvUUxaWER1MU0rV09nV0NndUlKZ0ZCNjhVaENnXG5acHBtR1FaeTNvNDJaYVFCTkdVRlprR1Z6UnNtU24zakdWZmNaU202YWJCTm9xaitucFVwMjJraDdkdurTJFISE55HVXZBVWs0cWErMXdnR1BlNlNET3Q4NUQ4WFZKV3Urblc2cTNwQjh0WllCMnJWMlpEcGEwK1NnUzBBYWczSXh1XG5COVpZdm14cVZqYjRYQ2h0a0NDTjRoS25GS1N5K09KdnJBcjZiSTZDek0rRzVYQW1HWUxHVGxpRUMwVUlCVXVlXG44U2llbHVVckFnTUJBQUVDZ2dFQUg0b1YrN00rZS9OU2MrcnM5OUdLUnB4WktkUENYR1pqUmJhazR1UW5jQy9ZXG5BeXFvS3RMdnVHeUsrV0huaEJ3VVVpMXg2TUM2SGtHc3lKL2tVNEpzL3Q5WjhoL01rclB1L3NJZGNBZFRnZmZwXG5qZ2I4Y1NqY29sVWNudjBvZGkrRDYrRURTdCtOVkNKdWZmMkU5QWhDblZRZk5OeitMQ09McGJoeFg0Wi9rQUx0XG5QeHI0TG5yd2VEUWxEcFBtdXhibGpoelJHbEhaVFd1YVRKSU9Lb29USzBXN21OK2lqUXp4c1pMYVFsQjkyanhlXG5VM3BGMFkzK2lIRW42SzBVb2RROHB0b2dld3NjMjFYTTZGbkVTMVB4OFBUWTNHWmVnZEd4eU5rVlVwdklEZkRjXG5RV3lBd2NyS28zenh5VUM4VkZrRFZjZitLSGM5U3NOSk9QWVJlYkQ5UlFLQmdRRFFjYTVWTWYybkx0WkNpc2M2XG5seExnNzAvNzVUekN1R2UvZ0JRVGkrUGk2L1lIWXViVGdPcEkwNkN3TndNOUlVOEIzd2pjWHNndGk3QmVqRmhxXG5PUFRiSS8zL0w2U3BMd2d0d1RmSDhwYlFaUVBCWVM2TmkzclV4OWpoa3Q3RzRGeDhHTnhNanRsZjFjK3ZEbE4rXG41d2p2dytLT2RyYnF4Tjk0a2VsazFETi9Od0tCZ1FDN2V2WXFGZ3QwMWVKOVg1NTdMUUp6ajBqcmYvYk1iYis2XG5PWkpHU2NXY1R2N3oxWEdsRTFEZmpXeDdkQ0tPNG5CbnA3THBDOFhCZUI2a1A2ekJRYk9tRmsvbWtnem1SU2F4XG5SZ2o2N3VzQUdsUzQycktMeUc3Y3c4ZHprL29TaWQ3cTdGaDEvb2hCZmRxYnVmdzdVY2FEMmJ6eUNpQjREdmw0XG5mRDJtRituN3JRS0JnUUNRRmVVQ016bzVkS0RiQW45Uk90anI3OEVFU0tQRm5oN3BPeW1sa1UrSHJzQTB2dUw4XG5WT0tlVU51RXM2SmpnVURSOUZCMXRIYi9OTTVIclEvNDdVSWtzUzZFVlhTbkZrRzdEeEwxL2ZUT1BPVnBxVG02XG4waTJvSkRVQlNMc0NFbGtiMXp1QkdFV2VmM2UrZEZLM0tCRC9YQktoaytKQlNyR0c4S1c2OHd4ZDVRS0JnUUNRXG5oanludXZDLzgzV3l3bmh3YWdVZXdsRXJRaTBsOEdEQmxVbitwellQeGhIaU5DTjBac3lNV1FCTXR2MUErcXcrXG5LOWZPc1VXVVhCMzY3aDhscDVsdXFucVR1dmo0dGt3YWttdXZ6V2daWHpMNmdaVHNEdW52ZzNrSXp3VVRMM2RKXG4wRUp0UzNjTVRaR3RSSlY5d1E5d2F2U3QvVUtFYXI3RHM3cnVoRGJhelFLQmdCOEQvbm83NXdISW9zd3p5bUo3XG43STNXekgzUzRsV2s2bUdMdjdlTnR3bFBPWVR6VHhyVFRtVzJHRDExNlhQRkQrbUFnanIwYlNzMDdJd2F5aytzXG5ZUmtGWmQ0emZnb2ZyVU1QS1d6WVBWS0RPOVNGMlFTU0V6SVNmU3p3SkZCWFp6d2pKeHdnbXIwbDR6aDJvZURTXG5iYXZOZDVvaHZNR05WZUZrKzVkZ3pKUEhcbi0tLS0tRU5EIFBSSVZBVEUgS0VZLS0tLS1cbiIsCiAgImNsaWVudF9lbWFpbCI6ICJvcmJvcy1iZW56QGNhb3MtMjQwODA5LmlhbS5nc2VydmljZWFjY291bnQuY29tIiwKICAiY2xpZW50X2lkIjogIjExMzU0OTkwNDM2NjczMjE1MzM1NSIsCiAgImF1dGhfdXJpIjogImh0dHBzOi8vYWNjb3VudHMuZ29vZ2xlLmNvbS9vL29hdXRoMi9hdXRoIiwKICAidG9rZW5fdXJpIjogImh0dHBzOi8vb2F1dGgyLmdvb2dsZWFwaXMuY29tL3Rva2VuIiwKICAiYXV0aF9wcm92aWRlcl94NTA5X2NlcnRfdXJsIjogImh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL29hdXRoMi92MS9jZXJ0cyIsCiAgImNsaWVudF94NTA5X2NlcnRfdXJsIjogImh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL3JvYm90L3YxL21ldGFkYXRhL3g1MDkvb3Jib3MtYmVueiU0MGNhb3MtMjQwODA5LmlhbS5nc2VydmljZWFjY291bnQuY29tIgp9Cg==\""; + } + ]; + string path = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"my_export_file.json\""; + } + ]; } - repeated string org_ids = 1; + repeated string org_ids = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"119345938451786790\", \"76693875574553926\"]" + } + ]; repeated string excluded_org_ids = 2; bool with_passwords = 3; bool with_otp = 4; @@ -5216,7 +6056,11 @@ message ExportDataRequest { LocalOutput local_output = 6; S3Output s3_output = 7; GCSOutput gcs_output = 8; - string timeout = 9; + string timeout = 9[ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"30m\""; + } + ]; } message ExportDataResponse { @@ -5224,13 +6068,10 @@ message ExportDataResponse { } message ListEventsRequest { - // sequence represents the order of events. It's always upcounting - // if asc is false sequence is used as less than filter - // if asc is true sequence is used as greater than filter - // if sequence is 0 the field is ignored uint64 sequence = 1 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"2\""; + description: "Sequence represents the order of events. It's always counting. If asc is false, the sequence is used as lesser than filter. If asc is true sequence is used as greater than filter. If the sequence is 0 the field is ignored." } ]; uint32 limit = 2 [ @@ -5250,11 +6091,11 @@ message ListEventsRequest { example: "\"69629023906488334\""; } ]; - // the types are or filtered and must match the type exatly repeated string event_types = 5 [ (validate.rules).repeated = {max_items: 30}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "[\"user.human.added\", \"user.machine\"]"; + description: "The types are filtered by 'or' and must match the type exactly."; } ]; string aggregate_id = 6 [ @@ -5275,12 +6116,10 @@ message ListEventsRequest { example: "\"69629023906488334\""; } ]; - // if asc is false creation_date is used as less than filter - // if asc is true creation_date is used as greater than filter - // if creation_date is not set the field is ignored google.protobuf.Timestamp creation_date = 9 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"2019-04-01T08:45:00.000000Z\""; + description: "If asc is false creation_date is used as less than filter If asc is true creation_date is used as greater than filter. If creation_date is not set the field is ignored."; } ]; } diff --git a/proto/zitadel/app.proto b/proto/zitadel/app.proto index c40077d61..0a855f955 100644 --- a/proto/zitadel/app.proto +++ b/proto/zitadel/app.proto @@ -106,17 +106,17 @@ message OIDCConfig { ]; OIDCVersion version = 9 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "the oidc version used by the application"; + description: "the OIDC version used by the application"; } ]; bool none_compliant = 10 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "specifies wheter the config is oidc compliant. A production configuration SHOULD be compliant"; + description: "specifies whether the config is OIDC compliant. A production configuration SHOULD be compliant"; } ]; repeated zitadel.v1.LocalizedMessage compliance_problems = 11 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "lists the problems for non compliancy"; + description: "lists the problems for non-compliancy"; } ]; bool dev_mode = 12 [ @@ -131,7 +131,7 @@ message OIDCConfig { ]; bool access_token_role_assertion = 14 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "adds roles to the claims of the access token (only if type == jwt) even if they are not requested by scopes"; + description: "adds roles to the claims of the access token (only if type == JWT) even if they are not requested by scopes"; } ]; bool id_token_role_assertion = 15 [ @@ -141,12 +141,12 @@ message OIDCConfig { ]; bool id_token_userinfo_assertion = 16 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "claims of profile, email, address and phone scopes are added to the id token even if an access token is issued. Attention this violates the oidc specification"; + description: "claims of profile, email, address and phone scopes are added to the id token even if an access token is issued. Attention this violates the OIDC specification"; } ]; google.protobuf.Duration clock_skew = 17 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "Used to compensate time difference of servers. Duration added to the \"exp\" claim and substracted from \"iat\", \"auth_time\" and \"nbf\" claims"; + description: "Used to compensate time difference of servers. Duration added to the \"exp\" claim and subtracted from \"iat\", \"auth_time\" and \"nbf\" claims"; // min: "0s"; // max: "5s"; } @@ -154,13 +154,13 @@ message OIDCConfig { repeated string additional_origins = 18 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "[\"https://console.zitadel.ch/auth/callback\"]"; - description: "additional origins (other than the redirect_uris) from where the api can be used"; + description: "additional origins (other than the redirect_uris) from where the API can be used"; } ]; repeated string allowed_origins = 19 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "[\"https://console.zitadel.ch/auth/callback\"]"; - description: "all allowed origins from where the api can be used"; + description: "all allowed origins from where the API can be used"; } ]; } @@ -222,7 +222,7 @@ message APIConfig { ]; APIAuthMethodType auth_method_type = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines how the api passes the login credentials"; + description: "defines how the API passes the login credentials"; } ]; } diff --git a/proto/zitadel/auth.proto b/proto/zitadel/auth.proto index 3f55dbb30..eb6d4cd95 100644 --- a/proto/zitadel/auth.proto +++ b/proto/zitadel/auth.proto @@ -10,6 +10,7 @@ import "zitadel/idp.proto"; import "zitadel/metadata.proto"; import "validate/validate.proto"; import "google/api/annotations.proto"; +import "google/api/field_behavior.proto"; import "google/protobuf/duration.proto"; import "google/protobuf/timestamp.proto"; import "protoc-gen-openapiv2/options/annotations.proto"; @@ -22,7 +23,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { info: { title: "Authentication API aka Auth"; version: "1.0"; - description: "The authentication API is used for all operations on the currently logged in user."; + description: "The authentication API is used for all operations on the currently authenticated user."; contact:{ name: "ZITADEL" url: "https://zitadel.com" @@ -33,7 +34,39 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { url: "https://github.com/zitadel/zitadel/blob/main/LICENSE" }; }; - + tags: [ + { + name: "General" + }, + { + name: "Policies", + description: "Policies are settings that are made on either an instance or organization level of ZITADEL. The policies will have an impact on what a user is allowed to do or what should be shown to the user." + }, + { + name: "User" + }, + { + name: "User Authentication Factor" + }, + { + name: "User Email" + }, + { + name: "User Metadata" + }, + { + name: "User Phone" + }, + { + name: "User Profile" + }, + { + name: "User Social Login" + }, + { + name: "User Tokens" + } + ]; schemes: HTTPS; consumes: "application/json"; @@ -44,13 +77,45 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { produces: "application/grpc"; produces: "application/grpc-web+proto"; - host: "api.zitadel.ch"; + host: "$ZITADEL_DOMAIN"; base_path: "/auth/v1"; external_docs: { description: "Detailed information about ZITADEL", url: "https://zitadel.com/docs" } + + security_definitions: { + security: { + key: "BasicAuth"; + value: { + type: TYPE_BASIC; + } + } + security: { + key: "OAuth2"; + value: { + type: TYPE_OAUTH2; + flow: FLOW_ACCESS_CODE; + authorization_url: "$ZITADEL_DOMAIN/oauth/v2/authorize"; + token_url: "$ZITADEL_DOMAIN/oauth/v2/token"; + scopes: { + scope: { + key: "openid"; + value: "openid"; + } + } + } + } + } + security: { + security_requirement: { + key: "OAuth2"; + value: { + scope: "openid"; + } + } + } }; @@ -59,9 +124,14 @@ service AuthService { option (google.api.http) = { get: "/healthz" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Healthz"; + description: "The health endpoint allows an external system to probe if ZITADEL authentication API is alive" + tags: "General"; + }; } - // Returns the default languages rpc GetSupportedLanguages(GetSupportedLanguagesRequest) returns (GetSupportedLanguagesResponse) { option (google.api.http) = { get: "/languages"; @@ -70,9 +140,15 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Supported Languages"; + description: "The supported/default languages of the system will be returned by the language abbreviation." + tags: "General"; + }; + } - // Returns my full blown user rpc GetMyUser(GetMyUserRequest) returns (GetMyUserResponse) { option (google.api.http) = { get: "/users/me" @@ -81,9 +157,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Get my user"; + description: "Returns the full user object of the authenticated user including the profile, email, phone, etc " + tags: "User"; + }; } - // Changes the user state to deleted rpc RemoveMyUser(RemoveMyUserRequest) returns (RemoveMyUserResponse) { option (google.api.http) = { delete: "/users/me" @@ -92,9 +173,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "user.self.delete" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Delete my user"; + description: "Deletes the currently authenticated user. All authentication tokens will be removed and the user will not be able to make any request." + tags: "User"; + }; } - // Returns the history of the authorized user (each event) rpc ListMyUserChanges(ListMyUserChangesRequest) returns (ListMyUserChangesResponse) { option (google.api.http) = { post: "/users/me/changes/_search" @@ -104,9 +190,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User"; + summary: "Get My User History"; + description: "Returns a list of changes/events that have happened on the authenticated user. It's the history of the user. Make sure to send a limit." + }; } - // Returns the user sessions of the authorized user of the current useragent rpc ListMyUserSessions(ListMyUserSessionsRequest) returns (ListMyUserSessionsResponse) { option (google.api.http) = { post: "/users/me/sessions/_search" @@ -116,9 +207,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User"; + summary: "Get My User Sessions"; + description: "Returns a list of a user session for the user agent of the authenticated user. This can be used to switch accounts in the current application." + }; } - // Returns the user metadata of the authorized user rpc ListMyMetadata(ListMyMetadataRequest) returns (ListMyMetadataResponse) { option (google.api.http) = { post: "/users/me/metadata/_search" @@ -128,9 +224,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Metadata"; + summary: "Get My User Metadata"; + description: "Returns a list of metadata of the authenticated user. Metadata is a key value list with additional information needed on the user." + }; } - // Returns the user metadata by key of the authorized user rpc GetMyMetadata(GetMyMetadataRequest) returns (GetMyMetadataResponse) { option (google.api.http) = { get: "/users/me/metadata/{key}" @@ -139,9 +240,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Metadata"; + summary: "Get My User Metadata By Key"; + description: "Returns a metadata value by a specific key of the authenticated user. Metadata is a key value list with additional information needed on the user." + }; } - // Returns the refresh tokens of the authorized user rpc ListMyRefreshTokens(ListMyRefreshTokensRequest) returns (ListMyRefreshTokensResponse) { option (google.api.http) = { post: "/users/me/tokens/refresh/_search" @@ -151,9 +257,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Tokens"; + summary: "Get Refresh Tokens"; + description: "Returns the list of refresh tokens of the authenticated user." + }; } - // Revokes a single refresh token of the authorized user by its (token) id rpc RevokeMyRefreshToken(RevokeMyRefreshTokenRequest) returns (RevokeMyRefreshTokenResponse) { option (google.api.http) = { delete: "/users/me/tokens/refresh/{id}" @@ -162,9 +273,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Tokens"; + summary: "Revoke Refresh Tokens"; + description: "Revokes a single refresh token of the authorized user by its (token) id." + }; } - // Revokes all refresh tokens of the authorized user rpc RevokeAllMyRefreshTokens(RevokeAllMyRefreshTokensRequest) returns (RevokeAllMyRefreshTokensResponse) { option (google.api.http) = { post: "/users/me/tokens/refresh/_revoke_all" @@ -174,9 +290,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Tokens"; + summary: "Revoke All Refresh Tokens"; + description: "Revokes all refresh tokens of the authenticated user." + }; } - // Change the user name of the authorize user rpc UpdateMyUserName(UpdateMyUserNameRequest) returns (UpdateMyUserNameResponse) { option (google.api.http) = { put: "/users/me/username" @@ -186,10 +307,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Users"; + summary: "Change My Username"; + description: "Changes the username of the authenticated user. The user has to log in with the newly created username afterward." + }; } - // Returns the password complexity policy of my organisation - // This policy defines how the password should look rpc GetMyPasswordComplexityPolicy(GetMyPasswordComplexityPolicyRequest) returns (GetMyPasswordComplexityPolicyResponse) { option (google.api.http) = { get: "/policies/passwords/complexity" @@ -198,9 +323,15 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Password"; + tags: "Policies"; + summary: "Get Passwordcomplexity Policy"; + description: "Returns the password complexity settings that should be used for the authenticated user. It is set either on an instance or organization level. This policy defines how the password should look." + }; } - // Change the password of the authorized user rpc UpdateMyPassword(UpdateMyPasswordRequest) returns (UpdateMyPasswordResponse) { option (google.api.http) = { put: "/users/me/password" @@ -210,9 +341,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Password"; + summary: "Change Password"; + description: "Changes the password of the authenticated user. Make sure the password follows the password complexity policy." + }; } - // Returns the profile information of the authorized user rpc GetMyProfile(GetMyProfileRequest) returns (GetMyProfileResponse) { option (google.api.http) = { get: "/users/me/profile" @@ -221,9 +357,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Profile"; + summary: "Get My Profile"; + description: "Returns the profile information of the authenticated user, this includes first name, last name, etc." + }; } - // Changes the profile information of the authorized user rpc UpdateMyProfile(UpdateMyProfileRequest) returns (UpdateMyProfileResponse) { option (google.api.http) = { put: "/users/me/profile" @@ -233,9 +374,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Profile"; + summary: "Update My Profile"; + description: "Change the profile information of the authenticated user. This includes information like first name, last name, language, etc." + }; } - // Returns the email address of the authorized user rpc GetMyEmail(GetMyEmailRequest) returns (GetMyEmailResponse) { option (google.api.http) = { get: "/users/me/email" @@ -244,10 +390,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Email"; + summary: "Get My Email"; + description: "Returns the email address and the verified flag of the authenticated user." + }; } - // Changes the email address of the authorized user - // An email is sent to the given address, to verify it rpc SetMyEmail(SetMyEmailRequest) returns (SetMyEmailResponse) { option (google.api.http) = { put: "/users/me/email" @@ -257,9 +407,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Email"; + summary: "Update My Email"; + description: "Change the email address of the authenticated user. A verification email will be sent to the given email address." + }; } - // Sets the email address to verified rpc VerifyMyEmail(VerifyMyEmailRequest) returns (VerifyMyEmailResponse) { option (google.api.http) = { post: "/users/me/email/_verify" @@ -269,9 +424,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Email"; + summary: "Verify My Email"; + description: "Verify the email address of the authenticated user with the code that has been sent. State of the email address is verified after." + }; } - // Sends a new email to the last given address to verify it rpc ResendMyEmailVerification(ResendMyEmailVerificationRequest) returns (ResendMyEmailVerificationResponse) { option (google.api.http) = { post: "/users/me/email/_resend_verification" @@ -281,9 +441,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Email"; + summary: "Resend Email Verification"; + description: "A new email will be sent to the last set email address of the authenticated user, the last set email address will be used." + }; } - // Returns the phone number of the authorized user rpc GetMyPhone(GetMyPhoneRequest) returns (GetMyPhoneResponse) { option (google.api.http) = { get: "/users/me/phone" @@ -292,10 +457,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Phone"; + summary: "Get My Phone"; + description: "Returns the phone number of the authenticated user and if the state is verified or not." + }; } - // Sets the phone number of the authorized user - // An sms is sent to the number with a verification code rpc SetMyPhone(SetMyPhoneRequest) returns (SetMyPhoneResponse) { option (google.api.http) = { put: "/users/me/phone" @@ -305,9 +474,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Phone"; + summary: "Set My Phone"; + description: "Sets a new phone number to the authenticated user. If a notification provider is configured the user will receive an sms with a code to authenticate the number." + }; } - // Sets the phone number to verified rpc VerifyMyPhone(VerifyMyPhoneRequest) returns (VerifyMyPhoneResponse) { option (google.api.http) = { post: "/users/me/phone/_verify" @@ -317,9 +491,15 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Phone"; + summary: "Verify Phone"; + description: "Verify the phone number of the authenticated user, with the code that has been sent to the number. State of the phone number is verified after." + }; } - // Resends a sms to the last given phone number, to verify it + // Resends an sms to the last given phone number, to verify it rpc ResendMyPhoneVerification(ResendMyPhoneVerificationRequest) returns (ResendMyPhoneVerificationResponse) { option (google.api.http) = { post: "/users/me/phone/_resend_verification" @@ -329,9 +509,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Phone"; + summary: "Resend Phone verification"; + description: "Resends the verification notification to the last given phone number of the authenticated user. The notification provider has to be configured." + }; } - // Removed the phone number of the authorized user rpc RemoveMyPhone(RemoveMyPhoneRequest) returns (RemoveMyPhoneResponse) { option (google.api.http) = { delete: "/users/me/phone" @@ -340,9 +525,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Phone"; + summary: "Remove Phone Number"; + description: "The phone number of the authenticated user will be removed." + }; } - // Remove my avatar rpc RemoveMyAvatar(RemoveMyAvatarRequest) returns (RemoveMyAvatarResponse) { option (google.api.http) = { delete: "/users/me/avatar" @@ -351,9 +541,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User"; + summary: "Remove My Avatar"; + description: "Remove the avatar of the authenticated user. If no avatar is set a shortcut of the name of the user will be presented." + }; } - // Returns a list of all linked identity providers (social logins, eg. Google, Microsoft, AD, etc.) rpc ListMyLinkedIDPs(ListMyLinkedIDPsRequest) returns (ListMyLinkedIDPsResponse) { option (google.api.http) = { post: "/users/me/idps/_search" @@ -363,9 +558,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Social Login" + summary: "List Social Logins"; + description: "Returns a list of all liked identity providers/social logins of the user. (e. Google, Microsoft, AzureAD, etc.)" + }; } - // Removes a linked identity provider (social logins, eg. Google, Microsoft, AD, etc.) rpc RemoveMyLinkedIDP(RemoveMyLinkedIDPRequest) returns (RemoveMyLinkedIDPResponse) { option (google.api.http) = { delete: "/users/me/idps/{idp_id}/{linked_user_id}" @@ -374,9 +574,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Social Login" + summary: "Remove Social Login"; + description: "Remove one of the linked social logins/identity providers of the authenticated user (e.g. Google, Microsoft, AzureAD, etc.). The user will not be able to log in with the given provider afterward. Make sure the user does have other possibilities to authenticate." + }; } - // Returns all configured authentication factors (second and multi) rpc ListMyAuthFactors(ListMyAuthFactorsRequest) returns (ListMyAuthFactorsResponse) { option (google.api.http) = { post: "/users/me/auth_factors/_search" @@ -385,10 +590,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "List Authentication Factors"; + description: "Returns a list of possible authentication factors, multi-factor (MFA), second-factor (2FA)" + }; } - // Adds a new OTP (One Time Password) Second Factor to the authorized user - // Only one OTP can be configured per user rpc AddMyAuthFactorOTP(AddMyAuthFactorOTPRequest) returns (AddMyAuthFactorOTPResponse) { option (google.api.http) = { post: "/users/me/auth_factors/otp" @@ -397,9 +606,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "Add One-Time-Password (OTP)"; + description: "Add a new One-Time-Password (OTP) factor to the authenticated user. OTP is an authenticator app like Google/Microsoft Authenticator, Authy, etc. Only one OTP per user is allowed. After adding a new OTP it has to be verified." + }; } - // Verify the last added OTP (One Time Password) rpc VerifyMyAuthFactorOTP(VerifyMyAuthFactorOTPRequest) returns (VerifyMyAuthFactorOTPResponse) { option (google.api.http) = { post: "/users/me/auth_factors/otp/_verify" @@ -409,9 +623,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "Verify One-Time-Password (OTP)"; + description: "Verify the last added One-Time-Password (OTP) factor of the authenticated user. OTP is an authenticator app like Google/Microsoft Authenticator, Authy, etc. Only one OTP per user is allowed." + }; } - // Removed the configured OTP (One Time Password) Factor rpc RemoveMyAuthFactorOTP(RemoveMyAuthFactorOTPRequest) returns (RemoveMyAuthFactorOTPResponse) { option (google.api.http) = { delete: "/users/me/auth_factors/otp" @@ -420,10 +639,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "Remove One-Time-Password (OTP)"; + description: "Remove the configured One-Time-Password (OTP) factor of the authenticated user. OTP is an authenticator app like Google/Microsoft Authenticator, Authy, etc. As only one OTP per user is allowed, the user will not have OTP as a second-factor afterward." + }; } - // Adds a new U2F (Universal Second Factor) to the authorized user - // Multiple U2Fs can be configured rpc AddMyAuthFactorU2F(AddMyAuthFactorU2FRequest) returns (AddMyAuthFactorU2FResponse) { option (google.api.http) = { post: "/users/me/auth_factors/u2f" @@ -432,9 +655,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "Add Universal Second Factor (U2F)"; + description: "Add a new Universal-Second-Factor (U2F) to the authenticated user. U2F is a device-dependent authentication like FingerScan, FaceID, WindowHello, etc. The factor has to be verified after adding. Multiple factors can be added." + }; } - // Verifies the last added U2F (Universal Second Factor) of the authorized user rpc VerifyMyAuthFactorU2F(VerifyMyAuthFactorU2FRequest) returns (VerifyMyAuthFactorU2FResponse) { option (google.api.http) = { post: "/users/me/auth_factors/u2f/_verify" @@ -444,9 +672,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "Add Universal Second Factor (U2F)"; + description: "Verify the last added new Universal-Second-Factor (U2F) to the authenticated user." + }; } - // Removes the U2F Authentication from the authorized user rpc RemoveMyAuthFactorU2F(RemoveMyAuthFactorU2FRequest) returns (RemoveMyAuthFactorU2FResponse) { option (google.api.http) = { delete: "/users/me/auth_factors/u2f/{token_id}" @@ -455,9 +688,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "Remove Universal Second Factor (U2F)"; + description: "Remove a specific Universal-Second-Factor (U2F) from the authenticated user by sending the id." + }; } - // Returns all configured passwordless authenticators of the authorized user rpc ListMyPasswordless(ListMyPasswordlessRequest) returns (ListMyPasswordlessResponse) { option (google.api.http) = { post: "/users/me/passwordless/_search" @@ -465,10 +703,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "List Passkey"; + description: "Get the list of configured passkey authentication methods. Like FingerPrint, FaceID, WindowsHello, HardwareToken, etc." + }; } - // Adds a new passwordless authenticator to the authorized user - // Multiple passwordless authentications can be configured rpc AddMyPasswordless(AddMyPasswordlessRequest) returns (AddMyPasswordlessResponse) { option (google.api.http) = { post: "/users/me/passwordless" @@ -477,11 +719,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "Add passkey"; + description: "Add a new passkey authentication method to the authenticated user. Like FingerPrint, FaceID, WindowsHello, HardwareToken, etc. Multiple passkeys can be configured." + }; } - // Adds a new passwordless authenticator link to the authorized user and returns it directly - // This link enables the user to register a new device if current passwordless devices are all platform authenticators - // e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone rpc AddMyPasswordlessLink(AddMyPasswordlessLinkRequest) returns (AddMyPasswordlessLinkResponse) { option (google.api.http) = { post: "/users/me/passwordless/_link" @@ -490,11 +735,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "Add passkey link"; + description: "Adds a new passkey authenticator link to the authenticated user and returns it in the response. This link enables the user to register a new device if current passkey devices are all platform authenticators. e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone" + }; } - // Adds a new passwordless authenticator link to the authorized user and sends it to the registered email address - // This link enables the user to register a new device if current passwordless devices are all platform authenticators - // e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone rpc SendMyPasswordlessLink(SendMyPasswordlessLinkRequest) returns (SendMyPasswordlessLinkResponse) { option (google.api.http) = { post: "/users/me/passwordless/_send_link" @@ -503,9 +751,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "Send passkey link"; + description: "Adds a new passkey authenticator link to the authenticated user and sends it to the registered email address. This link enables the user to register a new device if current passkey devices are all platform authenticators. e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone" + }; } - // Verifies the last added passwordless configuration rpc VerifyMyPasswordless(VerifyMyPasswordlessRequest) returns (VerifyMyPasswordlessResponse) { option (google.api.http) = { post: "/users/me/passwordless/_verify" @@ -515,9 +768,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "Verify passkey"; + description: "Verifies the last added passkey configuration of the authenticated user." + }; } - // Removes the passwordless configuration from the authorized user rpc RemoveMyPasswordless(RemoveMyPasswordlessRequest) returns (RemoveMyPasswordlessResponse) { option (google.api.http) = { delete: "/users/me/passwordless/{token_id}" @@ -526,9 +784,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authentication Factor" + summary: "Remove passkey"; + description: "Remove a passkey configuration from the authenticated user. The user will not be able to log in with that configuration afterward. Make sure the user has other possibilities to log in." + }; } - // Returns all user grants (authorizations) of the authorized user rpc ListMyUserGrants(ListMyUserGrantsRequest) returns (ListMyUserGrantsResponse) { option (google.api.http) = { post: "/usergrants/me/_search" @@ -537,9 +800,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authorizations/Grants" + summary: "List My Authorizations/Grants"; + description: "Returns a list of the authorizations/user grants the authenticated user has. User grants consist of an organization, a project and 1-n roles." + }; } - // Returns a list of organisations where the authorized user has a user grant (authorization) in the context of the requested project rpc ListMyProjectOrgs(ListMyProjectOrgsRequest) returns (ListMyProjectOrgsResponse) { option (google.api.http) = { post: "/global/projectorgs/_search" @@ -549,9 +817,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authorizations/Grants" + summary: "List My Authorizations/Grants"; + description: "Returns a list of the organizations where the authenticated user has any authorizations/user grants. The request is made in the context of the requested project. This request can be used in multi-tenancy applications to show the user a tenant switcher." + }; } - // Returns the permissions the authorized user has in ZITADEL based on his manager roles (e.g ORG_OWNER) rpc ListMyZitadelPermissions(ListMyZitadelPermissionsRequest) returns (ListMyZitadelPermissionsResponse) { option (google.api.http) = { post: "/permissions/zitadel/me/_search" @@ -560,9 +833,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authorizations/Grants" + summary: "List My ZITADEL Permissions"; + description: "Returns a list of permissions the authenticated user has in ZITADEL based on the manager roles the user has. (e.g: ORG_OWNER = org.read, org.write, ...)." + }; } - // Returns a list of roles for the authorized user and project rpc ListMyProjectPermissions(ListMyProjectPermissionsRequest) returns (ListMyProjectPermissionsResponse) { option (google.api.http) = { post: "/permissions/me/_search" @@ -571,10 +849,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Authorizations/Grants" + summary: "List My Project Permissions"; + description: "Returns a list of roles for the authenticated user and for the requesting project (based on the token)." + }; } - // Show all the permissions my user has in ZITADEL (ZITADEL Manager) - // Limit should always be set, there is a default limit set by the service rpc ListMyMemberships(ListMyMembershipsRequest) returns (ListMyMembershipsResponse) { option (google.api.http) = { post: "/memberships/me/_search" @@ -584,9 +866,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "User Memberships" + summary: "List My ZITADEL Permissions"; + description: "Show all the permissions my user has in ZITADEL (ZITADEL Manager). The limit should always be set, there is a default limit set by the service" + }; } - // Returns the label policy of the current organisation rpc GetMyLabelPolicy(GetMyLabelPolicyRequest) returns (GetMyLabelPolicyResponse) { option (google.api.http) = { get: "/policies/label" @@ -595,9 +882,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Policies"; + summary: "Get Label Policy"; + description: "Returns the label settings that should be used for the authenticated user. It is set either on an instance or organization level. This policy defines the branding, colors, fonts, images, etc." + }; } - // Returns the privacy policy of the current organisation rpc GetMyPrivacyPolicy(GetMyPrivacyPolicyRequest) returns (GetMyPrivacyPolicyResponse) { option (google.api.http) = { get: "/policies/privacy" @@ -606,9 +898,14 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Policies"; + summary: "Get Privacy Policy"; + description: "Returns the privacy settings that should be used for the authenticated user. It is set either on an instance or organization level. This policy defines the TOS and terms of service links." + }; } - // Returns the login policy of the current organisation rpc GetMyLoginPolicy(GetMyLoginPolicyRequest) returns (GetMyLoginPolicyResponse) { option (google.api.http) = { get: "/policies/login" @@ -617,6 +914,12 @@ service AuthService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Policies"; + summary: "Get Login Policy"; + description: "Returns the login settings that should be used for the authenticated user. It is set either on an instance or organization level. This policy defines what possibilities the user has to authenticate and to use in the login, e.g social logins, MFA, passkey, etc." + }; } } @@ -631,7 +934,11 @@ message GetSupportedLanguagesRequest {} //This is an empty response message GetSupportedLanguagesResponse { - repeated string languages = 1; + repeated string languages = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"en\", \"de\", \"it\"]" + } + ]; } //This is an empty request @@ -662,7 +969,7 @@ message ListMyUserChangesRequest { message ListMyUserChangesResponse { reserved 1; reserved "details"; - // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) + // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary info) repeated zitadel.change.v1.Change result = 2; } @@ -766,8 +1073,22 @@ message GetMyPasswordComplexityPolicyResponse { } message UpdateMyPasswordRequest { - string old_password = 1 [(validate.rules).string = {min_len: 1, max_bytes: 70}]; - string new_password = 2 [(validate.rules).string = {min_len: 1, max_bytes: 70}]; + string old_password = 1 [ + (validate.rules).string = {min_len: 1, max_bytes: 70}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + example: "\"MyOldPassword12!\""; + } + ]; + string new_password = 2 [ + (validate.rules).string = {min_len: 1, max_bytes: 70}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + example: "\"MyNewPassword12!\""; + } + ]; } message UpdateMyPasswordResponse { @@ -783,11 +1104,47 @@ message GetMyProfileResponse { } message UpdateMyProfileRequest { - string first_name = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string last_name = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string nick_name = 3 [(validate.rules).string = {max_len: 200}]; - string display_name = 4 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string preferred_language = 5 [(validate.rules).string = {max_len: 10}]; + string first_name = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Minnie\""; + } + ]; + string last_name = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Mouse\""; + } + ]; + string nick_name = 3 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Minnie\""; + } + ]; + string display_name = 4 [ + (validate.rules).string = {min_len: 1, max_len: 200},(google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Minnie Mouse\""; + } + ]; + string preferred_language = 5 [ + (validate.rules).string = {max_len: 10}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + max_length: 10; + example: "\"en\""; + } + ]; zitadel.user.v1.Gender gender = 6; } @@ -804,7 +1161,13 @@ message GetMyEmailResponse { } message SetMyEmailRequest { - string email = 1 [(validate.rules).string.email = true]; + string email = 1 [ + (validate.rules).string.email = true, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"gigi@zitadel.com\""; + } + ]; } message SetMyEmailResponse { @@ -812,7 +1175,15 @@ message SetMyEmailResponse { } message VerifyMyEmailRequest { - string code = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string code = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"H83J3\""; + } + ]; } message VerifyMyEmailResponse { @@ -835,7 +1206,15 @@ message GetMyPhoneResponse { } message SetMyPhoneRequest { - string phone = 1 [(validate.rules).string = {min_len: 1, max_len: 50, prefix: "+"}]; + string phone = 1 [ + (validate.rules).string = {min_len: 1, max_len: 50, prefix: "+"}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 50; + example: "\"+41 71 000 00 00\""; + } + ]; } message SetMyPhoneResponse { @@ -843,7 +1222,15 @@ message SetMyPhoneResponse { } message VerifyMyPhoneRequest { - string code = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string code = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"H83J3\""; + } + ]; } message VerifyMyPhoneResponse { @@ -875,7 +1262,7 @@ message ListMyLinkedIDPsRequest { //list limitations and ordering zitadel.v1.ListQuery query = 1; - //PLANNED: queries for idp name and login name + //PLANNED: queries for IDP name and login name } message ListMyLinkedIDPsResponse { @@ -911,13 +1298,27 @@ message AddMyAuthFactorU2FResponse { message AddMyAuthFactorOTPRequest {} message AddMyAuthFactorOTPResponse { - string url = 1; - string secret = 2; + string url = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"otpauth://totp/ZITADEL:gigi@acme.zitadel.cloud?algorithm=SHA1&digits=6&issuer=ZITADEL&period=30&secret=TJOPWSDYILLHXFV4MLKNNJOWFG7VSDCK\""; + } + ]; + string secret = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"TJOPWSDYILLHXFV4MLKNNJOWFG7VSDCK\""; + } + ]; zitadel.v1.ObjectDetails details = 3; } message VerifyMyAuthFactorOTPRequest { - string code = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string code = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"123456\""; + } + ]; } message VerifyMyAuthFactorOTPResponse { @@ -967,8 +1368,16 @@ message AddMyPasswordlessLinkRequest {} message AddMyPasswordlessLinkResponse { zitadel.v1.ObjectDetails details = 1; - string link = 2; - google.protobuf.Duration expiration = 3; + string link = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"https://acme.com/ui/login/login/passwordless/init?userID=182156264229306625&orgID=165947650742997249&codeID=200949504189388947&code=kFfsO8OizZPS\""; + } + ]; + google.protobuf.Duration expiration = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"3600s\""; + } + ]; } //This is an empty request @@ -1005,18 +1414,42 @@ message ListMyUserGrantsResponse { } message UserGrant { - string org_id = 1; - string project_id = 2; - string user_id = 3; - repeated string roles = 4; - string org_name = 5; - string grant_id = 6; + string org_id = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"69629026806489455\"" + } + ]; + string project_id = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"98729028932384528\"" + } + ]; + string user_id = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"28746028909593987\"" + } + ]; + repeated string roles = 4 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"RoleKey1\", \"RoleKey2\"]" + } + ]; + string org_name = 5 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ZITADEL\"" + } + ]; + string grant_id = 6 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"\"" + } + ]; } message ListMyProjectOrgsRequest { //list limitations and ordering zitadel.v1.ListQuery query = 1; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.org.v1.OrgQuery queries = 2; } @@ -1029,20 +1462,28 @@ message ListMyProjectOrgsResponse { message ListMyZitadelPermissionsRequest {} message ListMyZitadelPermissionsResponse { - repeated string result = 1; + repeated string result = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"org.read\", \"org.write\"]" + } + ]; } //This is an empty request message ListMyProjectPermissionsRequest {} message ListMyProjectPermissionsResponse { - repeated string result = 1; + repeated string result = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"RoleKey1\", \"RoleKey2\"]" + } + ]; } message ListMyMembershipsRequest { //the field the result is sorted zitadel.v1.ListQuery query = 1; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.user.v1.MembershipQuery queries = 2; } diff --git a/proto/zitadel/change.proto b/proto/zitadel/change.proto index c88e79178..36ba003a9 100644 --- a/proto/zitadel/change.proto +++ b/proto/zitadel/change.proto @@ -35,7 +35,7 @@ message Change { ]; string resource_owner_id = 6 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "the organisation the event belongs to"; + description: "the organization the event belongs to"; example: "\"69629023906488334\""; } ]; @@ -47,23 +47,29 @@ message Change { ]; string editor_avatar_url = 8 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "avatar url of the editor"; + description: "avatar URL of the editor"; example: "\"https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32\""; } ]; } message ChangeQuery { - //sequence represents the order of events. It's always upcounting + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { + json_schema: { + title: "Query for Changes of an Object" + description: "Filter possibility for the changes/history of an Object." + } + }; uint64 sequence = 1 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"2\""; + description: "sequence represents the order of events. It's always counting"; } ]; uint32 limit = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "20"; - description: "Maximum amount of events returned. Default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If no limit is set or the limit exeeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken."; + description: "Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If no limit is set or the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken."; } ]; bool asc = 3 [ diff --git a/proto/zitadel/event.proto b/proto/zitadel/event.proto index b8ee2944b..d00e1efd5 100644 --- a/proto/zitadel/event.proto +++ b/proto/zitadel/event.proto @@ -15,34 +15,67 @@ message Event { Editor editor = 1; Aggregate aggregate = 2; uint64 sequence = 3; - // The timestamp the event occurred google.protobuf.Timestamp creation_date = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"2019-04-01T08:45:00.000000Z\""; + description: "The timestamp the event occurred"; + } + ]; + google.protobuf.Struct payload = 5 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "{\"firstName\": \"Gigi\", \"lastName\": \"Giraffe\", \"userName\": \"gigi@zitadel.com\", \"displayName\": \"Gigi\"}"; + description: "Payload contains the data of the event."; } ]; - google.protobuf.Struct payload = 5; EventType type = 6; } message Editor { - string user_id = 1; - string display_name = 2; - string service = 3; + string user_id = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"165617389845094785\""; + } + ]; + string display_name = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Minnie Mouse\""; + } + ]; + string service = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"Management-API\""; + } + ]; } message Aggregate { - string id = 1; + string id = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"165617850743094785\""; + } + ]; AggregateType type = 2; - string resource_owner = 3; + string resource_owner = 3[ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"165617850930497249\""; + } + ]; } message EventType { - string type = 1; + string type = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"user.human.added\""; + } + ]; zitadel.v1.LocalizedMessage localized = 2; } message AggregateType { - string type = 1; + string type = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"user\""; + } + ]; zitadel.v1.LocalizedMessage localized = 2; } \ No newline at end of file diff --git a/proto/zitadel/idp.proto b/proto/zitadel/idp.proto index eae33cf02..88adbcff8 100644 --- a/proto/zitadel/idp.proto +++ b/proto/zitadel/idp.proto @@ -124,7 +124,7 @@ enum IDPOwnerType { IDP_OWNER_TYPE_UNSPECIFIED = 0; // system is managed by the ZITADEL administrators IDP_OWNER_TYPE_SYSTEM = 1; - // org is managed by de organisation administrators + // org is managed by de organization administrators IDP_OWNER_TYPE_ORG = 2; } @@ -137,7 +137,7 @@ message OIDCConfig { string issuer = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com\""; - description: "the oidc issuer of the identity provider"; + description: "the OIDC issuer of the identity provider"; } ]; repeated string scopes = 3 [ @@ -170,21 +170,21 @@ message JWTConfig { (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com\""; - description: "the endpoint where the jwt can be extracted"; + description: "the endpoint where the JWT can be extracted"; } ]; string issuer = 2 [ (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com\""; - description: "the issuer of the jwt (for validation)"; + description: "the issuer of the JWT (for validation)"; } ]; string keys_endpoint = 3 [ (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com/keys\""; - description: "the endpoint to the key (JWK) which are used to sign the JWT with"; + description: "the endpoint to the key (JWK) which is used to sign the JWT with"; } ]; string header_name = 4 [ diff --git a/proto/zitadel/instance.proto b/proto/zitadel/instance.proto index 3205d614c..88b2d269f 100644 --- a/proto/zitadel/instance.proto +++ b/proto/zitadel/instance.proto @@ -74,7 +74,7 @@ message Query { } } -//IdQuery is always equals +//IdQuery always equals message IdsQuery { repeated string ids = 1 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { diff --git a/proto/zitadel/management.proto b/proto/zitadel/management.proto index 534945ec3..79df26c7a 100644 --- a/proto/zitadel/management.proto +++ b/proto/zitadel/management.proto @@ -17,6 +17,7 @@ import "zitadel/metadata.proto"; import "zitadel/action.proto"; import "google/api/annotations.proto"; +import "google/api/field_behavior.proto"; import "google/protobuf/timestamp.proto"; import "google/protobuf/duration.proto"; import "protoc-gen-openapiv2/options/annotations.proto"; @@ -31,7 +32,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { info: { title: "Management API"; version: "1.0"; - description: "The management API is as the name states the interface where systems can mutate IAM objects like, organisations, projects, clients, users and so on if they have the necessary access rights."; + description: "The management API is as the name states the interface where systems can mutate IAM objects like organizations, projects, clients, users and so on if they have the necessary access rights."; contact:{ name: "ZITADEL" url: "https://zitadel.com" @@ -40,9 +41,56 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { license: { name: "Apache License 2.0", url: "https://github.com/zitadel/zitadel/blob/main/LICENSE" - }; + } }; - + tags: [ + { + name: "Applications", + description: "Applications are the entry point to your project. Users either login into one of your clients and interact with them directly or use one of your APIs. All applications share the roles and authorizations of their project." + }, + { + name: "Authorization" + }, + { + name: "General" + }, + { + name: "Global" + }, + { + name: "Organizations" + }, + { + name: "Organization Metadata" + }, + { + name: "Policies" + }, + { + name: "Projects", + description: "Projects are vessels for different applications/clients sharing the same role context." + }, + { + name: "Project Roles" + }, + { + name: "Settings" + }, + { + name: "Users", + description: "ZITADEL knows two different types of users: Users (Human) and Service Users (Machine Accounts)" + }, + { + name: "User Human" + }, + { + name: "User Machine" + }, + { + name: "User Metadata", + description: "Metadata is a key/value list to enrich the user object with any data needed. The data is not interpreted by ZITADEL itself." + } + ]; schemes: HTTPS; consumes: "application/json"; @@ -54,7 +102,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { consumes: "application/grpc-web+proto"; produces: "application/grpc-web+proto"; - host: "api.zitadel.ch"; + host: "$ZITADEL_DOMAIN"; base_path: "/management/v1"; external_docs: { @@ -62,29 +110,87 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { url: "https://zitadel.com/docs" } + security_definitions: { + security: { + key: "BasicAuth"; + value: { + type: TYPE_BASIC; + } + } + security: { + key: "OAuth2"; + value: { + type: TYPE_OAUTH2; + flow: FLOW_ACCESS_CODE; + authorization_url: "$ZITADEL_DOMAIN/oauth/v2/authorize"; + token_url: "$ZITADEL_DOMAIN/oauth/v2/token"; + scopes: { + scope: { + key: "openid"; + value: "openid"; + } + scope: { + key: "urn:zitadel:iam:org:project:id:zitadel:aud"; + value: "urn:zitadel:iam:org:project:id:zitadel:aud"; + } + } + } + } + } + security: { + security_requirement: { + key: "OAuth2"; + value: { + scope: "openid"; + scope: "urn:zitadel:iam:org:project:id:zitadel:aud"; + } + } + } extensions: { key: "x-zitadel-orgid"; value: { - string_value: "your-org-id"; + string_value: "$YOUR-ORGANIZATION"; } } }; - service ManagementService { rpc Healthz(HealthzRequest) returns (HealthzResponse) { option (google.api.http) = { get: "/healthz" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Healthz"; + description: "The health endpoint allows an external system to probe if ZITADEL management API is alive" + tags: "General"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + }; } rpc GetOIDCInformation(GetOIDCInformationRequest) returns (GetOIDCInformationResponse) { option (google.api.http) = { get: "/zitadel/docs" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "ZITADEL documentation"; + description: "This endpoint returns some general needed (OIDC) information about ZITADEL like the issuer or discovery endpoint." + tags: "General"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + }; } - // Returns some needed settings of the IAM (Global Organisation ID, Zitadel Project ID) rpc GetIAM(GetIAMRequest) returns (GetIAMResponse) { option (google.api.http) = { get: "/iam" @@ -93,9 +199,20 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Instance information"; + description: "Some needed settings made in ZITADEL like the global organization id or ZITADEL project ID " + tags: "General"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + }; } - // Returns the default languages rpc GetSupportedLanguages(GetSupportedLanguagesRequest) returns (GetSupportedLanguagesResponse) { option (google.api.http) = { get: "/languages"; @@ -104,9 +221,20 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "authenticated"; }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Supported Languages"; + description: "The supported/default languages of the system will be returned by the language abbreviation." + tags: "General"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + }; } - // Returns the requested full blown user (human or machine) rpc GetUserByID(GetUserByIDRequest) returns (GetUserByIDResponse) { option (google.api.http) = { get: "/users/{id}" @@ -115,10 +243,28 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "User by ID"; + description: "Returns the full user object (human or machine) including the profile, email, etc." + tags: "Users"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Searches a user over all organisations - // the login name has to match exactly rpc GetUserByLoginNameGlobal(GetUserByLoginNameGlobalRequest) returns (GetUserByLoginNameGlobalResponse) { option (google.api.http) = { get: "/global/users/_by_login_name" @@ -129,10 +275,10 @@ service ManagementService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - summary: "Search a user within all organisations by it's loginname"; - description: "The request only returns data if the login name matches exactly." - tags: "user"; - tags: "global"; + summary: "Get User by login name (globally)"; + description: "Get a user by login name searched over all organizations. The request only returns data if the login name matches exactly." + tags: "Users"; + tags: "Global"; responses: { key: "200" value: { @@ -142,8 +288,6 @@ service ManagementService { }; } - // Return the users matching the query - // Limit should always be set, there is a default limit set by the service rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) { option (google.api.http) = { post: "/users/_search" @@ -153,10 +297,39 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Users"; + summary: "Search Users"; + description: "Search for users within an organization. By default, we will return users of your organization. Make sure to include a limit and sorting for pagination." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + responses: { + key: "200"; + value: { + description: "A list of all users matching the query"; + }; + }; + responses: { + key: "400"; + value: { + description: "invalid list query"; + schema: { + json_schema: { + ref: "#/definitions/rpcStatus"; + }; + }; + }; + }; + }; } - // Returns the history of the user (each event) - // Limit should always be set, there is a default limit set by the service rpc ListUserChanges(ListUserChangesRequest) returns (ListUserChangesResponse) { option (google.api.http) = { post: "/users/{user_id}/changes/_search" @@ -166,9 +339,22 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Users"; + summary: "Get User History"; + description: "Returns a list of changes/events that have happened on the user. It's the history of the user. Make sure to send a limit." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Returns if a user with the searched email or username is unique rpc IsUserUnique(IsUserUniqueRequest) returns (IsUserUniqueResponse) { option (google.api.http) = { get: "/users/_is_unique" @@ -177,11 +363,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Users"; + summary: "Check for existing user"; + description: "Returns if a user with the requested email or username is unique. So you can create the user." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Create a user of the type human - // A email will be sent to the user if email is not verified or no password is set - // If a password is given, the user has to change on the next login + // deprecated: use ImportHumanUser rpc AddHumanUser(AddHumanUserRequest) returns (AddHumanUserResponse) { option (google.api.http) = { post: "/users/human" @@ -191,11 +389,15 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Deprecated: Create User (Human)"; + description: "Create a new user with the type human. The newly created user will get an initialization email if either the email address is not marked as verified or no password is set. If a password is set the user will not be requested to set a new one on the first login." + tags: "Users"; + deprecated: true; + }; } - // Create a user of the type human - // A email will be sent to the user if email is not verified or no password is set - // If a password is given, the user doesn't have to change on the next login rpc ImportHumanUser(ImportHumanUserRequest) returns (ImportHumanUserResponse) { option (google.api.http) = { post: "/users/human/_import" @@ -205,9 +407,22 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Create User (Human)"; + description: "Create a new user with the type human. The newly created user will get an initialization email if either the email address is not marked as verified or no password is set. If a password is set the user will not be requested to set a new one on the first login." + tags: "Users"; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to add users to another organization include the header. Make sure the user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Create a user of the type machine rpc AddMachineUser(AddMachineUserRequest) returns (AddMachineUserResponse) { option (google.api.http) = { post: "/users/machine" @@ -217,11 +432,21 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Create User (Machine)"; + description: "Create a new user with the type machine for your API, service or device. These users are used for non-interactive authentication flows." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + }; } - // Changes the user state to deactivated - // The user will not be able to login - // returns an error if user state is already deactivated rpc DeactivateUser(DeactivateUserRequest) returns (DeactivateUserResponse) { option (google.api.http) = { post: "/users/{id}/_deactivate" @@ -231,10 +456,20 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Deactivate user"; + description: "The state of the user will be changed to 'deactivated'. The user will not be able to log in anymore. The endpoint returns an error if the user is already in the state 'deactivated'. Use deactivate user when the user should not be able to use the account anymore, but you still need access to the user data." + tags: "Users"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + }; } - // Changes the user state to active - // returns an error if user state is not deactivated rpc ReactivateUser(ReactivateUserRequest) returns (ReactivateUserResponse) { option (google.api.http) = { post: "/users/{id}/_reactivate" @@ -244,11 +479,20 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Reactivate user"; + description: "Reactivate a user with the state 'deactivated'. The user will be able to log in again afterward. The endpoint returns an error if the user is not in the state 'deactivated'." + tags: "Users"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + }; } - // Changes the user state to deactivated - // The user will not be able to login - // returns an error if user state is already locked rpc LockUser(LockUserRequest) returns (LockUserResponse) { option (google.api.http) = { post: "/users/{id}/_lock" @@ -258,10 +502,20 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Lock user"; + description: "The state of the user will be changed to 'locked'. The user will not be able to log in anymore. The endpoint returns an error if the user is already in the state 'locked'. Use this endpoint if the user should not be able to log in temporarily because of an event that happened (wrong password, etc.)" + tags: "Users"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + }; } - // Changes the user state to active - // returns an error if user state is not locked rpc UnlockUser(UnlockUserRequest) returns (UnlockUserResponse) { option (google.api.http) = { post: "/users/{id}/_unlock" @@ -271,9 +525,20 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Unlock user"; + description: "Unlock a user with the state 'locked'. The user will be able to log in again afterward. The endpoint returns an error if the user is not in the state 'locked'." + tags: "Users"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + }; } - // Changes the user state to deleted rpc RemoveUser(RemoveUserRequest) returns (RemoveUserResponse) { option (google.api.http) = { delete: "/users/{id}" @@ -282,9 +547,20 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.delete" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Delete user"; + description: "The state of the user will be changed to 'deleted'. The user will not be able to log in anymore. Endpoints requesting this user will return an error 'User not found" + tags: "Users"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + }; } - // Changes the username rpc UpdateUserName(UpdateUserNameRequest) returns (UpdateUserNameResponse) { option (google.api.http) = { put: "/users/{user_id}/username" @@ -294,9 +570,20 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Change user name"; + description: "Change the username of the user. Be aware that the user has to log in with the newly added username afterward." + tags: "Users"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + }; } - // Sets a user metadata by key rpc SetUserMetadata(SetUserMetadataRequest) returns (SetUserMetadataResponse) { option (google.api.http) = { post: "/users/{id}/metadata/{key}" @@ -306,9 +593,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Users"; + tags: "User Metadata"; + summary: "Set User Metadata"; + description: "This endpoint either adds or updates a metadata value for the requested key. Make sure the value is base64 encoded." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Set a list of user metadata rpc BulkSetUserMetadata(BulkSetUserMetadataRequest) returns (BulkSetUserMetadataResponse) { option (google.api.http) = { post: "/users/{id}/metadata/_bulk" @@ -318,9 +619,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Users"; + tags: "User Metadata"; + summary: "Bulk Set User Metadata"; + description: "Add or update multiple metadata values for a user. Make sure the values are base64 encoded." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Returns the user metadata rpc ListUserMetadata(ListUserMetadataRequest) returns (ListUserMetadataResponse) { option (google.api.http) = { post: "/users/{id}/metadata/_search" @@ -330,9 +645,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Users"; + tags: "User Metadata"; + summary: "Search User Metadata"; + description: "Get the metadata of a user filtered by your query." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Returns the user metadata by key rpc GetUserMetadata(GetUserMetadataRequest) returns (GetUserMetadataResponse) { option (google.api.http) = { get: "/users/{id}/metadata/{key}" @@ -341,9 +670,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Users"; + tags: "User Metadata"; + summary: "Get User Metadata By Key"; + description: "Get a metadata object from a user by a specific key." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Removes a user metadata by key rpc RemoveUserMetadata(RemoveUserMetadataRequest) returns (RemoveUserMetadataResponse) { option (google.api.http) = { delete: "/users/{id}/metadata/{key}" @@ -352,9 +695,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Users"; + tags: "User Metadata"; + summary: "Delete User Metadata By Key"; + description: "Remove a metadata object from a user with a specific key." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Set a list of user metadata rpc BulkRemoveUserMetadata(BulkRemoveUserMetadataRequest) returns (BulkRemoveUserMetadataResponse) { option (google.api.http) = { delete: "/users/{id}/metadata/_bulk" @@ -364,9 +721,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Users"; + tags: "User Metadata"; + summary: "Bulk Delete Metadata"; + description: "Remove a list of metadata objects from a user with a list of keys." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Returns the profile of the human rpc GetHumanProfile(GetHumanProfileRequest) returns (GetHumanProfileResponse) { option (google.api.http) = { get: "/users/{user_id}/profile" @@ -375,9 +746,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Get User Profile (Human)"; + description: "Get basic information like first_name and last_name of a user." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Changes the profile of the human rpc UpdateHumanProfile(UpdateHumanProfileRequest) returns (UpdateHumanProfileResponse) { option (google.api.http) = { put: "/users/{user_id}/profile" @@ -387,9 +778,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Update User Profile (Human)"; + description: "Update the profile information from a user. The profile includes basic information like first_name and last_name." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // GetHumanEmail returns the email and verified state of the human rpc GetHumanEmail(GetHumanEmailRequest) returns (GetHumanEmailResponse) { option (google.api.http) = { get: "/users/{user_id}/email" @@ -398,10 +809,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Get User Email (Human)"; + description: "Get the email address and the verification state of the address." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Changes the email of the human - // If state is not verified, the user will get a verification email rpc UpdateHumanEmail(UpdateHumanEmailRequest) returns (UpdateHumanEmailResponse) { option (google.api.http) = { put: "/users/{user_id}/email" @@ -411,10 +841,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Update User Email (Human)"; + description: "Change the email address of a user. If the state is set to not verified, the user will get a verification email." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Resends an email to the given email address to finish the initialization process of the user - // Changes the email address of the user if it is provided rpc ResendHumanInitialization(ResendHumanInitializationRequest) returns (ResendHumanInitializationResponse) { option (google.api.http) = { post: "/users/{user_id}/_resend_initialization" @@ -424,9 +873,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Resend User Initialization Email"; + description: "A newly created user will get an initialization email to verify the email address and set a password. Resend the email with this request to the user's email address, or a newly added address." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Resends an email to the given email address to finish the email verification process of the user rpc ResendHumanEmailVerification(ResendHumanEmailVerificationRequest) returns (ResendHumanEmailVerificationResponse) { option (google.api.http) = { post: "/users/{user_id}/email/_resend_verification" @@ -436,9 +905,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Resend User Email Verification"; + description: "Resend the email verification notification to the given email address of the user." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Returns the phone and verified state of the human phone rpc GetHumanPhone(GetHumanPhoneRequest) returns (GetHumanPhoneResponse) { option (google.api.http) = { get: "/users/{user_id}/phone" @@ -447,10 +936,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Get User Phone (Human)"; + description: "Get the phone number and the verification state of the number. The phone number is only for informational purposes and to send messages, not for Authentication (2FA)." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Changes the phone number - // If verified is not set, the user will get an sms to verify the number rpc UpdateHumanPhone(UpdateHumanPhoneRequest) returns (UpdateHumanPhoneResponse) { option (google.api.http) = { put: "/users/{user_id}/phone" @@ -460,9 +968,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Update User Phone (Human)"; + description: "Change the phone number of a user. If the state is set to not verified, the user will get an SMS to verify (if a notification provider is configured). The phone number is only for informational purposes and to send messages, not for Authentication (2FA)." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Removes the phone number of the human rpc RemoveHumanPhone(RemoveHumanPhoneRequest) returns (RemoveHumanPhoneResponse) { option (google.api.http) = { delete: "/users/{user_id}/phone" @@ -471,9 +999,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Remove User Phone (Human)"; + description: "Remove the configured phone number of a user." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // An sms will be sent to the given phone number to finish the phone verification process of the user rpc ResendHumanPhoneVerification(ResendHumanPhoneVerificationRequest) returns (ResendHumanPhoneVerificationResponse) { option (google.api.http) = { post: "/users/{user_id}/phone/_resend_verification" @@ -483,8 +1031,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Resend User Phone Verification"; + description: "Resend the notification for the verification of the phone number, to the number stored on the user." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Removes the avatar number of the human + rpc RemoveHumanAvatar(RemoveHumanAvatarRequest) returns (RemoveHumanAvatarResponse) { option (google.api.http) = { delete: "/users/{user_id}/avatar" @@ -493,6 +1062,27 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Delete User Avatar (Human)"; + description: "Removes the avatar that is currently set on the user." + tags: "Users"; + tags: "User Human" + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } // deprecated: use SetHumanPassword @@ -505,10 +1095,15 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Users"; + tags: "User Human"; + summary: "Set Human Initial Password"; + deprecated: true; + }; } - // Set a new password for a user, on default the user has to change the password on the next login - // Set no_change_required to true if the user does not have to change the password on the next login rpc SetHumanPassword(SetHumanPasswordRequest) returns (SetHumanPasswordResponse) { option (google.api.http) = { post: "/users/{user_id}/password" @@ -518,9 +1113,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Set User Password"; + description: "Set a new password for a user. Per default, the user has to change the password on the next login. You can set no_change_required to true, to avoid the change on the next login." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // An email will be sent to the given address to reset the password of the user rpc SendHumanResetPasswordNotification(SendHumanResetPasswordNotificationRequest) returns (SendHumanResetPasswordNotificationResponse) { option (google.api.http) = { post: "/users/{user_id}/password/_reset" @@ -530,9 +1145,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Send Reset Password Notification"; + description: "The user will receive an email with a link to change the password." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Returns a list of all factors (second and multi) which are configured on the user rpc ListHumanAuthFactors(ListHumanAuthFactorsRequest) returns (ListHumanAuthFactorsResponse) { option (google.api.http) = { post: "/users/{user_id}/auth_factors/_search" @@ -541,10 +1176,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Get User Authentication Factors (2FA/MFA)"; + description: "Get a list of authentication factors the user has set. Including Second-Factors (2FA) and Multi-Factors (MFA)." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // The otp second factor will be removed from the user - // Because only one otp can be configured per user, the configured one will be removed rpc RemoveHumanAuthFactorOTP(RemoveHumanAuthFactorOTPRequest) returns (RemoveHumanAuthFactorOTPResponse) { option (google.api.http) = { delete: "/users/{user_id}/auth_factors/otp" @@ -553,9 +1207,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Remove Multi-Factor OTP"; + description: "Remove the configured One-Time-Password (OTP) as a factor from the user. OTP is an authentication app, like Authy or Google/Microsoft Authenticator.." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // The u2f (universial second factor) will be removed from the user rpc RemoveHumanAuthFactorU2F(RemoveHumanAuthFactorU2FRequest) returns (RemoveHumanAuthFactorU2FResponse) { option (google.api.http) = { delete: "/users/{user_id}/auth_factors/u2f/{token_id}" @@ -564,9 +1238,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Remove Multi-Factor U2F"; + description: "Remove the configured Universal-Second-Factor (U2F) as a factor from the user. U2F is a device-dependent factor like FingerPrint, Windows-Hello, etc." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Returns all configured passwordless authenticators rpc ListHumanPasswordless(ListHumanPasswordlessRequest) returns (ListHumanPasswordlessResponse) { option (google.api.http) = { post: "/users/{user_id}/passwordless/_search" @@ -575,11 +1269,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Search Passwordless/Passkey authentication"; + description: "Get a list of configured passwordless/passkey authentication methods from the user. Passwordless/passkey is a device-dependent authentication like FingerScan, WindowsHello or a Hardware Token." + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Adds a new passwordless authenticator link to the user and returns it directly - // This link enables the user to register a new device if current passwordless devices are all platform authenticators - // e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone rpc AddPasswordlessRegistration(AddPasswordlessRegistrationRequest) returns (AddPasswordlessRegistrationResponse) { option (google.api.http) = { post: "/users/{user_id}/passwordless/_link" @@ -587,11 +1299,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.credential.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Add Passwordless/Passkey Registration Link"; + description: "Adds a new passwordless/passkey authenticator link to the user and returns it in the response. The link enables the user to register a new device if current passwordless/passkey devices are all platform authenticators. e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone" + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Adds a new passwordless authenticator link to the user and sends it to the registered email address - // This link enables the user to register a new device if current passwordless devices are all platform authenticators - // e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone rpc SendPasswordlessRegistration(SendPasswordlessRegistrationRequest) returns (SendPasswordlessRegistrationResponse) { option (google.api.http) = { post: "/users/{user_id}/passwordless/_send_link" @@ -600,9 +1330,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Send Passwordless/Passkey Registration Link"; + description: "Adds a new passwordless/passkey authenticator link to the user and sends it to the user per email. The link enables the user to register a new device if current passwordless/passkey devices are all platform authenticators. e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone" + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Removed a configured passwordless authenticator rpc RemoveHumanPasswordless(RemoveHumanPasswordlessRequest) returns (RemoveHumanPasswordlessResponse) { option (google.api.http) = { delete: "/users/{user_id}/passwordless/{token_id}" @@ -611,9 +1361,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Delete Passwordless/Passkey"; + description: "Remove a configured passwordless/passkey authentication method from the user. (e.g FaceID, FingerScane, WindowsHello, etc.)" + tags: "Users"; + tags: "User Human"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Changes a machine user rpc UpdateMachine(UpdateMachineRequest) returns (UpdateMachineResponse) { option (google.api.http) = { put: "/users/{user_id}/machine" @@ -623,9 +1393,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Update Machine User"; + description: "Change a service account/machine user. It is used for accounts with non-interactive authentication possibilities." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Generates and sets a new machine secret rpc GenerateMachineSecret(GenerateMachineSecretRequest) returns (GenerateMachineSecretResponse) { option (google.api.http) = { put: "/users/{user_id}/secret" @@ -635,9 +1425,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Create Secret for Machine User"; + description: "Create a new secret for a machine user/service account. It is used to authenticate the user (client credential grant)." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Removes the machine secret rpc RemoveMachineSecret(RemoveMachineSecretRequest) returns (RemoveMachineSecretResponse) { option (google.api.http) = { delete: "/users/{user_id}/secret" @@ -646,9 +1456,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Delete Secret of Machine User"; + description: "Delete a secret of a machine user/service account. The user will not be able to authenticate with the secret afterward." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Returns a machine key of a (machine) user rpc GetMachineKeyByIDs(GetMachineKeyByIDsRequest) returns (GetMachineKeyByIDsResponse) { option (google.api.http) = { get: "/users/{user_id}/keys/{key_id}" @@ -657,10 +1487,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Get Machine user Key By ID"; + description: "Get a specific Key of a machine user by its id. Machine keys are used to authenticate with jwt profile authentication." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Returns all machine keys of a (machine) user which match the query - // Limit should always be set, there is a default limit set by the service rpc ListMachineKeys(ListMachineKeysRequest) returns (ListMachineKeysResponse) { option (google.api.http) = { post: "/users/{user_id}/keys/_search" @@ -670,9 +1519,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Get Machine user Key By ID"; + description: "Get the list of keys of a machine user. Machine keys are used to authenticate with jwt profile authentication." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Generates a new machine key, details should be stored after return rpc AddMachineKey(AddMachineKeyRequest) returns (AddMachineKeyResponse) { option (google.api.http) = { post: "/users/{user_id}/keys" @@ -682,9 +1551,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Create Key for machine user"; + description: "A new key is generated and will be returned in the response. Make sure to store the returned key. Machine keys are used to authenticate with jwt profile." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Removes a machine key rpc RemoveMachineKey(RemoveMachineKeyRequest) returns (RemoveMachineKeyResponse) { option (google.api.http) = { delete: "/users/{user_id}/keys/{key_id}" @@ -693,9 +1582,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Create Key for machine user"; + description: "Delete a specific key from a user. The user will not be able to authenticate with that key afterward." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Returns a personal access token of a (machine) user rpc GetPersonalAccessTokenByIDs(GetPersonalAccessTokenByIDsRequest) returns (GetPersonalAccessTokenByIDsResponse) { option (google.api.http) = { get: "/users/{user_id}/pats/{token_id}" @@ -704,10 +1613,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Get a Personal-Access-Token (PAT) by ID"; + description: "Returns the PAT for a user, currently only available for machine users/service accounts. PATs are ready-to-use tokens and can be sent directly in the authentication header." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Returns all personal access tokens of a (machine) user which match the query - // Limit should always be set, there is a default limit set by the service rpc ListPersonalAccessTokens(ListPersonalAccessTokensRequest) returns (ListPersonalAccessTokensResponse) { option (google.api.http) = { post: "/users/{user_id}/pats/_search" @@ -717,9 +1645,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Get a Personal-Access-Token (PAT) by ID"; + description: "Returns a list of PATs for a user, currently only available for machine users/service accounts. PATs are ready-to-use tokens and can be sent directly in the authentication header." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Generates a new personal access token for a machine user, details should be stored after return rpc AddPersonalAccessToken(AddPersonalAccessTokenRequest) returns (AddPersonalAccessTokenResponse) { option (google.api.http) = { post: "/users/{user_id}/pats" @@ -729,9 +1677,29 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Create a Personal-Access-Token (PAT)"; + description: "Generates a new PAT for the user. Currently only available for machine users. The token will be returned in the response, make sure to store it. PATs are ready-to-use tokens and can be sent directly in the authentication header." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Removes a personal access token rpc RemovePersonalAccessToken(RemovePersonalAccessTokenRequest) returns (RemovePersonalAccessTokenResponse) { option (google.api.http) = { delete: "/users/{user_id}/pats/{token_id}" @@ -740,9 +1708,30 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "user.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Get a Personal-Access-Token (PAT) by ID"; + description: "Delete a PAT from a user. Afterward, the user will not be able to authenticate with that token anymore." + tags: "Users"; + tags: "User Machine"; + responses: { + key: "200" + value: { + description: "OK"; + } + }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; + }; } - // Lists all identity providers (social logins) which a human has configured (e.g Google, Microsoft, AD, etc..) + // Lists all identity providers (social logins) that a human has configured (e.g Google, Microsoft, AD, etc..) // Limit should always be set, there is a default limit set by the service rpc ListHumanLinkedIDPs(ListHumanLinkedIDPsRequest) returns (ListHumanLinkedIDPsResponse) { option (google.api.http) = { @@ -766,7 +1755,7 @@ service ManagementService { }; } - // Show all the permissions a user has iin ZITADEL (ZITADEL Manager) + // Show all the permissions a user has in ZITADEL (ZITADEL Manager) // Limit should always be set, there is a default limit set by the service rpc ListUserMemberships(ListUserMembershipsRequest) returns (ListUserMembershipsResponse) { option (google.api.http) = { @@ -779,7 +1768,6 @@ service ManagementService { }; } - // Returns the org given in the header rpc GetMyOrg(GetMyOrgRequest) returns (GetMyOrgResponse) { option (google.api.http) = { get: "/orgs/me" @@ -788,10 +1776,22 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + summary: "Get My Organization"; + description: "Returns the organization that is sent in the x-zitadel-orgid. If no header is set the organization of the authenticated user will be returned." + tags: "Organizations"; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Search a org over all organisations - // Domain must match exactly rpc GetOrgByDomainGlobal(GetOrgByDomainGlobalRequest) returns (GetOrgByDomainGlobalResponse) { option (google.api.http) = { get: "/global/orgs/_by_domain" @@ -800,10 +1800,14 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.global.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + summary: "Get Organization By Domain"; + description: "Search an organization by the domain, overall organizations. The domain must match exactly." + }; } - // Returns the history of my organisation (each event) - // Limit should always be set, there is a default limit set by the service rpc ListOrgChanges(ListOrgChangesRequest) returns (ListOrgChangesResponse) { option (google.api.http) = { post: "/orgs/me/changes/_search" @@ -813,9 +1817,22 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + summary: "Get Organization History"; + description: "Returns a list of changes/events that have happened in the organization. It's the history of the organization. Make sure to send a limit." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Creates a new organisation rpc AddOrg(AddOrgRequest) returns (AddOrgResponse) { option (google.api.http) = { post: "/orgs" @@ -825,9 +1842,22 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.create" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + summary: "Create Organization"; + description: "Create a new organization. Based on the given name a domain will be generated to be able to identify users within an organization." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Changes my organisation rpc UpdateOrg(UpdateOrgRequest) returns (UpdateOrgResponse) { option (google.api.http) = { put: "/orgs/me" @@ -837,10 +1867,22 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + summary: "Update Organization"; + description: "Change the name of the organization." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Sets the state of my organisation to deactivated - // Users of this organisation will not be able login rpc DeactivateOrg(DeactivateOrgRequest) returns (DeactivateOrgResponse) { option (google.api.http) = { post: "/orgs/me/_deactivate" @@ -850,9 +1892,22 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + summary: "Deactivate Organization"; + description: "Sets the state of my organization to deactivated. Users of this organization will not be able to log in." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Sets the state of my organisation to active rpc ReactivateOrg(ReactivateOrgRequest) returns (ReactivateOrgResponse) { option (google.api.http) = { post: "/orgs/me/_reactivate" @@ -862,10 +1917,22 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + summary: "Reactivate Organization"; + description: "Set the state of my organization to active. The state of the organization has to be deactivated to perform the request. Users of this organization will be able to log in again." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Sets the state of my organisation and all its resource (Users, Projects, Grants to and from the org) to removed - // Users of this organisation will not be able login rpc RemoveOrg(RemoveOrgRequest) returns (RemoveOrgResponse) { option (google.api.http) = { delete: "/orgs/me" @@ -874,9 +1941,22 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.delete" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + summary: "Delete Organization"; + description: "Sets the state of my organization and all its resource (Users, Projects, Grants to and from the org) to remove. Users of this organization will not be able to log in." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Sets a org metadata by key rpc SetOrgMetadata(SetOrgMetadataRequest) returns (SetOrgMetadataResponse) { option (google.api.http) = { post: "/metadata/{key}" @@ -886,9 +1966,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + tags: "Organization Metadata"; + summary: "Set Organization Metadata"; + description: "This endpoint either adds or updates a metadata value for the requested key. Make sure the value is base64 encoded." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Set a list of org metadata rpc BulkSetOrgMetadata(BulkSetOrgMetadataRequest) returns (BulkSetOrgMetadataResponse) { option (google.api.http) = { post: "/metadata/_bulk" @@ -898,9 +1992,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + tags: "Organization Metadata"; + summary: "Bulk Set Organization Metadata"; + description: "This endpoint sets a list of metadata to the organization. Make sure the values are base64 encoded." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Returns the org metadata rpc ListOrgMetadata(ListOrgMetadataRequest) returns (ListOrgMetadataResponse) { option (google.api.http) = { post: "/metadata/_search" @@ -910,9 +2018,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + tags: "Organization Metadata"; + summary: "Search Organization Metadata"; + description: "Get the metadata of an organization filtered by your query." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Returns the org metadata by key rpc GetOrgMetadata(GetOrgMetadataRequest) returns (GetOrgMetadataResponse) { option (google.api.http) = { get: "/metadata/{key}" @@ -921,9 +2043,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + tags: "Organization Metadata"; + summary: "Get Organization Metadata By Key"; + description: "Get a metadata object from an organization by a specific key." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Removes a org metadata by key rpc RemoveOrgMetadata(RemoveOrgMetadataRequest) returns (RemoveOrgMetadataResponse) { option (google.api.http) = { delete: "/metadata/{key}" @@ -932,9 +2068,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + tags: "Organization Metadata"; + summary: "Delete Organization Metadata By Key"; + description: "Remove a metadata object from an organization with a specific key." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Set a list of org metadata rpc BulkRemoveOrgMetadata(BulkRemoveOrgMetadataRequest) returns (BulkRemoveOrgMetadataResponse) { option (google.api.http) = { delete: "/metadata/_bulk" @@ -944,9 +2094,24 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "org.write" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Organizations"; + tags: "Organization Metadata"; + summary: "Bulk Delete Metadata"; + description: "Remove a list of metadata objects from an organization with a list of keys." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Returns all registered domains of my organisation + // Returns all registered domains of my organization // Limit should always be set, there is a default limit set by the service rpc ListOrgDomains(ListOrgDomainsRequest) returns (ListOrgDomainsResponse) { option (google.api.http) = { @@ -959,7 +2124,7 @@ service ManagementService { }; } - // Adds a new domain to my organisation + // Adds a new domain to my organization rpc AddOrgDomain(AddOrgDomainRequest) returns (AddOrgDomainResponse) { option (google.api.http) = { post: "/orgs/me/domains" @@ -971,7 +2136,7 @@ service ManagementService { }; } - // Removed the domain from my organisation + // Removed the domain from my organization rpc RemoveOrgDomain(RemoveOrgDomainRequest) returns (RemoveOrgDomainResponse) { option (google.api.http) = { delete: "/orgs/me/domains/{domain}" @@ -982,7 +2147,7 @@ service ManagementService { }; } - // Generates a new file to validate you domain + // Generates a new file to validate your domain rpc GenerateOrgDomainValidation(GenerateOrgDomainValidationRequest) returns (GenerateOrgDomainValidationResponse) { option (google.api.http) = { post: "/orgs/me/domains/{domain}/validation/_generate" @@ -994,7 +2159,7 @@ service ManagementService { }; } - // Validates your domain with the choosen method + // Validates your domain with the chosen method // Validated domains must be unique rpc ValidateOrgDomain(ValidateOrgDomainRequest) returns (ValidateOrgDomainResponse) { option (google.api.http) = { @@ -1007,8 +2172,8 @@ service ManagementService { }; } - // Sets the domain as primary - // Primary domain is shown as suffix on the preferred username on the users of the organisation + // Sets the domain as the primary + // Primary domain is shown as a suffix on the preferred username of the users of the organization rpc SetPrimaryOrgDomain(SetPrimaryOrgDomainRequest) returns (SetPrimaryOrgDomainResponse) { option (google.api.http) = { post: "/orgs/me/domains/{domain}/_set_primary" @@ -1019,7 +2184,7 @@ service ManagementService { }; } - // Returns all ZITADEL roles which are for organisation managers + // Returns all ZITADEL roles which are for organization managers rpc ListOrgMemberRoles(ListOrgMemberRolesRequest) returns (ListOrgMemberRolesResponse) { option (google.api.http) = { post: "/orgs/members/roles/_search" @@ -1030,7 +2195,7 @@ service ManagementService { }; } - // Returns all ZITADEL managers of this organisation (Project and Project Grant managers not included) + // Returns all ZITADEL managers of this organization (Project and Project Grant managers not included) // Limit should always be set, there is a default limit set by the service rpc ListOrgMembers(ListOrgMembersRequest) returns (ListOrgMembersResponse) { option (google.api.http) = { @@ -1043,7 +2208,7 @@ service ManagementService { }; } - // Adds a new organisation manager, which is allowed to administrate ZITADEL + // Adds a new organization manager, which is allowed to administrate ZITADEL rpc AddOrgMember(AddOrgMemberRequest) returns (AddOrgMemberResponse) { option (google.api.http) = { post: "/orgs/me/members" @@ -1055,7 +2220,7 @@ service ManagementService { }; } - // Changes the organisation manager + // Changes the organization manager rpc UpdateOrgMember(UpdateOrgMemberRequest) returns (UpdateOrgMemberResponse) { option (google.api.http) = { put: "/orgs/me/members/{user_id}" @@ -1067,7 +2232,7 @@ service ManagementService { }; } - // Removes an organisation manager + // Removes an organization manager rpc RemoveOrgMember(RemoveOrgMemberRequest) returns (RemoveOrgMemberResponse) { option (google.api.http) = { delete: "/orgs/me/members/{user_id}" @@ -1078,7 +2243,7 @@ service ManagementService { }; } - // Returns a project from my organisation (no granted projects) + // Returns a project from my organization (no granted projects) rpc GetProjectByID(GetProjectByIDRequest) returns (GetProjectByIDResponse) { option (google.api.http) = { get: "/projects/{id}" @@ -1090,7 +2255,7 @@ service ManagementService { }; } - // returns a project my organisation got granted from another organisation + // returns a project my organization got granted from another organization rpc GetGrantedProjectByID(GetGrantedProjectByIDRequest) returns (GetGrantedProjectByIDResponse) { option (google.api.http) = { get: "/granted_projects/{project_id}/grants/{grant_id}" @@ -1102,8 +2267,6 @@ service ManagementService { }; } - // Returns all projects my organisation is the owner (no granted projects) - // Limit should always be set, there is a default limit set by the service rpc ListProjects(ListProjectsRequest) returns (ListProjectsResponse) { option (google.api.http) = { post: "/projects/_search" @@ -1113,9 +2276,23 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "project.read" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Projects"; + summary: "Search Project"; + description: "Lists all projects my organization is the owner of (no granted projects). A Project is a vessel for different applications sharing the same role context." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // returns all projects my organisation got granted from another organisation + // returns all projects my organization got granted from another organization // Limit should always be set, there is a default limit set by the service rpc ListGrantedProjects(ListGrantedProjectsRequest) returns (ListGrantedProjectsResponse) { option (google.api.http) = { @@ -1154,7 +2331,6 @@ service ManagementService { }; } - // Adds an new project to the organisation rpc AddProject(AddProjectRequest) returns (AddProjectResponse) { option (google.api.http) = { post: "/projects" @@ -1164,9 +2340,22 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "project.create" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Projects"; + summary: "Create Project"; + description: "Create a new project. A Project is a vessel for different applications sharing the same role context." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Changes a project rpc UpdateProject(UpdateProjectRequest) returns (UpdateProjectResponse) { option (google.api.http) = { put: "/projects/{id}" @@ -1177,10 +2366,22 @@ service ManagementService { permission: "project.write" check_field_name: "Id" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Projects"; + summary: "Update Project"; + description: "Update a project and its settings. A Project is a vessel for different applications sharing the same role context." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Sets the state of a project to deactivated - // Returns an error if project is already deactivated rpc DeactivateProject(DeactivateProjectRequest) returns (DeactivateProjectResponse) { option (google.api.http) = { post: "/projects/{id}/_deactivate" @@ -1191,10 +2392,22 @@ service ManagementService { permission: "project.write" check_field_name: "Id" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Projects"; + summary: "Deactivate Project"; + description: "Set the state of a project to deactivated. Request returns an error if the project is already deactivated." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Sets the state of a project to active - // Returns an error if project is not deactivated rpc ReactivateProject(ReactivateProjectRequest) returns (ReactivateProjectResponse) { option (google.api.http) = { post: "/projects/{id}/_reactivate" @@ -1205,10 +2418,22 @@ service ManagementService { permission: "project.write" check_field_name: "Id" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Projects"; + summary: "Reactivate Project"; + description: "Set the state of a project to active. Request returns an error if the project is not deactivated." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Removes a project - // All project grants, applications and user grants for this project will be removed rpc RemoveProject(RemoveProjectRequest) returns (RemoveProjectResponse) { option (google.api.http) = { delete: "/projects/{id}" @@ -1218,10 +2443,22 @@ service ManagementService { permission: "project.delete" check_field_name: "Id" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Projects"; + summary: "Remove Project"; + description: "Project and all its sub-resources like project grants, applications, roles and user grants will be removed." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Returns all roles of a project matching the search query - // If no limit is requested, default limit will be set, if the limit is higher then the default an error will be returned rpc ListProjectRoles(ListProjectRolesRequest) returns (ListProjectRolesResponse) { option (google.api.http) = { post: "/projects/{project_id}/roles/_search" @@ -1232,9 +2469,22 @@ service ManagementService { permission: "project.role.read" check_field_name: "ProjectId" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Project Roles"; + summary: "Search Project Roles"; + description: "Returns all roles of a project matching the search query." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Adds a role to a project, key must be unique in the project rpc AddProjectRole(AddProjectRoleRequest) returns (AddProjectRoleResponse) { option (google.api.http) = { post: "/projects/{project_id}/roles" @@ -1245,9 +2495,22 @@ service ManagementService { permission: "project.role.write" check_field_name: "ProjectId" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Project Roles"; + summary: "Add Project Role"; + description: "Add a new project role to a project. The key must be unique within the project." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // add a list of project roles in one request rpc BulkAddProjectRoles(BulkAddProjectRolesRequest) returns (BulkAddProjectRolesResponse) { option (google.api.http) = { post: "/projects/{project_id}/roles/_bulk" @@ -1258,10 +2521,22 @@ service ManagementService { permission: "project.role.write" check_field_name: "ProjectId" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Project Roles"; + summary: "Bulk Add Project Role"; + description: "Add a list of roles to a project. The keys must be unique within the project." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Changes a project role, key is not editable - // If a key should change, remove the role and create a new rpc UpdateProjectRole(UpdateProjectRoleRequest) returns (UpdateProjectRoleResponse) { option (google.api.http) = { put: "/projects/{project_id}/roles/{role_key}" @@ -1272,9 +2547,22 @@ service ManagementService { permission: "project.role.write" check_field_name: "ProjectId" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Project Roles"; + summary: "Change Project Role"; + description: "Change a project role. The key is not editable. If a key should change, remove the role and create a new one." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Removes role from UserGrants, ProjectGrants and from Project rpc RemoveProjectRole(RemoveProjectRoleRequest) returns (RemoveProjectRoleResponse) { option (google.api.http) = { delete: "/projects/{project_id}/roles/{role_key}" @@ -1284,6 +2572,20 @@ service ManagementService { permission: "project.role.delete" check_field_name: "ProjectId" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Project Roles"; + summary: "Remove Project Role"; + description: "Removes the role from the project and on every resource it has a dependency. This includes project grants and user grants." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } // Returns all ZITADEL roles which are for project managers @@ -1349,7 +2651,7 @@ service ManagementService { }; } - // Returns an application (oidc or api) + // Returns an application (OIDC or API) rpc GetAppByID(GetAppByIDRequest) returns (GetAppByIDResponse) { option (google.api.http) = { get: "/projects/{project_id}/apps/{app_id}" @@ -1361,8 +2663,6 @@ service ManagementService { }; } - // Returns all applications of a project matching the query - // Limit should always be set, there is a default limit set by the service rpc ListApps(ListAppsRequest) returns (ListAppsResponse) { option (google.api.http) = { post: "/projects/{project_id}/apps/_search" @@ -1373,6 +2673,20 @@ service ManagementService { permission: "project.app.read" check_field_name: "ProjectId" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Applications"; + summary: "Search Applications"; + description: "Returns all applications within a project, that match the query." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } // Returns the history of the application (each event) @@ -1388,9 +2702,6 @@ service ManagementService { }; } - // Adds a new oidc client - // Returns a client id - // Returns a new generated secret if needed (Depending on the configuration) rpc AddOIDCApp(AddOIDCAppRequest) returns (AddOIDCAppResponse) { option (google.api.http) = { post: "/projects/{project_id}/apps/oidc" @@ -1401,10 +2712,24 @@ service ManagementService { permission: "project.app.write" check_field_name: "ProjectId" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Applications"; + summary: "Create Application (OIDC)"; + description: "Create a new OIDC client. A client id you can use will be generated and returned in the response. Depending on the chosen configuration also a secret will be returned." + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; + }; } - // Adds a new saml service provider - // Returns a entityID + // Adds a new SAML service provider + // Returns an entityID rpc AddSAMLApp(AddSAMLAppRequest) returns (AddSAMLAppResponse) { option (google.api.http) = { post: "/projects/{project_id}/apps/saml" @@ -1417,9 +2742,9 @@ service ManagementService { }; } - // Adds a new api application + // Adds a new API application // Returns a client id - // Returns a new generated secret if needed (Depending on the configuration) + // Returns a newly generated secret if needed (Depending on the configuration) rpc AddAPIApp(AddAPIAppRequest) returns (AddAPIAppResponse) { option (google.api.http) = { post: "/projects/{project_id}/apps/api" @@ -1445,7 +2770,7 @@ service ManagementService { }; } - // Changes the configuration of the oidc client + // Changes the configuration of the OIDC client rpc UpdateOIDCAppConfig(UpdateOIDCAppConfigRequest) returns (UpdateOIDCAppConfigResponse) { option (google.api.http) = { put: "/projects/{project_id}/apps/{app_id}/oidc_config" @@ -1458,7 +2783,7 @@ service ManagementService { }; } - // Changes the configuration of the saml application + // Changes the configuration of the SAML application rpc UpdateSAMLAppConfig(UpdateSAMLAppConfigRequest) returns (UpdateSAMLAppConfigResponse) { option (google.api.http) = { put: "/projects/{project_id}/apps/{app_id}/saml_config" @@ -1471,7 +2796,7 @@ service ManagementService { }; } - // Changes the configuration of the api application + // Changes the configuration of the API application rpc UpdateAPIAppConfig(UpdateAPIAppConfigRequest) returns (UpdateAPIAppConfigResponse) { option (google.api.http) = { put: "/projects/{project_id}/apps/{app_id}/api_config" @@ -1525,7 +2850,7 @@ service ManagementService { }; } - // Generates a new client secret for the oidc client, make sure to save the response + // Generates a new client secret for the OIDC client, make sure to save the response rpc RegenerateOIDCClientSecret(RegenerateOIDCClientSecretRequest) returns (RegenerateOIDCClientSecretResponse) { option (google.api.http) = { post: "/projects/{project_id}/apps/{app_id}/oidc_config/_generate_client_secret" @@ -1538,7 +2863,7 @@ service ManagementService { }; } - // Generates a new client secret for the api application, make sure to save the response + // Generates a new client secret for the API application, make sure to save the response rpc RegenerateAPIClientSecret(RegenerateAPIClientSecretRequest) returns (RegenerateAPIClientSecretResponse) { option (google.api.http) = { post: "/projects/{project_id}/apps/{app_id}/api_config/_generate_client_secret" @@ -1578,7 +2903,7 @@ service ManagementService { } // Creates a new app key - // Will return key details in result, make sure to save it + // Will return key details in the result, make sure to save it rpc AddAppKey(AddAppKeyRequest) returns (AddAppKeyResponse){ option (google.api.http) = { post: "/projects/{project_id}/apps/{app_id}/keys" @@ -1616,7 +2941,7 @@ service ManagementService { }; } - // Returns a project grant (ProjectGrant = Grant another organisation for my project) + // Returns a project grant (ProjectGrant = Grant another organization for my project) rpc GetProjectGrantByID(GetProjectGrantByIDRequest) returns (GetProjectGrantByIDResponse) { option (google.api.http) = { get: "/projects/{project_id}/grants/{grant_id}" @@ -1627,7 +2952,7 @@ service ManagementService { }; } - // Returns all project grants matching the query, (ProjectGrant = Grant another organisation for my project) + // Returns all project grants matching the query, (ProjectGrant = Grant another organization for my project) // Limit should always be set, there is a default limit set by the service rpc ListProjectGrants(ListProjectGrantsRequest) returns (ListProjectGrantsResponse) { option (google.api.http) = { @@ -1641,7 +2966,7 @@ service ManagementService { }; } - // Returns all project grants matching the query, (ProjectGrant = Grant another organisation for my project) + // Returns all project grants matching the query, (ProjectGrant = Grant another organization for my project) // Limit should always be set, there is a default limit set by the service rpc ListAllProjectGrants(ListAllProjectGrantsRequest) returns (ListAllProjectGrantsResponse) { option (google.api.http) = { @@ -1654,8 +2979,8 @@ service ManagementService { }; } - // Add a new project grant (ProjectGrant = Grant another organisation for my project) - // Project Grant will be listed in granted project of the other organisation + // Add a new project grant (ProjectGrant = Grant another organization for my project) + // Project Grant will be listed in the granted project of the other organization rpc AddProjectGrant(AddProjectGrantRequest) returns (AddProjectGrantResponse) { option (google.api.http) = { post: "/projects/{project_id}/grants" @@ -1667,8 +2992,8 @@ service ManagementService { }; } - // Change project grant (ProjectGrant = Grant another organisation for my project) - // Project Grant will be listed in granted project of the other organisation + // Change project grant (ProjectGrant = Grant another organization for my project) + // Project Grant will be listed in the granted project of the other organization rpc UpdateProjectGrant(UpdateProjectGrantRequest) returns (UpdateProjectGrantResponse) { option (google.api.http) = { put: "/projects/{project_id}/grants/{grant_id}" @@ -1680,7 +3005,7 @@ service ManagementService { }; } - // Set state of project grant to deactivated (ProjectGrant = Grant another organisation for my project) + // Set state of project grant to deactivated (ProjectGrant = Grant another organization for my project) // Returns error if project not active rpc DeactivateProjectGrant(DeactivateProjectGrantRequest) returns (DeactivateProjectGrantResponse) { option (google.api.http) = { @@ -1693,7 +3018,7 @@ service ManagementService { }; } - // Set state of project grant to active (ProjectGrant = Grant another organisation for my project) + // Set state of project grant to active (ProjectGrant = Grant another organization for my project) // Returns error if project not deactivated rpc ReactivateProjectGrant(ReactivateProjectGrantRequest) returns (ReactivateProjectGrantResponse) { option (google.api.http) = { @@ -1787,7 +3112,7 @@ service ManagementService { }; } - // Returns al user grant matching the query (authorizations of user for projects) + // Returns all user grants matching the query (authorizations of a user for the projects) // Limit should always be set, there is a default limit set by the service rpc ListUserGrants(ListUserGrantRequest) returns (ListUserGrantResponse) { option (google.api.http) = { @@ -1826,7 +3151,7 @@ service ManagementService { // Sets the state of a user grant to deactivated // User will not be able to use the granted project anymore - // Returns an error if user grant is already deactivated + // Returns an error if the user grant is already deactivated rpc DeactivateUserGrant(DeactivateUserGrantRequest) returns (DeactivateUserGrantResponse) { option (google.api.http) = { post: "/users/{user_id}/grants/{grant_id}/_deactivate" @@ -1839,7 +3164,7 @@ service ManagementService { } // Sets the state of a user grant to active - // Returns an error if user grant is not deactivated + // Returns an error if the user grant is not deactivated rpc ReactivateUserGrant(ReactivateUserGrantRequest) returns (ReactivateUserGrantResponse) { option (google.api.http) = { post: "/users/{user_id}/grants/{grant_id}/_reactivate" @@ -1875,7 +3200,7 @@ service ManagementService { } //deprecated: please use DomainPolicy instead - // Returns the domain policy (this policy is managed by the iam administrator) + // Returns the domain policy (this policy is managed by the IAM administrator) rpc GetOrgIAMPolicy(GetOrgIAMPolicyRequest) returns (GetOrgIAMPolicyResponse) { option (google.api.http) = { get: "/policies/orgiam" @@ -1884,9 +3209,15 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Policies"; + summary: "Get Organziation IAM Policy"; + description: "Use Get Domain Policy instead" + deprecated: true; + }; } - // Returns the domain policy (this policy is managed by the iam administrator) rpc GetDomainPolicy(GetDomainPolicyRequest) returns (GetDomainPolicyResponse) { option (google.api.http) = { get: "/policies/domain" @@ -1895,10 +3226,17 @@ service ManagementService { option (zitadel.v1.auth_option) = { permission: "authenticated" }; + + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { + tags: "Policies"; + summary: "Get Domain Policy"; + description: "Returns the domain policy (this policy is managed by the IAM administrator)"; + deprecated: true; + }; } - // Returns the login policy of the organisation - // With this policy the login gui can be configured + // Returns the login policy of the organization + // With this policy the login UI can be configured rpc GetLoginPolicy(GetLoginPolicyRequest) returns (GetLoginPolicyResponse) { option (google.api.http) = { get: "/policies/login" @@ -1920,8 +3258,8 @@ service ManagementService { }; } - // Add a custom login policy for the organisation - // With this policy the login gui can be configured + // Add a custom login policy for the organization + // With this policy the login UI can be configured rpc AddCustomLoginPolicy(AddCustomLoginPolicyRequest) returns (AddCustomLoginPolicyResponse) { option (google.api.http) = { post: "/policies/login" @@ -1933,8 +3271,8 @@ service ManagementService { }; } - // Change the custom login policy for the organisation - // With this policy the login gui can be configured + // Change the custom login policy for the organization + // With this policy the login UI can be configured rpc UpdateCustomLoginPolicy(UpdateCustomLoginPolicyRequest) returns (UpdateCustomLoginPolicyResponse) { option (google.api.http) = { put: "/policies/login" @@ -1946,7 +3284,7 @@ service ManagementService { }; } - // Removes the custom login policy of the organisation + // Removes the custom login policy of the organization // The default policy of the IAM will trigger after rpc ResetLoginPolicyToDefault(ResetLoginPolicyToDefaultRequest) returns (ResetLoginPolicyToDefaultResponse) { option (google.api.http) = { @@ -1958,7 +3296,7 @@ service ManagementService { }; } - // Lists all possible identity providers configured on the organisation + // Lists all possible identity providers configured on the organization // Limit should always be set, there is a default limit set by the service rpc ListLoginPolicyIDPs(ListLoginPolicyIDPsRequest) returns (ListLoginPolicyIDPsResponse) { option (google.api.http) = { @@ -2039,7 +3377,7 @@ service ManagementService { }; } - // Adds a new multi factor to the custom login policy + // Adds a new multi-factor to the custom login policy rpc AddMultiFactorToLoginPolicy(AddMultiFactorToLoginPolicyRequest) returns (AddMultiFactorToLoginPolicyResponse) { option (google.api.http) = { post: "/policies/login/multi_factors" @@ -2051,7 +3389,7 @@ service ManagementService { }; } - // Remove a multi factor from the custom login policy + // Remove a multi-factor from the custom login policy rpc RemoveMultiFactorFromLoginPolicy(RemoveMultiFactorFromLoginPolicyRequest) returns (RemoveMultiFactorFromLoginPolicyResponse) { option (google.api.http) = { delete: "/policies/login/multi_factors/{type}" @@ -2062,7 +3400,7 @@ service ManagementService { }; } - // Returns the password complexity policy of the organisation + // Returns the password complexity policy of the organization // With this policy the password strength can be configured rpc GetPasswordComplexityPolicy(GetPasswordComplexityPolicyRequest) returns (GetPasswordComplexityPolicyResponse) { option (google.api.http) = { @@ -2086,7 +3424,7 @@ service ManagementService { }; } - // Add a custom password complexity policy for the organisation + // Add a custom password complexity policy for the organization // With this policy the password strength can be configured rpc AddCustomPasswordComplexityPolicy(AddCustomPasswordComplexityPolicyRequest) returns (AddCustomPasswordComplexityPolicyResponse) { option (google.api.http) = { @@ -2099,7 +3437,7 @@ service ManagementService { }; } - // Update the custom password complexity policy for the organisation + // Update the custom password complexity policy for the organization // With this policy the password strength can be configured rpc UpdateCustomPasswordComplexityPolicy(UpdateCustomPasswordComplexityPolicyRequest) returns (UpdateCustomPasswordComplexityPolicyResponse) { option (google.api.http) = { @@ -2112,7 +3450,7 @@ service ManagementService { }; } - // Removes the custom password complexity policy of the organisation + // Removes the custom password complexity policy of the organization // The default policy of the IAM will trigger after rpc ResetPasswordComplexityPolicyToDefault(ResetPasswordComplexityPolicyToDefaultRequest) returns (ResetPasswordComplexityPolicyToDefaultResponse) { option (google.api.http) = { @@ -2233,8 +3571,8 @@ service ManagementService { }; } - // Returns the privacy policy of the organisation - // With this policy privacy relevant things can be configured (e.g. tos link) + // Returns the privacy policy of the organization + // With this policy privacy relevant things can be configured (e.g. TOS link) rpc GetPrivacyPolicy(GetPrivacyPolicyRequest) returns (GetPrivacyPolicyResponse) { option (google.api.http) = { get: "/policies/privacy" @@ -2246,7 +3584,7 @@ service ManagementService { } // Returns the default privacy policy of the IAM - // With this policy the privacy relevant things can be configured (e.g tos link) + // With this policy the privacy-relevant things can be configured (e.g TOS link) rpc GetDefaultPrivacyPolicy(GetDefaultPrivacyPolicyRequest) returns (GetDefaultPrivacyPolicyResponse) { option (google.api.http) = { get: "/policies/default/privacy" @@ -2257,8 +3595,8 @@ service ManagementService { }; } - // Add a custom privacy policy for the organisation - // With this policy privacy relevant things can be configured (e.g. tos link) + // Add a custom privacy policy for the organization + // With this policy privacy relevant things can be configured (e.g. TOS link) // Variable {{.Lang}} can be set to have different links based on the language rpc AddCustomPrivacyPolicy(AddCustomPrivacyPolicyRequest) returns (AddCustomPrivacyPolicyResponse) { option (google.api.http) = { @@ -2271,8 +3609,8 @@ service ManagementService { }; } - // Update the privacy policy for the organisation - // With this policy privacy relevant things can be configured (e.g. tos link) + // Update the privacy policy for the organization + // With this policy privacy relevant things can be configured (e.g. TOS link) // Variable {{.Lang}} can be set to have different links based on the language rpc UpdateCustomPrivacyPolicy(UpdateCustomPrivacyPolicyRequest) returns (UpdateCustomPrivacyPolicyResponse) { option (google.api.http) = { @@ -2285,7 +3623,7 @@ service ManagementService { }; } - // Removes the privacy policy of the organisation + // Removes the privacy policy of the organization // The default policy of the IAM will trigger after rpc ResetPrivacyPolicyToDefault(ResetPrivacyPolicyToDefaultRequest) returns (ResetPrivacyPolicyToDefaultResponse) { option (google.api.http) = { @@ -2297,7 +3635,7 @@ service ManagementService { }; } - // Returns the notification policy of the organisation + // Returns the notification policy of the organization // With this notification policy it can be configured how users should be notified rpc GetNotificationPolicy(GetNotificationPolicyRequest) returns (GetNotificationPolicyResponse) { option (google.api.http) = { @@ -2321,7 +3659,7 @@ service ManagementService { }; } - // Add a custom notification policy for the organisation + // Add a custom notification policy for the organization // With this notification privacy it can be configured how users should be notified rpc AddCustomNotificationPolicy(AddCustomNotificationPolicyRequest) returns (AddCustomNotificationPolicyResponse) { option (google.api.http) = { @@ -2334,7 +3672,7 @@ service ManagementService { }; } - // Update the notification policy for the organisation + // Update the notification policy for the organization // With this notification privacy it can be configured how users should be notified rpc UpdateCustomNotificationPolicy(UpdateCustomNotificationPolicyRequest) returns (UpdateCustomNotificationPolicyResponse) { option (google.api.http) = { @@ -2347,7 +3685,7 @@ service ManagementService { }; } - // Removes the notification policy of the organisation + // Removes the notification policy of the organization // The default policy of the IAM will trigger after rpc ResetNotificationPolicyToDefault(ResetNotificationPolicyToDefaultRequest) returns (ResetNotificationPolicyToDefaultResponse) { option (google.api.http) = { @@ -2359,8 +3697,8 @@ service ManagementService { }; } - // Returns the active label policy of the organisation - // With this policy the private labeling can be configured (colors, etc.) + // Returns the active label policy of the organization + // With this policy private labeling can be configured (colors, etc.) rpc GetLabelPolicy(GetLabelPolicyRequest) returns (GetLabelPolicyResponse) { option (google.api.http) = { get: "/policies/label" @@ -2371,8 +3709,8 @@ service ManagementService { }; } - // Returns the preview label policy of the organisation - // With this policy the private labeling can be configured (colors, etc.) + // Returns the preview label policy of the organization + // With this policy private labeling can be configured (colors, etc.) rpc GetPreviewLabelPolicy(GetPreviewLabelPolicyRequest) returns (GetPreviewLabelPolicyResponse) { option (google.api.http) = { get: "/policies/label/_preview" @@ -2384,7 +3722,7 @@ service ManagementService { } // Returns the default label policy of the IAM - // With this policy the private labeling can be configured (colors, etc.) + // With this policy private labeling can be configured (colors, etc.) rpc GetDefaultLabelPolicy(GetDefaultLabelPolicyRequest) returns (GetDefaultLabelPolicyResponse) { option (google.api.http) = { get: "/policies/default/label" @@ -2395,8 +3733,8 @@ service ManagementService { }; } - // Add a custom label policy for the organisation - // With this policy the private labeling can be configured (colors, etc.) + // Add a custom label policy for the organization + // With this policy private labeling can be configured (colors, etc.) rpc AddCustomLabelPolicy(AddCustomLabelPolicyRequest) returns (AddCustomLabelPolicyResponse) { option (google.api.http) = { post: "/policies/label" @@ -2408,8 +3746,8 @@ service ManagementService { }; } - // Changes the custom label policy for the organisation - // With this policy the private labeling can be configured (colors, etc.) + // Changes the custom label policy for the organization + // With this policy private labeling can be configured (colors, etc.) rpc UpdateCustomLabelPolicy(UpdateCustomLabelPolicyRequest) returns (UpdateCustomLabelPolicyResponse) { option (google.api.http) = { put: "/policies/label" @@ -2421,7 +3759,7 @@ service ManagementService { }; } - // Activates all changes of the label policy + // Activates all changes to the label policy rpc ActivateCustomLabelPolicy(ActivateCustomLabelPolicyRequest) returns (ActivateCustomLabelPolicyResponse) { option (google.api.http) = { post: "/policies/label/_activate" @@ -2489,7 +3827,7 @@ service ManagementService { }; } - // Removes the custom label policy of the organisation + // Removes the custom label policy of the organization // The default policy of the IAM will trigger after rpc ResetLabelPolicyToDefault(ResetLabelPolicyToDefaultRequest) returns (ResetLabelPolicyToDefaultResponse) { option (google.api.http) = { @@ -2523,7 +3861,7 @@ service ManagementService { }; } - // Sets the custom text for initial message + // Sets the custom text for the initial message // The Following Variables can be used: // {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} rpc SetCustomInitMessageText(SetCustomInitMessageTextRequest) returns (SetCustomInitMessageTextResponse) { @@ -2537,7 +3875,7 @@ service ManagementService { }; } - // Removes the custom init message text of the organisation + // Removes the custom init message text of the organization // The default text of the IAM will trigger after rpc ResetCustomInitMessageTextToDefault(ResetCustomInitMessageTextToDefaultRequest) returns (ResetCustomInitMessageTextToDefaultResponse) { option (google.api.http) = { @@ -2584,7 +3922,7 @@ service ManagementService { }; } - // Removes the custom password reset message text of the organisation + // Removes the custom password reset message text of the organization // The default text of the IAM will trigger after rpc ResetCustomPasswordResetMessageTextToDefault(ResetCustomPasswordResetMessageTextToDefaultRequest) returns (ResetCustomPasswordResetMessageTextToDefaultResponse) { option (google.api.http) = { @@ -2618,7 +3956,7 @@ service ManagementService { }; } - // Sets the custom text for verify email message + // Sets the custom text for verifying email messages // The Following Variables can be used: // {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} rpc SetCustomVerifyEmailMessageText(SetCustomVerifyEmailMessageTextRequest) returns (SetCustomVerifyEmailMessageTextResponse) { @@ -2632,7 +3970,7 @@ service ManagementService { }; } - // Removes the custom verify email message text of the organisation + // Removes the custom verify email message text of the organization // The default text of the IAM will trigger after rpc ResetCustomVerifyEmailMessageTextToDefault(ResetCustomVerifyEmailMessageTextToDefaultRequest) returns (ResetCustomVerifyEmailMessageTextToDefaultResponse) { option (google.api.http) = { @@ -2666,7 +4004,7 @@ service ManagementService { }; } - // Sets the default custom text for verify email message + // Sets the default custom text for verifying email messages // The Following Variables can be used: // {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} rpc SetCustomVerifyPhoneMessageText(SetCustomVerifyPhoneMessageTextRequest) returns (SetCustomVerifyPhoneMessageTextResponse) { @@ -2680,7 +4018,7 @@ service ManagementService { }; } - // Removes the custom verify phone text of the organisation + // Removes the custom verify phone text of the organization // The default text of the IAM will trigger after rpc ResetCustomVerifyPhoneMessageTextToDefault(ResetCustomVerifyPhoneMessageTextToDefaultRequest) returns (ResetCustomVerifyPhoneMessageTextToDefaultResponse) { option (google.api.http) = { @@ -2728,7 +4066,7 @@ service ManagementService { }; } - // Removes the custom domain claimed message text of the organisation + // Removes the custom domain claimed message text of the organization // The default text of the IAM will trigger after rpc ResetCustomDomainClaimedMessageTextToDefault(ResetCustomDomainClaimedMessageTextToDefaultRequest) returns (ResetCustomDomainClaimedMessageTextToDefaultResponse) { option (google.api.http) = { @@ -2776,7 +4114,7 @@ service ManagementService { }; } - // Removes the custom passwordless link message text of the organisation + // Removes the custom passwordless link message text of the organization // The default text of the IAM will trigger after rpc ResetCustomPasswordlessRegistrationMessageTextToDefault(ResetCustomPasswordlessRegistrationMessageTextToDefaultRequest) returns (ResetCustomPasswordlessRegistrationMessageTextToDefaultResponse) { option (google.api.http) = { @@ -2824,7 +4162,7 @@ service ManagementService { }; } - // Removes the custom password change message text of the organisation + // Removes the custom password change message text of the organization // The default text of the IAM will trigger after rpc ResetCustomPasswordChangeMessageTextToDefault(ResetCustomPasswordChangeMessageTextToDefaultRequest) returns (ResetCustomPasswordChangeMessageTextToDefaultResponse) { option (google.api.http) = { @@ -2858,8 +4196,8 @@ service ManagementService { }; } - //Sets the default custom text for login ui - //it impacts all organisations without customized login ui texts + //Sets the default custom text for login UI + //it impacts all organizations without customized login UI texts rpc SetCustomLoginText(SetCustomLoginTextsRequest) returns (SetCustomLoginTextsResponse) { option (google.api.http) = { put: "/text/login/{language}"; @@ -2871,7 +4209,7 @@ service ManagementService { }; } - // Removes the custom login text of the organisation + // Removes the custom login text of the organization // The default text of the IAM will trigger after rpc ResetCustomLoginTextToDefault(ResetCustomLoginTextsToDefaultRequest) returns (ResetCustomLoginTextsToDefaultResponse) { option (google.api.http) = { @@ -2883,7 +4221,7 @@ service ManagementService { }; } - // Returns a identity provider configuration of the organisation + // Returns a identity provider configuration of the organization rpc GetOrgIDPByID(GetOrgIDPByIDRequest) returns (GetOrgIDPByIDResponse) { option (google.api.http) = { get: "/idps/{id}" @@ -2894,7 +4232,7 @@ service ManagementService { }; } - // Returns all identity provider configuration in the organisation, which match the query + // Returns all identity provider configurations in the organization, which match the query // Limit should always be set, there is a default limit set by the service rpc ListOrgIDPs(ListOrgIDPsRequest) returns (ListOrgIDPsResponse) { option (google.api.http) = { @@ -2907,7 +4245,7 @@ service ManagementService { }; } - // Add a new identity provider configuration in the organisation + // Add a new identity provider configuration in the organization // Provider must be OIDC compliant rpc AddOrgOIDCIDP(AddOrgOIDCIDPRequest) returns (AddOrgOIDCIDPResponse) { option (google.api.http) = { @@ -2920,7 +4258,7 @@ service ManagementService { }; } - // Add a new jwt identity provider configuration in the organisation + // Add a new jwt identity provider configuration in the organization rpc AddOrgJWTIDP(AddOrgJWTIDPRequest) returns (AddOrgJWTIDPResponse) { option (google.api.http) = { post: "/idps/jwt" @@ -2971,7 +4309,7 @@ service ManagementService { }; } - // Change identity provider configuration of the organisation + // Change the identity provider configuration of the organization rpc UpdateOrgIDP(UpdateOrgIDPRequest) returns (UpdateOrgIDPResponse) { option (google.api.http) = { put: "/idps/{idp_id}" @@ -2983,7 +4321,7 @@ service ManagementService { }; } - // Change OIDC identity provider configuration of the organisation + // Change the OIDC identity provider configuration of the organization rpc UpdateOrgIDPOIDCConfig(UpdateOrgIDPOIDCConfigRequest) returns (UpdateOrgIDPOIDCConfigResponse) { option (google.api.http) = { put: "/idps/{idp_id}/oidc_config" @@ -2995,7 +4333,7 @@ service ManagementService { }; } - // Change JWT identity provider configuration of the organisation + // Change the JWT identity provider configuration of the organization rpc UpdateOrgIDPJWTConfig(UpdateOrgIDPJWTConfigRequest) returns (UpdateOrgIDPJWTConfigResponse) { option (google.api.http) = { put: "/idps/{idp_id}/jwt_config" @@ -3248,11 +4586,24 @@ message GetIAMResponse { message GetSupportedLanguagesRequest {} message GetSupportedLanguagesResponse { - repeated string languages = 1; + repeated string languages = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"en\", \"de\", \"it\"]" + } + ]; } message GetUserByIDRequest { - string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string id = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"69629012906488334\""; + description: "User ID of the user you like to get." + } + ]; } message GetUserByIDResponse { @@ -3260,7 +4611,14 @@ message GetUserByIDResponse { } message GetUserByLoginNameGlobalRequest{ - string login_name = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string login_name = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"minnie-mouse\""; + } + ]; } message GetUserByLoginNameGlobalResponse { @@ -3272,7 +4630,7 @@ message ListUsersRequest { zitadel.v1.ListQuery query = 1; // the field the result is sorted zitadel.user.v1.UserFieldName sorting_column = 2; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.user.v1.SearchQuery queries = 3; } @@ -3291,7 +4649,7 @@ message ListUserChangesRequest { message ListUserChangesResponse { reserved 1; reserved "details"; - // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) + // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary info) repeated zitadel.change.v1.Change result = 2; } @@ -3336,48 +4694,168 @@ message AddHumanUserResponse { zitadel.v1.ObjectDetails details = 2; } +// Describe my Import Human User Request message ImportHumanUserRequest { message Profile { - string first_name = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string last_name = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string nick_name = 3 [(validate.rules).string = {max_len: 200}]; - string display_name = 4 [(validate.rules).string = {max_len: 200}]; - string preferred_language = 5 [(validate.rules).string = {max_len: 10}]; - zitadel.user.v1.Gender gender = 6; + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { + json_schema: { + title: "Profile" + description: "Profile includes the basic information of a user, like first name, last name, etc." + } + }; + string first_name = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Minnie\""; + } + ]; + string last_name = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Mouse\""; + } + ]; + string nick_name = 3 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + max_length: 200; + example: "\"Mini\""; + } + ]; + string display_name = 4 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + max_length: 200; + example: "\"Minnie Mouse\""; + } + ]; + string preferred_language = 5 [ + (validate.rules).string = {max_len: 10}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + max_length: 10; + example: "\"en\""; + } + ]; + zitadel.user.v1.Gender gender = 6 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"GENDER_FEMALE\""; + }]; } message Email { - string email = 1 [(validate.rules).string.email = true]; + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { + json_schema: { + title: "Email" + } + }; + string email = 1 [ + (validate.rules).string.email = true, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"minnie@mouse.com\""; + description: "Object that contains the email address and a verified flag." + }]; bool is_email_verified = 2; } message Phone { - // has to be a global number - string phone = 1 [(validate.rules).string = {min_len: 1, max_len: 50, prefix: "+"}]; + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { + json_schema: { + title: "Phone" + description: "Object that contains the number and a verified flag" + } + }; + string phone = 1 [ + (validate.rules).string = {min_len: 1, max_len: 50, prefix: "+"}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)"; + min_length: 1; + max_length: 50; + example: "\"+41 71 000 00 00\""; + } + ]; bool is_phone_verified = 2; } message HashedPassword{ + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { + json_schema: { + title: "Hashed Password", + description: "Use this to import hashed passwords from another system." + } + }; string value = 1; string algorithm = 2; } message IDP { - // internal id of the IDP in ZITADEL - string config_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - // id of the user on the IDP - string external_user_id = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - // (display) name of the user on the IDP - string display_name = 3 [(validate.rules).string = {max_len: 200}]; + string config_id = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"idp-config-id\""; + min_length: 1, + max_length: 200, + description: "The internal ID of the identity provider configured in ZITADEL." + } + ]; + string external_user_id = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"idp-config-id\""; + description: "The id of the user in the external identity provider" + } + ]; + string display_name = 3 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + max_length: 200, + example: "\"minnie.mouse@gmail.com\""; + description: "A display name ZITADEL can show on the linked provider." + } + ]; } - string user_name = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string user_name = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"minnie-mouse\""; + } + ]; - Profile profile = 2 [(validate.rules).message.required = true]; - Email email = 3 [(validate.rules).message.required = true]; + Profile profile = 2 [ + (validate.rules).message.required = true, + (google.api.field_behavior) = REQUIRED + ]; + Email email = 3 [ + (validate.rules).message.required = true, + (google.api.field_behavior) = REQUIRED + ]; Phone phone = 4; string password = 5; HashedPassword hashed_password = 6; - bool password_change_required = 7; - bool request_passwordless_registration = 8; + bool password_change_required = 7 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "If this is set to true, the user has to change the password on the next login."; + example: "true"; + } + ]; + bool request_passwordless_registration = 8 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "If this is set to true, you will get a link for the passwordless/passkey registration in the response."; + example: "true"; + } + ]; string otp_code = 9; - repeated IDP idps = 10; + repeated IDP idps = 10 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + title: "Identity Provider"; + description: "To link your user directly with an external identity provider (Identity brokering)" + } + ]; } message ImportHumanUserResponse { @@ -3394,11 +4872,36 @@ message ImportHumanUserResponse { } message AddMachineUserRequest { - string user_name = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string user_name = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"robot\""; + } + ]; - string name = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string description = 3 [(validate.rules).string = {max_len: 500}]; - zitadel.user.v1.AccessTokenType access_token_type = 4 [(validate.rules).enum = {defined_only: true}]; + string name = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"My Machine Account\""; + } + ]; + string description = 3 [ + (validate.rules).string = {max_len: 500}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + max_length: 500; + example: "\"First machine account used for API XY.\""; + } + ]; + + zitadel.user.v1.AccessTokenType access_token_type = 4 [ + (validate.rules).enum = {defined_only: true} + ]; } message AddMachineUserResponse { @@ -3407,7 +4910,15 @@ message AddMachineUserResponse { } message DeactivateUserRequest { - string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string id = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"69629012906488334\""; + } + ]; } message DeactivateUserResponse { @@ -3415,7 +4926,15 @@ message DeactivateUserResponse { } message ReactivateUserRequest { - string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string id = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"69629012906488334\""; + } + ]; } message ReactivateUserResponse { @@ -3423,7 +4942,14 @@ message ReactivateUserResponse { } message LockUserRequest { - string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string id = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"69629012906488334\""; + }]; } message LockUserResponse { @@ -3431,7 +4957,15 @@ message LockUserResponse { } message UnlockUserRequest { - string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string id = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"69629012906488334\""; + } + ]; } message UnlockUserResponse { @@ -3439,7 +4973,14 @@ message UnlockUserResponse { } message RemoveUserRequest { - string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string id = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"69629012906488334\""; + }]; } message RemoveUserResponse { @@ -3447,8 +4988,22 @@ message RemoveUserResponse { } message UpdateUserNameRequest { - string user_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string user_name = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string user_id = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"69629012906488334\""; + }]; + string user_name = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"minnie-mouse-updated\""; + }]; } message UpdateUserNameResponse { @@ -3458,7 +5013,11 @@ message UpdateUserNameResponse { message ListUserMetadataRequest { string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; zitadel.v1.ListQuery query = 2; - repeated zitadel.metadata.v1.MetadataQuery queries = 3; + repeated zitadel.metadata.v1.MetadataQuery queries = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + title: "Medata Query" + description: "Metadata object-specific queries." + }]; } message ListUserMetadataResponse { @@ -3476,9 +5035,31 @@ message GetUserMetadataResponse { } message SetUserMetadataRequest { - string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string key = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - bytes value = 3 [(validate.rules).bytes = {min_len: 1, max_len: 500000}]; + string id = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"my-user-id\""; + min_length: 1, + max_length: 200; + } + ]; + string key = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"my-key\""; + min_length: 1, + max_length: 200; + } + ]; + bytes value = 3 [ + (validate.rules).bytes = {min_len: 1, max_len: 500000}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "The value has to be base64 encoded."; + example: "\"VGhpcyBpcyBteSB0ZXN0IHZhbHVl\""; + min_length: 1, + max_length: 500000; + } + ]; } message SetUserMetadataResponse { @@ -3492,7 +5073,13 @@ message BulkSetUserMetadataRequest { string key = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; bytes value = 2 [(validate.rules).bytes = {min_len: 1, max_len: 500000}]; } - repeated Metadata metadata = 2; + repeated Metadata metadata = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + title: "Medata (Key/Value)" + description: "The values have to be base64 encoded."; + example: "[{\"key\": \"test1\", \"value\": \"VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ==\"}, {\"key\": \"test2\", \"value\": \"VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU=\"}]" + } + ]; } message BulkSetUserMetadataResponse { @@ -3510,7 +5097,14 @@ message RemoveUserMetadataResponse { message BulkRemoveUserMetadataRequest { string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - repeated string keys = 2 [(validate.rules).repeated.items.string = {min_len: 1, max_len: 200}]; + repeated string keys = 2 [ + (validate.rules).repeated.items.string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "A list of keys that should be removed" + example: "[\"test1\", \"test2\"]" + } + ]; } message BulkRemoveUserMetadataResponse { @@ -3529,11 +5123,46 @@ message GetHumanProfileResponse { message UpdateHumanProfileRequest { string user_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string first_name = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string last_name = 3 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string nick_name = 4 [(validate.rules).string = {max_len: 200}]; - string display_name = 5 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string preferred_language = 6 [(validate.rules).string = {max_len: 10}]; + string first_name = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Gigi\""; + } + ]; + string last_name = 3 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Giraffe\""; + } + ]; + string nick_name = 4 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + max_length: 200; + example: "\"Gigi\""; + } + ]; + string display_name = 5 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Gigi\""; + } + ]; + string preferred_language = 6 [ + (validate.rules).string = {max_len: 10}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + max_length: 10; + example: "\"en\""; + } + ]; zitadel.user.v1.Gender gender = 7; } @@ -3553,7 +5182,12 @@ message GetHumanEmailResponse { message UpdateHumanEmailRequest { string user_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string email = 2 [(validate.rules).string.email = true]; + string email = 2 [ + (validate.rules).string.email = true, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"gigi@zitadel.com\""; + } + ]; bool is_email_verified = 3; } @@ -3563,7 +5197,13 @@ message UpdateHumanEmailResponse { message ResendHumanInitializationRequest { string user_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string email = 2 [(validate.rules).string = {ignore_empty: true, email: true}]; + string email = 2 [ + (validate.rules).string = {ignore_empty: true, email: true}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"updated-email@test.com\""; + description: "Send a new email address if the one set on the user is wrong or has a typo." + } + ]; } message ResendHumanInitializationResponse { @@ -3589,9 +5229,16 @@ message GetHumanPhoneResponse { message UpdateHumanPhoneRequest { string user_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - - - string phone = 2 [(validate.rules).string = {min_len: 1, max_len: 50, prefix: "+"}]; + string phone = 2 [ + (validate.rules).string = {min_len: 1, max_len: 50, prefix: "+"}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)"; + min_length: 1; + max_length: 50; + example: "\"+41 71 000 00 00\""; + } + ]; bool is_phone_verified = 3; } @@ -3634,7 +5281,15 @@ message SetHumanInitialPasswordResponse { message SetHumanPasswordRequest { string user_id = 1 [(validate.rules).string.min_len = 1]; - string password = 2 [(validate.rules).string = {min_len: 1, max_len: 72}]; + string password = 2 [ + (validate.rules).string = {min_len: 1, max_len: 72}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 72; + example: "\"MyNewPassword1234!\""; + } + ]; bool no_change_required = 3; } @@ -3766,7 +5421,13 @@ message ListMachineKeysResponse { message AddMachineKeyRequest { string user_id = 1 [(validate.rules).string.min_len = 1]; - zitadel.authn.v1.KeyType type = 2 [(validate.rules).enum = {defined_only: true, not_in: [0]}]; + zitadel.authn.v1.KeyType type = 2 [ + (validate.rules).enum = {defined_only: true, not_in: [0]}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"KEY_TYPE_JSON\""; + description: "The date the key will expire and no logins will be possible"; + } + ]; google.protobuf.Timestamp expiration_date = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"2519-04-01T08:45:00.000000Z\""; @@ -3861,7 +5522,7 @@ message ListUserMembershipsRequest { string user_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; //the field the result is sorted zitadel.v1.ListQuery query = 2; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.user.v1.MembershipQuery queries = 3; } @@ -3878,7 +5539,15 @@ message GetMyOrgResponse { } message GetOrgByDomainGlobalRequest { - string domain = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string domain = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200} , + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"zitadel.cloud\""; + } + ]; } message ListOrgChangesRequest { @@ -3889,7 +5558,7 @@ message ListOrgChangesRequest { message ListOrgChangesResponse { reserved 1; reserved "details"; - // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) + // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary info) repeated zitadel.change.v1.Change result = 2; } @@ -3898,16 +5567,36 @@ message GetOrgByDomainGlobalResponse { } message AddOrgRequest { - string name = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string name = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Customer A\""; + } + ]; } message AddOrgResponse { - string id = 1; + string id = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"69629026806489455\""; + } + ]; zitadel.v1.ObjectDetails details = 2; } message UpdateOrgRequest { - string name = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string name = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Customer 1\""; + } + ]; } message UpdateOrgResponse { @@ -3937,7 +5626,7 @@ message RemoveOrgResponse { message ListOrgDomainsRequest { //list limitations and ordering zitadel.v1.ListQuery query = 1; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.org.v1.DomainSearchQuery queries = 2; } @@ -3998,14 +5687,14 @@ message ListOrgMemberRolesResponse { message ListOrgMembersRequest { //list limitations and ordering zitadel.v1.ListQuery query = 1; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.member.v1.SearchQuery queries = 2; } message ListOrgMembersResponse { //list limitations and ordering zitadel.v1.ListDetails details = 1; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.member.v1.Member result = 2; } @@ -4036,7 +5725,11 @@ message RemoveOrgMemberResponse { message ListOrgMetadataRequest { zitadel.v1.ListQuery query = 1; - repeated zitadel.metadata.v1.MetadataQuery queries = 2; + repeated zitadel.metadata.v1.MetadataQuery queries = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + title: "Medata Query" + description: "Metadata object specific queries." + }]; } message ListOrgMetadataResponse { @@ -4053,8 +5746,23 @@ message GetOrgMetadataResponse { } message SetOrgMetadataRequest { - string key = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - bytes value = 2 [(validate.rules).bytes = {min_len: 1, max_len: 500000}]; + string key = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"key1\""; + min_length: 1, + max_length: 200; + } + ]; + bytes value = 2 [ + (validate.rules).bytes = {min_len: 1, max_len: 500000}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "The value has to be base64 encoded."; + example: "\"VGhpcyBpcyBteSB0ZXN0IHZhbHVl\""; + min_length: 1, + max_length: 500000; + } + ]; } message SetOrgMetadataResponse { @@ -4066,7 +5774,13 @@ message BulkSetOrgMetadataRequest { string key = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; bytes value = 2 [(validate.rules).bytes = {min_len: 1, max_len: 500000}]; } - repeated Metadata metadata = 1; + repeated Metadata metadata = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + title: "Medata (Key/Value)" + description: "The values have to be base64 encoded."; + example: "[{\"key\": \"test1\", \"value\": \"VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ==\"}, {\"key\": \"test2\", \"value\": \"VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU=\"}]" + } + ]; } message BulkSetOrgMetadataResponse { @@ -4109,7 +5823,7 @@ message GetGrantedProjectByIDResponse { message ListProjectsRequest { //list limitations and ordering zitadel.v1.ListQuery query = 1; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.project.v1.ProjectQuery queries = 2; } @@ -4121,7 +5835,7 @@ message ListProjectsResponse { message ListGrantedProjectsRequest { //list limitations and ordering zitadel.v1.ListQuery query = 1; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.project.v1.ProjectQuery queries = 2; } @@ -4139,30 +5853,86 @@ message ListProjectChangesRequest { message ListProjectChangesResponse { reserved 1; reserved "details"; - // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) + // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary info) repeated zitadel.change.v1.Change result = 2; } message AddProjectRequest { - string name = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - bool project_role_assertion = 2; - bool project_role_check = 3; - bool has_project_check = 4; - zitadel.project.v1.PrivateLabelingSetting private_labeling_setting = 5 [(validate.rules).enum = {defined_only: true}]; + string name = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"MyProject\""; + } + ]; + bool project_role_assertion = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "Enable this setting to have role information included in the user info endpoint. It is also dependent on your application settings to include it in tokens and other types."; + } + ]; + bool project_role_check = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "When enabled ZITADEL will check if a user has a role of this project assigned when login into an application of this project."; + } + ]; + bool has_project_check = 4 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "When enabled ZITADEL will check if the organization of the user, that is trying to log in, has a grant to this project."; + } + ]; + zitadel.project.v1.PrivateLabelingSetting private_labeling_setting = 5 [ + (validate.rules).enum = {defined_only: true}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "Define which private labeling/branding should trigger when getting to a login of this project."; + } + ]; } message AddProjectResponse { - string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; + string id = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"98729028932384528\""; + } + ]; zitadel.v1.ObjectDetails details = 2; } message UpdateProjectRequest { - string id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string name = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - bool project_role_assertion = 3; - bool project_role_check = 4; - bool has_project_check = 5; - zitadel.project.v1.PrivateLabelingSetting private_labeling_setting = 6 [(validate.rules).enum = {defined_only: true}]; + string id = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200} + ]; + string name = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"MyProject-Updated\""; + } + ]; + bool project_role_assertion = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "Enable this setting to have role information included in the user info endpoint. It is also dependent on your application settings to include it in tokens and other types."; + } + ]; + bool project_role_check = 4 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "When enabled ZITADEL will check if a user has a role of this project assigned when login into an application of this project."; + } + ]; + bool has_project_check = 5 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "When enabled ZITADEL will check if the organization of the user, that is trying to log in, has a grant to this project."; + } + ]; + zitadel.project.v1.PrivateLabelingSetting private_labeling_setting = 6 [ + (validate.rules).enum = {defined_only: true}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "Define which private labeling/branding should trigger when getting to a login of this project."; + } + ]; } message UpdateProjectResponse { @@ -4202,10 +5972,36 @@ message ListProjectMemberRolesResponse { } message AddProjectRoleRequest { - string project_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string role_key = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string display_name = 3 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string group = 4 [(validate.rules).string = {max_len: 200}]; + string project_id = 1 [ + (validate.rules).string = {min_len: 1, max_len: 200} + ]; + string role_key = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"ADMIN\""; + description: "The key is the only relevant attribute for ZITADEL regarding the authorization checks." + } + ]; + string display_name = 3 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Administrator\""; + } + ]; + string group = 4 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + max_length: 200; + example: "\"Admins\""; + description: "The group is only used for display purposes. That you have better handling, like giving all the roles from a group to a user."; + } + ]; } message AddProjectRoleResponse { @@ -4220,7 +6016,12 @@ message BulkAddProjectRolesRequest { } string project_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - repeated Role roles = 2; + repeated Role roles = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + title: "Roles" + example: "[{\"key\": \"ADMIN\", \"display_name\": \"Administrator\"}, {\"key\": \"SUPPORT\", \"display_name\": \"Supporter\"}]" + } + ];; } message BulkAddProjectRolesResponse { @@ -4229,9 +6030,33 @@ message BulkAddProjectRolesResponse { message UpdateProjectRoleRequest { string project_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string role_key = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string display_name = 3 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string group = 4 [(validate.rules).string = {max_len: 200}]; + string role_key = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"ADMIN\""; + description: "The key is the only relevant attribute for ZITADEL regarding the authorization checks." + } + ]; + string display_name = 3 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"Administrator\""; + } + ]; + string group = 4 [ + (validate.rules).string = {max_len: 200}, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + max_length: 200; + example: "\"Admins\""; + description: "The group is only used for display purposes. That you have better handling, like giving all the roles from a group to a user."; + } + ]; } message UpdateProjectRoleResponse { @@ -4251,7 +6076,7 @@ message ListProjectRolesRequest { string project_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; //list limitations and ordering zitadel.v1.ListQuery query = 2; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.project.v1.RoleQuery queries = 3; } @@ -4265,7 +6090,7 @@ message ListGrantedProjectRolesRequest { string grant_id = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; //list limitations and ordering zitadel.v1.ListQuery query = 3; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.project.v1.RoleQuery queries = 4; } @@ -4278,7 +6103,7 @@ message ListProjectMembersRequest { string project_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; //list limitations and ordering zitadel.v1.ListQuery query = 2; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.member.v1.SearchQuery queries = 3; } @@ -4329,7 +6154,7 @@ message ListAppsRequest { string project_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; //list limitations and ordering zitadel.v1.ListQuery query = 2; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.app.v1.AppQuery queries = 3; } @@ -4348,19 +6173,35 @@ message ListAppChangesRequest { message ListAppChangesResponse { reserved 1; reserved "details"; - // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) + // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary info) repeated zitadel.change.v1.Change result = 2; } message AddOIDCAppRequest { string project_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; - string name = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; - repeated string redirect_uris = 3; + string name = 2 [ + (validate.rules).string = {min_len: 1, max_len: 200}, + (google.api.field_behavior) = REQUIRED, + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + min_length: 1; + max_length: 200; + example: "\"MyOIDCApp\""; + } + ]; + repeated string redirect_uris = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"http://localhost:4200/auth/callback\"]"; + } + ]; repeated zitadel.app.v1.OIDCResponseType response_types = 4; repeated zitadel.app.v1.OIDCGrantType grant_types = 5; zitadel.app.v1.OIDCAppType app_type = 6 [(validate.rules).enum = {defined_only: true}]; zitadel.app.v1.OIDCAuthMethodType auth_method_type = 7 [(validate.rules).enum = {defined_only: true}]; - repeated string post_logout_redirect_uris = 8; + repeated string post_logout_redirect_uris = 8 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "[\"http://localhost:4200/signedout\"]"; + } + ]; zitadel.app.v1.OIDCVersion version = 9 [(validate.rules).enum = {defined_only: true}]; bool dev_mode = 10; zitadel.app.v1.OIDCTokenType access_token_type = 11 [(validate.rules).enum = {defined_only: true}]; @@ -4597,7 +6438,7 @@ message ListProjectGrantChangesRequest { message ListProjectGrantChangesResponse { reserved 1; reserved "details"; - // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary infos) + // zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary info) repeated zitadel.change.v1.Change result = 2; } @@ -4614,7 +6455,7 @@ message ListProjectGrantsRequest { string project_id = 1 [(validate.rules).string = {min_len: 1, max_len: 200}]; //list limitations and ordering zitadel.v1.ListQuery query = 2; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.project.v1.ProjectGrantQuery queries = 3; } @@ -4626,7 +6467,7 @@ message ListProjectGrantsResponse { message ListAllProjectGrantsRequest { //list limitations and ordering zitadel.v1.ListQuery query = 1; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.project.v1.AllProjectGrantQuery queries = 2; } @@ -4696,7 +6537,7 @@ message ListProjectGrantMembersRequest { string grant_id = 2 [(validate.rules).string = {min_len: 1, max_len: 200}]; //list limitations and ordering zitadel.v1.ListQuery query = 3; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.member.v1.SearchQuery queries = 4; } @@ -4749,7 +6590,7 @@ message GetUserGrantByIDResponse { message ListUserGrantRequest { //list limitations and ordering zitadel.v1.ListQuery query = 1; - //criterias the client is looking for + //criteria the client is looking for repeated zitadel.user.v1.UserGrantQuery queries = 2; } @@ -4853,7 +6694,7 @@ message AddCustomLoginPolicyRequest { bool hide_password_reset = 6; bool ignore_unknown_usernames = 7 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if unknown username on login screen directly return an error or always display the password screen" + description: "defines if unknown username on login screen directly returns an error or always displays the password screen" } ]; string default_redirect_uri = 8 [ @@ -4869,20 +6710,20 @@ message AddCustomLoginPolicyRequest { repeated zitadel.policy.v1.SecondFactorType second_factors = 14; repeated zitadel.policy.v1.MultiFactorType multi_factors = 15; repeated IDP idps = 16; - // If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success. + // If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success. bool allow_domain_discovery = 17 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success." + description: "If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success." } ]; bool disable_login_with_email = 18 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if user can additionally (to the loginname) be identified by their verified email address" + description: "defines if the user can additionally (to the login name) be identified by their verified email address" } ]; bool disable_login_with_phone = 19 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if user can additionally (to the loginname) be identified by their verified phone number" + description: "defines if the user can additionally (to the login name) be identified by their verified phone number" } ]; } @@ -4900,7 +6741,7 @@ message UpdateCustomLoginPolicyRequest { bool hide_password_reset = 6; bool ignore_unknown_usernames = 7 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if unknown username on login screen directly return an error or always display the password screen" + description: "defines if unknown username on login screen directly returns an error or always displays the password screen" } ]; string default_redirect_uri = 8 [ @@ -4913,20 +6754,20 @@ message UpdateCustomLoginPolicyRequest { google.protobuf.Duration mfa_init_skip_lifetime = 11; google.protobuf.Duration second_factor_check_lifetime = 12; google.protobuf.Duration multi_factor_check_lifetime = 13; - // If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success. + // If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success. bool allow_domain_discovery = 14 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success." + description: "If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success." } ]; bool disable_login_with_email = 15 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if user can additionally (to the loginname) be identified by their verified email address" + description: "defines if the user can additionally (to the login name) be identified by their verified email address" } ]; bool disable_login_with_phone = 16 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if user can additionally (to the loginname) be identified by their verified phone number" + description: "defines if the user can additionally (to the login name) be identified by their verified phone number" } ]; } @@ -5726,7 +7567,7 @@ message ListOrgIDPsRequest { zitadel.v1.ListQuery query = 1; //the field the result is sorted zitadel.idp.v1.IDPFieldName sorting_column = 2; - //criterias the client is looking for + //criteria the client is looking for repeated IDPQuery queries = 3; } @@ -5776,7 +7617,7 @@ message AddOrgOIDCIDPRequest { (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com\""; - description: "the oidc issuer of the identity provider"; + description: "the OIDC issuer of the identity provider"; } ]; repeated string scopes = 6 [ @@ -5822,7 +7663,7 @@ message AddOrgJWTIDPRequest { (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com\""; - description: "the endpoint where the jwt can be extracted"; + description: "the endpoint where the JWT can be extracted"; min_length: 1; max_length: 200; } @@ -5831,7 +7672,7 @@ message AddOrgJWTIDPRequest { (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com\""; - description: "the issuer of the jwt (for validation)"; + description: "the issuer of the JWT (for validation)"; min_length: 1; max_length: 200; } @@ -5840,7 +7681,7 @@ message AddOrgJWTIDPRequest { (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com/keys\""; - description: "the endpoint to the key (JWK) which are used to sign the JWT with"; + description: "the endpoint to the key (JWK) which is used to sign the JWT with"; min_length: 1; max_length: 200; } @@ -5929,7 +7770,7 @@ message UpdateOrgIDPOIDCConfigRequest { (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com\""; - description: "the oidc issuer of the identity provider"; + description: "the OIDC issuer of the identity provider"; } ]; repeated string scopes = 5 [ @@ -5968,7 +7809,7 @@ message UpdateOrgIDPJWTConfigRequest { (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com\""; - description: "the endpoint where the jwt can be extracted"; + description: "the endpoint where the JWT can be extracted"; min_length: 1; max_length: 200; } @@ -5977,7 +7818,7 @@ message UpdateOrgIDPJWTConfigRequest { (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com\""; - description: "the issuer of the jwt (for validation)"; + description: "the issuer of the JWT (for validation)"; min_length: 1; max_length: 200; } @@ -5986,7 +7827,7 @@ message UpdateOrgIDPJWTConfigRequest { (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"https://accounts.google.com/keys\""; - description: "the endpoint to the key (JWK) which are used to sign the JWT with"; + description: "the endpoint to the key (JWK) which is used to sign the JWT with"; min_length: 1; max_length: 200; } @@ -6263,9 +8104,19 @@ message ClearFlowResponse { message SetTriggerActionsRequest { // id of the flow type - string flow_type = 1; + string flow_type = 1 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"1\""; + description: "At the moment you have to send the ID of the Flow Type: ExternalAuthentication=1, CustomiseToken=2, InternalAuthentication=3, PreUserinfoCreation=3"; + } + ]; // id of the trigger type - string trigger_type = 2; + string trigger_type = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"1\""; + description: "At the moment you have to send the ID of the Trigger Type: PostAuthentication=1, PreCreation=2, PostCreation=3, PreUserinfoCreation=4, PreAccessTokenCreation=5"; + } + ]; repeated string action_ids = 3; } diff --git a/proto/zitadel/member.proto b/proto/zitadel/member.proto index 65dc52cb2..3831c7052 100644 --- a/proto/zitadel/member.proto +++ b/proto/zitadel/member.proto @@ -17,7 +17,7 @@ message Member { zitadel.v1.ObjectDetails details = 2; repeated string roles = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "[\"role.super.man\"]"; + example: "[\"IAM_OWNER\"]"; description: "the role keys granted to the user" } ]; @@ -36,7 +36,7 @@ message Member { string first_name = 6 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"Gigi\""; - description: "first name of the user" + description: "the first name of the user" } ]; string last_name = 7 [ @@ -53,7 +53,7 @@ message Member { ]; string avatar_url = 9 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "avatar url of the user" + description: "avatar URL of the user" example: "\"https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32\""; } ]; diff --git a/proto/zitadel/metadata.proto b/proto/zitadel/metadata.proto index 9139c3aad..7a0409c94 100644 --- a/proto/zitadel/metadata.proto +++ b/proto/zitadel/metadata.proto @@ -12,12 +12,14 @@ message Metadata { zitadel.v1.ObjectDetails details = 1; string key = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "metadata key" + description: "metadata key", + example: "\"key1\""; } ]; bytes value = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "metadata value" + description: "metadata value is base64 encoded, make sure to decode to get the value", + example: "\"VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ==\""; } ]; } diff --git a/proto/zitadel/object.proto b/proto/zitadel/object.proto index aa1580a00..a4d35da40 100644 --- a/proto/zitadel/object.proto +++ b/proto/zitadel/object.proto @@ -8,7 +8,7 @@ package zitadel.v1; option go_package ="github.com/zitadel/zitadel/pkg/grpc/object"; message ObjectDetails { - //sequence represents the order of events. It's always upcounting + //sequence represents the order of events. It's always counting // // on read: the sequence of the last event reduced by the projection // @@ -30,7 +30,7 @@ message ObjectDetails { // // on manipulation: the google.protobuf.Timestamp change_date = 3; - //resource_owner is the organisation an object belongs to + //resource_owner is the organization an object belongs to string resource_owner = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"69629023906488334\""; @@ -39,6 +39,12 @@ message ObjectDetails { } message ListQuery { + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { + json_schema: { + title: "General List Query" + description: "Object unspecific list filters like offset, limit and asc/desc." + } + }; uint64 offset = 1 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"10\""; @@ -47,7 +53,7 @@ message ListQuery { uint32 limit = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "20"; - description: "Maximum amount of events returned. Default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If limit exeeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken."; + description: "Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken."; } ]; bool asc = 3 [ diff --git a/proto/zitadel/org.proto b/proto/zitadel/org.proto index d65b58609..90a6af45d 100644 --- a/proto/zitadel/org.proto +++ b/proto/zitadel/org.proto @@ -17,17 +17,17 @@ message Org { zitadel.v1.ObjectDetails details = 2; OrgState state = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "current state of the organisation"; + description: "current state of the organization"; } ]; string name = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"CAOS AG\""; + example: "\"ZITADEL\""; } ]; string primary_domain = 5 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"caos.ch\""; + example: "\"zitadel.cloud\""; } ]; } @@ -48,7 +48,7 @@ message Domain { zitadel.v1.ObjectDetails details = 2; string domain_name = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"caos.ch\""; + example: "\"zitadel.com\""; } ]; bool is_verified = 4 [ @@ -88,7 +88,7 @@ message OrgNameQuery { string name = 1 [ (validate.rules).string = {max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"caos ag\""; + example: "\"ZITADEL\""; } ]; zitadel.v1.TextQueryMethod method = 2 [ @@ -103,7 +103,7 @@ message OrgDomainQuery { string domain = 1 [ (validate.rules).string = {max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"CAOS.C\""; + example: "\"citadel.cloud\""; } ]; zitadel.v1.TextQueryMethod method = 2 [ @@ -118,7 +118,7 @@ message OrgStateQuery { OrgState state = 1 [ (validate.rules).enum.defined_only = true, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "current state of the organisation"; + description: "current state of the organization"; } ]; } @@ -140,7 +140,7 @@ message DomainNameQuery { string name = 1 [ (validate.rules).string = {max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"caos.ch\""; + example: "\"zitadel.cloud\""; } ]; zitadel.v1.TextQueryMethod method = 2 [ diff --git a/proto/zitadel/policy.proto b/proto/zitadel/policy.proto index c85308aea..7a689606d 100644 --- a/proto/zitadel/policy.proto +++ b/proto/zitadel/policy.proto @@ -14,12 +14,12 @@ message OrgIAMPolicy { zitadel.v1.ObjectDetails details = 1; bool user_login_must_be_domain = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "the username has to end with the domain of it's organisation" + description: "the username has to end with the domain of its organization" } ]; bool is_default = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the organisation's admin changed the policy" + description: "defines if the organization's admin changed the policy" } ]; } @@ -28,22 +28,22 @@ message DomainPolicy { zitadel.v1.ObjectDetails details = 1; bool user_login_must_be_domain = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "the username has to end with the domain of it's organisation" + description: "the username has to end with the domain of its organization" } ]; bool is_default = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the organisation's admin changed the policy" + description: "defines if the organization's admin changed the policy" } ]; bool validate_org_domains = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if organisation domains should be validated org count as validated automatically" + description: "defines if organization domains should be validated org count as validated automatically" } ]; bool smtp_sender_address_matches_instance_domain = 5 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the smtp sender address domain should match an existing domain on the instance" + description: "defines if the SMTP sender address domain should match an existing domain on the instance" } ]; } @@ -53,13 +53,14 @@ message LabelPolicy { // hex value for primary color string primary_color = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "hex value for primary color" + description: "hex value for primary color"; + example: "\"#5469d4\""; } ]; - // defines if the organisation's admin changed the policy + // defines if the organization's admin changed the policy bool is_default = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the organisation's admin changed the policy" + description: "defines if the organization's admin changed the policy" } ]; // hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set @@ -71,50 +72,77 @@ message LabelPolicy { // hex value for secondary color string warn_color = 6 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "hex value for warn color" + description: "hex value for warn color"; + example: "\"#CD3D56\""; } ]; // hex value for background color string background_color = 7 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "hex value for background color" + description: "hex value for background color"; + example: "\"#FAFAFA\""; } ]; // hex value for font color string font_color = 8 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "hex value for font color" + description: "hex value for font color"; + example: "\"#000000\""; } ]; // hex value for primary color dark theme string primary_color_dark = 9 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "hex value for primary color dark theme" + description: "hex value for the primary color dark theme"; + example: "\"#BBBAFA\""; } ]; // hex value for background color dark theme string background_color_dark = 10 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "hex value for background color dark theme" + description: "hex value for background color dark theme"; + example: "\"#111827\""; } ]; - // hex value for warn color dark theme + // hex value for warning color dark theme string warn_color_dark = 11 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "hex value for warn color dark theme" + description: "hex value for warning color dark theme"; + example: "\"#FF3B5B\""; } ]; // hex value for font color dark theme string font_color_dark = 12 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "hex value for font color dark theme" + description: "hex value for font color dark theme"; + example: "\"#FFFFFF\""; } ]; bool disable_watermark = 13; - string logo_url = 14; - string icon_url = 15; - string logo_url_dark = 16; - string icon_url_dark = 17; + string logo_url = 14 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "hex value for font color dark theme"; + example: "\"https://acme.com/assets/v1/165617850692654601/policy/label/logo-180950416321494657\""; + } + ]; + string icon_url = 15 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "hex value for font color dark theme"; + example: "\"https://acme.com/assets/v1/165617850692654601/policy/label/icon-180950498874178817\""; + } + ]; + string logo_url_dark = 16 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "hex value for font color dark theme"; + example: "\"https://acme.com/assets/v1/165617850692654601/policy/label/logo-dark-180950229376461345\""; + } + ]; + string icon_url_dark = 17 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + description: "hex value for font color dark theme"; + example: "\"https://acme.com/assets/v1/165617850692654601/policy/label/icon-dark-180950243237405441\""; + } + ]; string font_url = 18; } @@ -122,12 +150,12 @@ message LoginPolicy { zitadel.v1.ObjectDetails details = 1; bool allow_username_password = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if a user is allowed to login with his username and password" + description: "defines if a user is allowed to log in with his username and password" } ]; bool allow_register = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if a person is allowed to register a user on this organisation" + description: "defines if a person is allowed to register a user on this organization" } ]; bool allow_external_idp = 4 [ @@ -137,7 +165,7 @@ message LoginPolicy { ]; bool force_mfa = 5 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if a user MUST use a multi factor to log in" + description: "defines if a user MUST use a multi-factor to log in" } ]; PasswordlessType passwordless_type = 6 [ @@ -147,7 +175,7 @@ message LoginPolicy { ]; bool is_default = 7 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the organisation's admin changed the policy" + description: "defines if the organization's admin changed the policy" } ]; bool hide_password_reset = 8 [ @@ -157,36 +185,57 @@ message LoginPolicy { ]; bool ignore_unknown_usernames = 9 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if unknown username on login screen directly return an error or always display the password screen" + description: "defines if unknown username on login screen directly returns an error or always displays the password screen" } ]; string default_redirect_uri = 10 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines where the user will be redirected to if the login is started without app context (e.g. from mail)" + description: "defines where the user will be redirected to if the login is started without app context (e.g. from mail)"; + example: "\"https://acme.com/ui/console\""; + } + ]; + google.protobuf.Duration password_check_lifetime = 11 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"864000s\""; + } + ]; + google.protobuf.Duration external_login_check_lifetime = 12 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"864000s\""; + } + ]; + google.protobuf.Duration mfa_init_skip_lifetime = 13 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"2592000s\""; + } + ]; + google.protobuf.Duration second_factor_check_lifetime = 14 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"64800s\""; + } + ]; + google.protobuf.Duration multi_factor_check_lifetime = 15 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"43200s\""; } ]; - google.protobuf.Duration password_check_lifetime = 11; - google.protobuf.Duration external_login_check_lifetime = 12; - google.protobuf.Duration mfa_init_skip_lifetime = 13; - google.protobuf.Duration second_factor_check_lifetime = 14; - google.protobuf.Duration multi_factor_check_lifetime = 15; repeated SecondFactorType second_factors = 16; repeated MultiFactorType multi_factors = 17; repeated zitadel.idp.v1.IDPLoginPolicyLink idps = 18; - // If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success. + // If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success. bool allow_domain_discovery = 19 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success." + description: "If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success." } ]; bool disable_login_with_email = 20 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if user can additionally (to the loginname) be identified by their verified email address" + description: "defines if the user can additionally (to the login name) be identified by their verified email address" } ]; bool disable_login_with_phone = 21 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if user can additionally (to the loginname) be identified by their verified phone number" + description: "defines if the user can additionally (to the login name) be identified by their verified phone number" } ]; } @@ -222,7 +271,7 @@ message PasswordComplexityPolicy { ]; bool has_lowercase = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the password MUST contain a lower case letter" + description: "defines if the password MUST contain a lowercase letter" } ]; bool has_number = 5 [ @@ -237,7 +286,7 @@ message PasswordComplexityPolicy { ]; bool is_default = 7 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the organisation's admin changed the policy" + description: "defines if the organization's admin changed the policy" } ]; } @@ -258,7 +307,7 @@ message PasswordAgePolicy { ]; bool is_default = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the organisation's admin changed the policy" + description: "defines if the organization's admin changed the policy" } ]; } @@ -267,23 +316,35 @@ message LockoutPolicy { zitadel.v1.ObjectDetails details = 1; uint64 max_password_attempts = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset." + description: "Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset." example: "\"10\"" } ]; bool is_default = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "defines if the organisation's admin changed the policy" + description: "defines if the organization's admin changed the policy" } ]; } message PrivacyPolicy { zitadel.v1.ObjectDetails details = 1; - string tos_link = 2; - string privacy_link = 3; + string tos_link = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"https://zitadel.com/docs/legal/terms-of-service\""; + } + ]; + string privacy_link = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"https://zitadel.com/docs/legal/privacy-policy\""; + } + ]; bool is_default = 4; - string help_link = 5; + string help_link = 5 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"https://zitadel.com/docs/manuals/introduction\""; + } + ]; } message NotificationPolicy { diff --git a/proto/zitadel/project.proto b/proto/zitadel/project.proto index f1e4113b5..c1c5f3f3f 100644 --- a/proto/zitadel/project.proto +++ b/proto/zitadel/project.proto @@ -25,11 +25,11 @@ message Project { description: "current state of the project"; } ]; - // describes if roles of user should be added in token + // describes if the roles of the user should be added to the token bool project_role_assertion = 5; // ZITADEL checks if the user has at least one on this project bool project_role_check = 6; - // ZITADEL checks if the org of the user has permission to this project + // ZITADEL checks if the org of the user has permission for this project bool has_project_check = 7; // Defines from where the private labeling should be triggered PrivateLabelingSetting private_labeling_setting = 8; diff --git a/proto/zitadel/settings.proto b/proto/zitadel/settings.proto index 3fff2d0b1..c8e879f54 100644 --- a/proto/zitadel/settings.proto +++ b/proto/zitadel/settings.proto @@ -3,6 +3,7 @@ syntax = "proto3"; import "zitadel/object.proto"; import "validate/validate.proto"; import "google/protobuf/duration.proto"; +import "protoc-gen-openapiv2/options/annotations.proto"; package zitadel.settings.v1; @@ -11,8 +12,16 @@ option go_package ="github.com/zitadel/zitadel/pkg/grpc/settings"; message SecretGenerator { SecretGeneratorType generator_type = 1; zitadel.v1.ObjectDetails details = 2; - uint32 length = 3; - google.protobuf.Duration expiry = 4; + uint32 length = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "6"; + } + ]; + google.protobuf.Duration expiry = 4 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"3600s\""; + } + ]; bool include_lower_letters = 5; bool include_upper_letters = 6; bool include_digits = 7; @@ -43,11 +52,27 @@ enum SecretGeneratorType { message SMTPConfig { zitadel.v1.ObjectDetails details = 1; - string sender_address = 2; - string sender_name = 3; + string sender_address = 2 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"noreply@m.zitadel.cloud\""; + } + ]; + string sender_name = 3 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"ZITADEL\""; + } + ]; bool tls = 4; - string host = 5; - string user = 6; + string host = 5 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"smtp.postmarkapp.com:587\""; + } + ]; + string user = 6 [ + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"197f0117-529e-443d-bf6c-0292dd9a02b7\""; + } + ]; } message SMSProvider { @@ -88,6 +113,6 @@ message SecurityPolicy { zitadel.v1.ObjectDetails details = 1; // states if iframe embedding is enabled or disabled bool enable_iframe_embedding = 2; - // origins allowed to load ZITADEL in an iframe if enable_iframe_embedding is true + // origins allowed loading ZITADEL in an iframe if enable_iframe_embedding is true repeated string allowed_origins = 3; } diff --git a/proto/zitadel/system.proto b/proto/zitadel/system.proto index d05e52646..b34977e62 100644 --- a/proto/zitadel/system.proto +++ b/proto/zitadel/system.proto @@ -32,7 +32,11 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { url: "https://github.com/zitadel/zitadel/blob/main/LICENSE"; }; }; - + tags: [ + { + name: "General" + } + ]; schemes: HTTPS; schemes: HTTP; @@ -45,7 +49,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { consumes: "application/grpc-web+proto"; produces: "application/grpc-web+proto"; - host: "api.zitadel.ch"; + host: "$ZITADEL_DOMAIN"; base_path: "/system/v1"; external_docs: { @@ -86,7 +90,7 @@ service SystemService { }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - tags: "probes"; + tags: "General"; responses: { key: "200"; value: { diff --git a/proto/zitadel/text.proto b/proto/zitadel/text.proto index 967a37d8b..05689f2af 100644 --- a/proto/zitadel/text.proto +++ b/proto/zitadel/text.proto @@ -12,37 +12,44 @@ message MessageCustomText { zitadel.v1.ObjectDetails details = 1; string title = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "custom text for email title" + description: "custom text for email title"; + example: "\"ZITADEL - Message Title\""; } ]; string pre_header = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "custom text for email pre header" + description: "custom text for email pre-header"; + example: "\"User Message\""; } ]; string subject = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "custom text for email subject" + description: "custom text for email subject"; + example: "\"Message Subject\""; } ]; string greeting = 5 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { description: "custom text for email greeting" + example: "\"Hello {{.FirstName}} {{.LastName}},\""; } ]; string text = 6 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { description: "custom text for email text" + example: "\"This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},\""; } ]; string button_text = 7 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "custom text for email button_text" + description: "custom text for email button_text"; + example: "\"Call to action\""; } ]; string footer_text = 8 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "custom text for email footer_text" + description: "custom text for email footer_text"; + example: "\"\""; } ]; bool is_default = 9; @@ -373,7 +380,7 @@ message ExternalUserNotFoundScreenText { message SuccessLoginScreenText { string title = 1 [(validate.rules).string = {max_len: 200}]; - // Text to describe that auto redirect should happen after successful login + // Text to describe that auto-redirect should happen after successful login string auto_redirect_description = 2 [(validate.rules).string = {max_len: 500}]; // Text to describe that the window can be closed after redirect string redirected_description = 3 [(validate.rules).string = {max_len: 100}]; diff --git a/proto/zitadel/user.proto b/proto/zitadel/user.proto index b0ed58125..21a8361c7 100644 --- a/proto/zitadel/user.proto +++ b/proto/zitadel/user.proto @@ -24,17 +24,17 @@ message User { ]; string user_name = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"mr_long_neck\""; + example: "\"gigi-giraffe\""; } ]; repeated string login_names = 5 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "[\"gigi@caos.ch\", \"gigi@caos-ag.zitadel.ch\"]"; + example: "[\"gigi@zitadel.com\", \"gigi@zitadel.zitadel.ch\"]"; } ]; string preferred_login_name = 6 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"gigi@caos.ch\""; + example: "\"gigi@zitadel.com\""; } ]; oneof type { @@ -103,7 +103,7 @@ message Profile { ]; string nick_name = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"long_neck\""; + example: "\"gigi-giraffe\""; } ]; string display_name = 4 [ @@ -125,7 +125,7 @@ message Profile { ]; string avatar_url = 7 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "avatar url of the user" + description: "avatar URL of the user" example: "\"https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32\""; } ]; @@ -135,7 +135,7 @@ message Email { string email = 1 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { description: "email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)" - example: "\"gigi@caos.ch\""; + example: "\"gigi@zitadel.com\""; } ]; bool is_email_verified = 2 [ @@ -192,7 +192,7 @@ message UserNameQuery { (validate.rules).string = {max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { max_length: 200; - example: "\"mr_long_neck\""; + example: "\"gigi-giraffe\""; } ]; zitadel.v1.TextQueryMethod method = 2 [ @@ -267,7 +267,7 @@ message EmailQuery { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { description: "email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)" max_length: 200; - example: "\"gigi@caos.ch\""; + example: "\"gigi@zitadel.com\""; } ]; zitadel.v1.TextQueryMethod method = 2 [ @@ -294,7 +294,7 @@ message LoginNameQuery { ]; } -//UserStateQuery is always equals +//UserStateQuery always equals message StateQuery { UserState state = 1 [ (validate.rules).enum.defined_only = true, @@ -304,7 +304,7 @@ message StateQuery { ]; } -//UserTypeQuery is always equals +//UserTypeQuery always equals message TypeQuery { Type type = 1 [ (validate.rules).enum.defined_only = true, @@ -342,12 +342,12 @@ message AuthFactor { oneof type { AuthFactorOTP otp = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "one of type use otp or u2f" + description: "one type use OTP or U2F" } ]; AuthFactorU2F u2f = 3 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "one of type use otp or u2f" + description: "one type use OTP or U2F" } ]; } @@ -379,6 +379,7 @@ message WebAuthNKey { bytes public_key = 1 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { description: "json representation of public key credential creation options used by the webauthn client" + example: "\"eyJwdWJsaWNLZXkiOnsiY2hhbGxlbmdlIoplfZm4vM21qSzBPdjltN2x6VWhnclYyejFJSlVzZnpLd0Z1TytWTWtzRW1Icz0iLCJycCI6eyJuYW1lIjoiWklUQURFTCIsImlkIjoiYWNtZS1nem9lNHgueml0YWRlbC5jbG91ZCJ9LCJ1c2VyIjp7Im5hbWUiOiJ0ZXN0dXNlcjU1QGFjbWUueml0YWRlbC5jbG91ZCIsImRpc3BsYXlOYW1lIjoiVGVzdCBUZXN0IiwiaWQiOiJNVGd5TVRVMk1qWTBNakk1TXpBMk5qSTEifSwicHViS2V5Q3JlZFBhcmFtcyI6W3sidHlwZSI6InB1YmxpYy1rZXkiLCJhbGciOi03fSx7InR5cGUiOiJwdWJsaWMta2V5IiwiYWxnIjotMzV9LHsidHlwZSI6InB1YmxpYy1rZXkiLCJhbGciOi0zNn0seyJ0eXBlIjoicHVibGljLWtleSIsImFsZyI6LTI1N30seyJ0eXBlIjoicHVibGljLWtleSIsImFsZyI6LTI1OH0seyJ0eXBlIjoicHVibGljLWtleSIsImFsZyI6LTI1OX0seyJ0eXBlIjoicHVibGljLWtleSIsImFsZyI6LTM3fSx7InR5cGUiOiJwdWJsaWMta2V5IiwiYWxnIjotMzh9LHsidHlwZSI6InB1YmxpYy1rZXkiLCJhbGciOi0zOX0seyJ0eXBlIjoicHVibGljLWtleSIsImFsZyI6LTh9XSwiYXV0aGVudGljYXRvclNlbGVjdGlvbiI6eyJ1c2VyVmVyaWZpY2F0aW9uIjoiZGlzY291cmFnZWQifn2ilGltZW91dCI6NjAwMDAsImF0dGVzdGF0aW9uIjoibm9uZSJ9fQ==\"" } ]; } @@ -387,9 +388,9 @@ message WebAuthNVerification { bytes public_key_credential = 1 [ (validate.rules).bytes.min_len = 55, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "json representation of public key credential issued by the webauthn client"; + description: "JSON representation of public key credential issued by the webauthn client"; min_length: 55; - max_length: 1048576; //1 mb + max_length: 1048576; //1 MB } ]; string token_name = 2 [ @@ -475,7 +476,7 @@ message MembershipQuery { } } -// this query is always equals +// this query always equals message MembershipOrgQuery { string org_id = 1 [ (validate.rules).string = {max_len: 200}, @@ -485,7 +486,7 @@ message MembershipOrgQuery { ]; } -// this query is always equals +// this query always equals message MembershipProjectQuery { string project_id = 1 [ (validate.rules).string = {max_len: 200}, @@ -495,7 +496,7 @@ message MembershipProjectQuery { ]; } -// this query is always equals +// this query always equals message MembershipProjectGrantQuery { string project_grant_id = 1 [ (validate.rules).string = {max_len: 200}, @@ -505,7 +506,7 @@ message MembershipProjectGrantQuery { ]; } -// this query is always equals +// this query always equals message MembershipIAMQuery { bool iam = 1; } @@ -533,12 +534,12 @@ message Session { ]; string user_name = 5 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"mr_long_neck\""; + example: "\"gigi-giraffe\""; } ]; string login_name = 7 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"gigi@caos.ch\""; + example: "\"gigi@zitadel.com\""; } ]; string display_name = 8 [ @@ -550,7 +551,7 @@ message Session { zitadel.v1.ObjectDetails details = 9; string avatar_url = 10 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "avatar url of the user" + description: "avatar URL of the user" example: "\"https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32\""; } ]; @@ -577,16 +578,19 @@ message RefreshToken { ]; google.protobuf.Timestamp auth_time = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"2023-02-13T08:45:00.000000Z\""; description: "\"time when the user authenticated, does not have to be the same time the token was created\"" } ]; google.protobuf.Timestamp idle_expiration = 5 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"2023-02-14T08:45:00.000000Z\""; description: "\"time the refresh token will expire if not used, the user will have to reauthenticate\"" } ]; google.protobuf.Timestamp expiration = 6 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { + example: "\"2023-02-14T08:45:00.000000Z\""; description: "\"time the refresh token will expire, the user will have to reauthenticate\"" } ]; @@ -651,7 +655,7 @@ message UserGrant { ]; string user_name = 6 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"mr_long_neck\""; + example: "\"gigi-giraffe\""; } ]; string first_name = 7 [ @@ -668,7 +672,7 @@ message UserGrant { (validate.rules).string.email = true, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { description: "email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)" - example: "\"gigi@caos.ch\""; + example: "\"gigi@zitadel.com\""; } ]; string display_name = 10 [ @@ -685,12 +689,12 @@ message UserGrant { ]; string org_name = 12 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"CAOS AG\""; + example: "\"ZITADEL\""; } ]; string org_domain = 13 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"caos.ch\""; + example: "\"zitadel.cloud\""; } ]; string project_id = 14 [ @@ -710,13 +714,13 @@ message UserGrant { ]; string avatar_url = 17 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "avatar url of the user" - example: "\"https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32\""; + description: "avatar URL of the user" + example: "\"{your-domain}/assets/v1/avatar-32432jkh4kj32\""; } ]; string preferred_login_name = 18 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"gigi@caos.ch\""; + example: "\"gigi@zitadel.com\""; } ]; } @@ -798,7 +802,7 @@ message UserGrantUserNameQuery { string user_name = 1 [ (validate.rules).string = {max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"mr_long_neck\"" + example: "\"gigi-giraffe\"" } ]; zitadel.v1.TextQueryMethod method = 2 [ @@ -843,7 +847,7 @@ message UserGrantEmailQuery { string email = 1 [ (validate.rules).string = {max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - example: "\"gigi@caos.ch\"" + example: "\"gigi@zitadel.com\"" } ]; zitadel.v1.TextQueryMethod method = 2 [ diff --git a/proto/zitadel/v1.proto b/proto/zitadel/v1.proto index 5c91b6c27..6b64f7db6 100644 --- a/proto/zitadel/v1.proto +++ b/proto/zitadel/v1.proto @@ -33,9 +33,9 @@ message AddCustomOrgIAMPolicyRequest { ]; bool user_login_must_be_domain = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { - description: "the username has to end with the domain of it's organisation" + description: "the username has to end with the domain of its organization" } - ]; // the username has to end with the domain of it's organisation (uniqueness is organisation based) + ]; // the username has to end with the domain of its organization (uniqueness is organization based) } message ImportDataOrg { repeated DataOrg orgs = 1;