chore: rename docs links (#3668)

This commit is contained in:
Florian Forster 2022-05-20 16:32:06 +02:00 committed by GitHub
parent 220c8e4922
commit 0ba165363e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
41 changed files with 136 additions and 136 deletions

View File

@ -73,7 +73,7 @@ brews:
token: "{{ .Env.GORELEASER_TOKEN_TAP }}" token: "{{ .Env.GORELEASER_TOKEN_TAP }}"
folder: Formula folder: Formula
goarm: "7" goarm: "7"
homepage: https://zitadel.ch homepage: https://zitadel.com
description: Open source identity solution built for the container and cloud era description: Open source identity solution built for the container and cloud era
license: Apache 2.0 license: Apache 2.0
test: | test: |

View File

@ -60,7 +60,7 @@ representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at reported to the community leaders responsible for enforcement at
abuse@zitadel.ch. legal@zitadel.com.
All complaints will be reviewed and investigated promptly and fairly. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the All community leaders are obligated to respect the privacy and security of the

View File

@ -12,7 +12,7 @@ At ZITADEL we are extremely grateful for security aware people who disclose vuln
## Reporting a vulnerability ## Reporting a vulnerability
To file an incident, please disclose it by e-mail to security@zitadel.ch including the details of the vulnerability. To file an incident, please disclose it by e-mail to security@zitadel.com including the details of the vulnerability.
At the moment GPG encryption is no yet supported, however you may sign your message at will. At the moment GPG encryption is no yet supported, however you may sign your message at will.

View File

@ -257,8 +257,8 @@ DefaultInstance:
SecondFactorCheckLifetime: 18h SecondFactorCheckLifetime: 18h
MultiFactorCheckLifetime: 12h MultiFactorCheckLifetime: 12h
PrivacyPolicy: PrivacyPolicy:
TOSLink: https://docs.zitadel.ch/docs/legal/terms-of-service TOSLink: https://docs.zitadel.com/docs/legal/terms-of-service
PrivacyLink: https://docs.zitadel.ch/docs/legal/privacy-policy PrivacyLink: https://docs.zitadel.com/docs/legal/privacy-policy
HelpLink: "" HelpLink: ""
LabelPolicy: LabelPolicy:
PrimaryColor: "#5469d4" PrimaryColor: "#5469d4"

View File

@ -21,7 +21,7 @@
<a target="_blank" rel="noreferrer" href="https://www.linkedin.com/company/zitadel/"> <a target="_blank" rel="noreferrer" href="https://www.linkedin.com/company/zitadel/">
<i class="text-3xl lab la-linkedin"></i> <i class="text-3xl lab la-linkedin"></i>
</a> </a>
<a target="_blank" rel="noreferrer" href="https://zitadel.ch/chat"> <a target="_blank" rel="noreferrer" href="https://zitadel.com/chat">
<i class="text-3xl lab la-discord"></i> <i class="text-3xl lab la-discord"></i>
</a> </a>
<a target="_blank" rel="noreferrer" href="https://www.youtube.com/channel/UCUAWJUNYaRn1yIVrZxEfsuA"> <a target="_blank" rel="noreferrer" href="https://www.youtube.com/channel/UCUAWJUNYaRn1yIVrZxEfsuA">

View File

@ -169,7 +169,7 @@
<span class="fill-space"></span> <span class="fill-space"></span>
<a class="doc-link" href="https://docs.zitadel.ch" mat-stroked-button target="_blank"> <a class="doc-link" href="https://docs.zitadel.com" mat-stroked-button target="_blank">
{{ 'MENU.DOCUMENTATION' | translate }} {{ 'MENU.DOCUMENTATION' | translate }}
</a> </a>

View File

@ -5,7 +5,7 @@
> >
<p class="subinfo" sub> <p class="subinfo" sub>
<span class="cnsl-secondary-text">{{ 'PROJECT.MEMBER.DESCRIPTION' | translate }}</span> <span class="cnsl-secondary-text">{{ 'PROJECT.MEMBER.DESCRIPTION' | translate }}</span>
<a mat-icon-button href="https://docs.zitadel.ch/docs/manuals/admin-managers" target="_blank"> <a mat-icon-button href="https://docs.zitadel.com/docs/manuals/admin-managers" target="_blank">
<i class="las la-info-circle"></i> <i class="las la-info-circle"></i>
</a> </a>
</p> </p>

View File

@ -6,7 +6,7 @@
<h1>{{ 'ORG.DOMAINS.TITLE' | translate }}</h1> <h1>{{ 'ORG.DOMAINS.TITLE' | translate }}</h1>
<a <a
mat-icon-button mat-icon-button
href="https://docs.zitadel.ch/docs/guides/basics/organizations#how-zitadel-handles-usernames" href="https://docs.zitadel.com/docs/guides/basics/organizations#how-zitadel-handles-usernames"
rel="noreferrer" rel="noreferrer"
target="_blank" target="_blank"
> >

View File

@ -10,7 +10,7 @@
<span class="fill-space"></span> <span class="fill-space"></span>
<div class="home-grid-container"> <div class="home-grid-container">
<a href="https://docs.zitadel.ch" target="_blank" rel="noreferrer" class="grid-item blue"> <a href="https://docs.zitadel.com" target="_blank" rel="noreferrer" class="grid-item blue">
<div class="grid-item-avatar blue"> <div class="grid-item-avatar blue">
<i class="icon las la-file-alt"></i> <i class="icon las la-file-alt"></i>
</div> </div>
@ -18,7 +18,7 @@
</a> </a>
<a <a
href="https://docs.zitadel.ch/docs/guides/basics/get-started/" href="https://docs.zitadel.com/docs/guides/basics/get-started/"
target="_blank" target="_blank"
rel="noreferrer" rel="noreferrer"
class="grid-item green" class="grid-item green"
@ -30,7 +30,7 @@
</a> </a>
<a <a
href="https://docs.zitadel.ch/docs/quickstarts/introduction" href="https://docs.zitadel.com/docs/quickstarts/introduction"
target="_blank" target="_blank"
rel="noreferrer" rel="noreferrer"
class="grid-item green" class="grid-item green"

View File

@ -1,7 +1,7 @@
<cnsl-detail-layout [hasBackButton]="true" title="{{ 'IAM.MEMBER.TITLE' | translate }}"> <cnsl-detail-layout [hasBackButton]="true" title="{{ 'IAM.MEMBER.TITLE' | translate }}">
<p class="subinfo" sub> <p class="subinfo" sub>
<span class="cnsl-secondary-text">{{ 'IAM.MEMBER.DESCRIPTION' | translate }}</span> <span class="cnsl-secondary-text">{{ 'IAM.MEMBER.DESCRIPTION' | translate }}</span>
<a mat-icon-button href="https://docs.zitadel.ch/docs/manuals/admin-managers" target="_blank"> <a mat-icon-button href="https://docs.zitadel.com/docs/manuals/admin-managers" target="_blank">
<i class="las la-info-circle"></i> <i class="las la-info-circle"></i>
</a> </a>
</p> </p>

View File

@ -1,7 +1,7 @@
<cnsl-detail-layout title="{{org?.name}} {{ 'ORG.MEMBER.TITLE' | translate }}"> <cnsl-detail-layout title="{{org?.name}} {{ 'ORG.MEMBER.TITLE' | translate }}">
<p class="subinfo" sub> <p class="subinfo" sub>
<span class="cnsl-secondary-text">{{ 'ORG.MEMBER.DESCRIPTION' | translate }}</span> <span class="cnsl-secondary-text">{{ 'ORG.MEMBER.DESCRIPTION' | translate }}</span>
<a mat-icon-button href="https://docs.zitadel.ch/docs/manuals/admin-managers" target="_blank"> <a mat-icon-button href="https://docs.zitadel.com/docs/manuals/admin-managers" target="_blank">
<i class="las la-info-circle"></i> <i class="las la-info-circle"></i>
</a> </a>
</p> </p>

View File

@ -1,6 +1,6 @@
<cnsl-top-view title="{{app?.name}}" <cnsl-top-view title="{{app?.name}}"
[hasActions]="isZitadel === false && (['project.app.write:'+projectId, 'project.app.write'] | hasRole | async)" [hasActions]="isZitadel === false && (['project.app.write:'+projectId, 'project.app.write'] | hasRole | async)"
docLink="https://docs.zitadel.ch/docs/guides/basics/projects" docLink="https://docs.zitadel.com/docs/guides/basics/projects"
[sub]="app?.oidcConfig ? ('APP.OIDC.APPTYPE.'+app?.oidcConfig?.appType | translate): 'API'" [sub]="app?.oidcConfig ? ('APP.OIDC.APPTYPE.'+app?.oidcConfig?.appType | translate): 'API'"
[isActive]="app?.state === AppState.APP_STATE_ACTIVE" [isInactive]="app?.state === AppState.APP_STATE_INACTIVE" [isActive]="app?.state === AppState.APP_STATE_ACTIVE" [isInactive]="app?.state === AppState.APP_STATE_INACTIVE"
stateTooltip="{{('APP.PAGES.DETAIL.STATE.'+app?.state) | translate}}"> stateTooltip="{{('APP.PAGES.DETAIL.STATE.'+app?.state) | translate}}">

View File

@ -229,7 +229,7 @@ export class AppDetailComponent implements OnInit, OnDestroy {
{ {
i18nTitle: 'APP.PAGES.NEXTSTEPS.2.TITLE', i18nTitle: 'APP.PAGES.NEXTSTEPS.2.TITLE',
i18nDesc: 'APP.PAGES.NEXTSTEPS.2.DESC', i18nDesc: 'APP.PAGES.NEXTSTEPS.2.DESC',
href: 'https://docs.zitadel.ch', href: 'https://docs.zitadel.comm',
iconClasses: 'las la-people-carry', iconClasses: 'las la-people-carry',
}, },
]; ];

View File

@ -1,7 +1,7 @@
<cnsl-top-view <cnsl-top-view
title="{{ project?.projectName }}" title="{{ project?.projectName }}"
[hasActions]="false" [hasActions]="false"
docLink="https://docs.zitadel.ch/docs/guides/basics/projects#what-is-a-granted-project" docLink="https://docs.zitadel.com/docs/guides/basics/projects#what-is-a-granted-project"
sub="{{ 'PROJECT.PAGES.TYPE.GRANTED_SINGULAR' | translate }} {{ 'ACTIONS.OF' | translate }} <strong>{{ sub="{{ 'PROJECT.PAGES.TYPE.GRANTED_SINGULAR' | translate }} {{ 'ACTIONS.OF' | translate }} <strong>{{
project?.projectOwnerName project?.projectOwnerName
}}</strong>" }}</strong>"

View File

@ -1,6 +1,6 @@
<cnsl-top-view <cnsl-top-view
title="{{ project?.name }}" title="{{ project?.name }}"
docLink="https://docs.zitadel.ch/docs/guides/basics/projects" docLink="https://docs.zitadel.com/docs/guides/basics/projects"
sub="{{ 'PROJECT.PAGES.TYPE.OWNED_SINGULAR' | translate }}" sub="{{ 'PROJECT.PAGES.TYPE.OWNED_SINGULAR' | translate }}"
[isActive]="project?.state === ProjectState.PROJECT_STATE_ACTIVE" [isActive]="project?.state === ProjectState.PROJECT_STATE_ACTIVE"
[isInactive]="project?.state === ProjectState.PROJECT_STATE_INACTIVE" [isInactive]="project?.state === ProjectState.PROJECT_STATE_INACTIVE"

View File

@ -1,7 +1,7 @@
<cnsl-detail-layout [hasBackButton]="true" title="{{ 'PROJECT.GRANT.DETAIL.TITLE' | translate }}"> <cnsl-detail-layout [hasBackButton]="true" title="{{ 'PROJECT.GRANT.DETAIL.TITLE' | translate }}">
<p class="subinfo" sub> <p class="subinfo" sub>
<span class="cnsl-secondary-text">{{ 'PROJECT.GRANT.DETAIL.DESC' | translate }}</span> <span class="cnsl-secondary-text">{{ 'PROJECT.GRANT.DETAIL.DESC' | translate }}</span>
<a mat-icon-button href="https://docs.zitadel.ch/docs/concepts/structure/projects#granted-organizations" <a mat-icon-button href="https://docs.zitadel.com/docs/concepts/structure/projects#granted-organizations"
target="_blank"> target="_blank">
<i class="las la-info-circle"></i> <i class="las la-info-circle"></i>
</a> </a>

View File

@ -2,7 +2,7 @@
<div class="enlarged-container"> <div class="enlarged-container">
<div class="project-title-row"> <div class="project-title-row">
<h1>{{ 'PROJECT.PAGES.LIST' | translate }}</h1> <h1>{{ 'PROJECT.PAGES.LIST' | translate }}</h1>
<a mat-icon-button href="https://docs.zitadel.ch/docs/guides/basics/projects" rel="noreferrer" target="_blank"> <a mat-icon-button href="https://docs.zitadel.com/docs/guides/basics/projects" rel="noreferrer" target="_blank">
<i class="las la-info-circle"></i> <i class="las la-info-circle"></i>
</a> </a>
</div> </div>

View File

@ -1,7 +1,7 @@
<cnsl-top-view <cnsl-top-view
*ngIf="user" *ngIf="user"
title="{{ user?.human ? user.human?.profile?.displayName : user?.machine?.name }}" title="{{ user?.human ? user.human?.profile?.displayName : user?.machine?.name }}"
docLink="https://docs.zitadel.ch/docs/guides/basics/projects" docLink="https://docs.zitadel.com/docs/guides/basics/projects"
sub="{{ user?.preferredLoginName }}" sub="{{ user?.preferredLoginName }}"
[isActive]="user?.state === UserState.USER_STATE_ACTIVE" [isActive]="user?.state === UserState.USER_STATE_ACTIVE"
[isInactive]="user?.state === UserState.USER_STATE_INACTIVE" [isInactive]="user?.state === UserState.USER_STATE_INACTIVE"

View File

@ -3,7 +3,7 @@
<ng-container *ngSwitchCase="Type.TYPE_HUMAN"> <ng-container *ngSwitchCase="Type.TYPE_HUMAN">
<div class="users-title-row"> <div class="users-title-row">
<h1>{{ 'USER.PAGES.LIST' | translate }}</h1> <h1>{{ 'USER.PAGES.LIST' | translate }}</h1>
<a mat-icon-button href="https://docs.zitadel.ch/docs/concepts/structure/users" rel="noreferrer" <a mat-icon-button href="https://docs.zitadel.com/docs/concepts/structure/users" rel="noreferrer"
target="_blank"> target="_blank">
<i class="las la-info-circle"></i> <i class="las la-info-circle"></i>
</a> </a>

View File

@ -2981,7 +2981,7 @@ This is an empty request
| Field | Type | Description | Validation | | Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- | | ----- | ---- | ----------- | ----------- |
| primary_color | string | - | string.max_len: 50<br /> | | primary_color | string | - | string.max_len: 50<br /> |
| 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. Details about this scope in https://docs.zitadel.ch/concepts#Reserved_Scopes | | | 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. Details about this scope in https://docs.zitadel.com/concepts#Reserved_Scopes | |
| warn_color | string | - | string.max_len: 50<br /> | | warn_color | string | - | string.max_len: 50<br /> |
| background_color | string | - | string.max_len: 50<br /> | | background_color | string | - | string.max_len: 50<br /> |
| font_color | string | - | string.max_len: 50<br /> | | font_color | string | - | string.max_len: 50<br /> |

View File

@ -33,7 +33,7 @@ title: zitadel/policy.proto
| details | zitadel.v1.ObjectDetails | - | | | details | zitadel.v1.ObjectDetails | - | |
| primary_color | string | hex value for primary color | | | primary_color | string | hex value for primary color | |
| is_default | bool | defines if the organisation's admin changed the policy | | | 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. Details about this scope in https://docs.zitadel.ch/concepts#Reserved_Scopes | | | 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. Details about this scope in https://docs.zitadel.com/concepts#Reserved_Scopes | |
| warn_color | string | hex value for secondary color | | | warn_color | string | hex value for secondary color | |
| background_color | string | hex value for background color | | | background_color | string | hex value for background color | |
| font_color | string | hex value for font color | | | font_color | string | hex value for font color | |

View File

@ -90,13 +90,13 @@ This case describes how to change it on the organization.
![Configure identity provider](/img/console_org_identity_provider.gif) ![Configure identity provider](/img/console_org_identity_provider.gif)
### 4.Send the primary domain scope on the authorization request ### 4.Send the primary domain scope on the authorization request
ZITADEL will show a set of identity providers by default. This configuration can be changed by users with the [manager role] (https://docs.zitadel.ch/docs/concepts/zitadel/objects/managers) `IAM_OWNER`. ZITADEL will show a set of identity providers by default. This configuration can be changed by users with the [manager role] (https://docs.zitadel.com/docs/concepts/zitadel/objects/managers) `IAM_OWNER`.
An organization's login settings will be shown An organization's login settings will be shown
- as soon as the user has entered the loginname and ZITADEL can identitfy to which organization he belongs; or - as soon as the user has entered the loginname and ZITADEL can identitfy to which organization he belongs; or
- by sending a primary domain scope. - by sending a primary domain scope.
To get your own configuration you will have to send the [primary domain scope](https://docs.zitadel.ch/docs/apis/openidoauth/scopes#reserved-scopes) in your [authorization request](https://docs.zitadel.ch/docs/guides/authentication/login-users/#auth-request) . To get your own configuration you will have to send the [primary domain scope](https://docs.zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes) in your [authorization request](https://docs.zitadel.com/docs/guides/authentication/login-users/#auth-request) .
The primary domain scope will restrict the login to your organization, so only users of your own organization will be able to login, also your branding and policies will trigger. The primary domain scope will restrict the login to your organization, so only users of your own organization will be able to login, also your branding and policies will trigger.
See the following link as an example. Users will be able to register and login to the organization that verified the @caos.ch domain only. See the following link as an example. Users will be able to register and login to the organization that verified the @caos.ch domain only.
@ -112,7 +112,7 @@ Make sure to replace the domain `caos.ch` with your own domain to trigger the co
:::caution :::caution
This example uses the ZITADEL Cloud Application for demonstration. You need to create your own auth request with your applications parameters. Please see the docs to construct an [Auth Request](https://docs.zitadel.ch/docs/guides/authentication/login-users/#auth-request). This example uses the ZITADEL Cloud Application for demonstration. You need to create your own auth request with your applications parameters. Please see the docs to construct an [Auth Request](https://docs.zitadel.com/docs/guides/authentication/login-users/#auth-request).
::: :::

View File

@ -57,7 +57,7 @@ With this token you can make subsequent requests, just like a human user.
In this exercise we will authenticate a service user and receive an access_token to use against a API. In this exercise we will authenticate a service user and receive an access_token to use against a API.
> **Information:** Are you stuck? Don't hesitate to reach out to us on [Github Discussions](https://github.com/zitadel/zitadel/discussions) or [contact us](https://zitadel.ch/contact/) privately. > **Information:** Are you stuck? Don't hesitate to reach out to us on [Github Discussions](https://github.com/zitadel/zitadel/discussions) or [contact us](https://zitadel.com/contact/) privately.
### 1. Generate a private-public key pair in ZITADEL ### 1. Generate a private-public key pair in ZITADEL

View File

@ -56,7 +56,7 @@ So what do we want to achieve with delegated authentication?
* Instead of sending around the users credentials * Instead of sending around the users credentials
* Clients may access protected resources with an **access token** that is only valid for specific scope and limited lifetime (OAuth 2.x) * Clients may access protected resources with an **access token** that is only valid for specific scope and limited lifetime (OAuth 2.x)
* Users have to **authorize** applications to access certain [**scopes**](https://docs.zitadel.ch/architecture#Scopes) (eg, email address or custom roles). Applications can request [**claims**](https://docs.zitadel.ch/architecture#Claims) (key:value pairs, eg email address) for the authorized scopes with the access token or ID token from ZITADEL * Users have to **authorize** applications to access certain [**scopes**](https://docs.zitadel.com/architecture#Scopes) (eg, email address or custom roles). Applications can request [**claims**](https://docs.zitadel.com/architecture#Claims) (key:value pairs, eg email address) for the authorized scopes with the access token or ID token from ZITADEL
* Access tokens are bearer tokens, meaning that possession of the token provides access to a resource. But the tokens expire frequently and the application must request a new access token via **refresh token** or the user must reauthenticate * Access tokens are bearer tokens, meaning that possession of the token provides access to a resource. But the tokens expire frequently and the application must request a new access token via **refresh token** or the user must reauthenticate
![Overview federated identities](/img/guides/consulting_federated_identities_basics.png) ![Overview federated identities](/img/guides/consulting_federated_identities_basics.png)
@ -115,7 +115,7 @@ If you dont have any technical limitations, you should favor the flow Authori
We recommend using **“JWT bearer token with private key”** ([RFC7523](https://tools.ietf.org/html/rfc7523)) for Machine-to-Machine clients. We recommend using **“JWT bearer token with private key”** ([RFC7523](https://tools.ietf.org/html/rfc7523)) for Machine-to-Machine clients.
What this means is that you have to send an JWT token, containing the [standard claims for access tokens](https://docs.zitadel.ch/architecture#Claims) and that is signed with your private key, to the token endpoint to request the access token. We will see how this works in another module about Service Accounts. What this means is that you have to send an JWT token, containing the [standard claims for access tokens](https://docs.zitadel.com/architecture#Claims) and that is signed with your private key, to the token endpoint to request the access token. We will see how this works in another module about Service Accounts.
If you dont have any technical limitations, you should prefer this method over other methods. If you dont have any technical limitations, you should prefer this method over other methods.

View File

@ -36,7 +36,7 @@ In the advanced behavior you can choose if the loginname suffix (domain e.g road
If you like to trigger your settings for your applications you have different possibilities. If you like to trigger your settings for your applications you have different possibilities.
### 1. Primary Domain Scope ### 1. Primary Domain Scope
Send a [primary domain scope](https://docs.zitadel.ch/docs/apis/openidoauth/scopes#reserved-scopes) with your [authorization request](https://docs.zitadel.ch/docs/guides/authentication/login-users/#auth-request) to trigger your organization. Send a [primary domain scope](https://docs.zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes) with your [authorization request](https://docs.zitadel.com/docs/guides/authentication/login-users/#auth-request) to trigger your organization.
The primary domain scope will restrict the login to your organization, so only users of your own organization will be able to login. The primary domain scope will restrict the login to your organization, so only users of your own organization will be able to login.
See the following link as an example. Users will be able to register and login to the organization that verified the @caos.ch domain only. See the following link as an example. Users will be able to register and login to the organization that verified the @caos.ch domain only.
@ -52,7 +52,7 @@ Make sure to replace the domain `caos.ch` with your own domain to trigger the co
:::caution :::caution
This example uses the ZITADEL Cloud Application for demonstration. You need to create your own auth request with your applications parameters. Please see the docs to construct an [Auth Request](https://docs.zitadel.ch/docs/guides/authentication/login-users/#auth-request). This example uses the ZITADEL Cloud Application for demonstration. You need to create your own auth request with your applications parameters. Please see the docs to construct an [Auth Request](https://docs.zitadel.com/docs/guides/authentication/login-users/#auth-request).
::: :::

View File

@ -7,7 +7,7 @@ import Column from "../../src/components/column";
With our guides you will learn everything you need to know about specific topics. You get step-by-step instructions for certain tasks and have a knowledge check at the end. With our guides you will learn everything you need to know about specific topics. You get step-by-step instructions for certain tasks and have a knowledge check at the end.
You can either use our cloud-instance [zitadel.ch](https://zitadel.ch) or deploy a dedicated **ZITADEL** instance. To get started, we recommend you to try out our free tier first. Jump directly to the [get started](./basics/get-started) docs. You can either use our cloud-instance [zitadel.ch](https://zitadel.com) or deploy a dedicated **ZITADEL** instance. To get started, we recommend you to try out our free tier first. Jump directly to the [get started](./basics/get-started) docs.
When you are familiar with the ZITADEL usage, you can choose to stay on [zitadel.ch](./installation/shared-cloud), order your own [dedicated instance](./installation/shared-cloud) which is also availabe on premise, or install ZITADEL easily on your own using [Custom Kubernetes Resources](./installation/crd), [GitOps](./installation/gitops) or [ORBOS](./installation/orbos). When you are familiar with the ZITADEL usage, you can choose to stay on [zitadel.ch](./installation/shared-cloud), order your own [dedicated instance](./installation/shared-cloud) which is also availabe on premise, or install ZITADEL easily on your own using [Custom Kubernetes Resources](./installation/crd), [GitOps](./installation/gitops) or [ORBOS](./installation/orbos).

View File

@ -76,7 +76,7 @@ If you had such a use case, ZITADEL manager roles must be assigned to those user
### Noteworthy ### Noteworthy
Due to the fact that ZITADEL includes unlimited users, projects, and applications and comes with all security features in the FREE tier, ZITADEL can be considered a great alternative to other SaaS IAM systems such as Auth0 or Okta. Due to the fact that ZITADEL includes unlimited users, projects, and applications and comes with all security features in the FREE tier, ZITADEL can be considered a great alternative to other SaaS IAM systems such as Auth0 or Okta.
In such a case with this high potential of scalability where user counts can grow explosively, ZITADEL does not become the bottleneck and therefore is the valid choice. You can learn more on ZITADELs benefits and the pricing [here](https://zitadel.ch/pricing). In such a case with this high potential of scalability where user counts can grow explosively, ZITADEL does not become the bottleneck and therefore is the valid choice. You can learn more on ZITADELs benefits and the pricing [here](https://zitadel.com/pricing).
### Learn more ### Learn more

View File

@ -16,7 +16,7 @@ In this session you can refresh knowledge about existing and gain experience wit
* Review of customer feedback * Review of customer feedback
* Q&A * Q&A
**Price**: [Get a quote](https://zitadel.ch/contact) **Price**: [Get a quote](https://zitadel.com/contact)
## ZITADEL Support Onboarding ## ZITADEL Support Onboarding
@ -34,4 +34,4 @@ In this hands-on training new support staff will get an overview of the system a
* Walk-through key features * Walk-through key features
* Q&A * Q&A
**Price**: [Get a quote](https://zitadel.ch/contact) **Price**: [Get a quote](https://zitadel.com/contact)

View File

@ -63,14 +63,14 @@ Data processing | CH | custom | custom
### Infrastructure Provider ### Infrastructure Provider
CAOS offers the following guarantees for a given infrastructure provider and customer satisfies the [prerequisites](https://docs.zitadel.ch/docs/guides/installation/managed-dedicated-instance). CAOS offers the following guarantees for a given infrastructure provider and customer satisfies the [prerequisites](https://docs.zitadel.com/docs/guides/installation/managed-dedicated-instance).
Guarantees | Google Cloud | Static / Other | Self-hosted Guarantees | Google Cloud | Static / Other | Self-hosted
---|---|---|--- ---|---|---|---
Maintained by CAOS | yes | yes, product only | no Maintained by CAOS | yes | yes, product only | no
24x7 monitoring | yes | yes, product only | yes, product only 24x7 monitoring | yes | yes, product only | yes, product only
Availability SLO | [up to 99.9%](service-level-description#availability-objective) | none | none Availability SLO | [up to 99.9%](service-level-description#availability-objective) | none | none
Performance SLO | up to [rate limits](https://docs.zitadel.ch/docs/legal/rate-limit-policy#what-rate-limits-do-apply) | none | none Performance SLO | up to [rate limits](https://docs.zitadel.com/docs/legal/rate-limit-policy#what-rate-limits-do-apply) | none | none
### Backup ### Backup

View File

@ -33,5 +33,5 @@ For our API rate limits please check the [API Endpoint Rate Limits](/docs/apis/r
## Load Testing ## Load Testing
If you would like to conduct load testing of ZITADEL Cloud or a managed instance, you MUST request to do so with a minimum of 2 weeks notice before the test by contacting us at support@zitadel.ch. If you would like to conduct load testing of ZITADEL Cloud or a managed instance, you MUST request to do so with a minimum of 2 weeks notice before the test by contacting us at support@zitadel.com.
You MUST NOT conduct load testing without prior approval by us. Without prior approval and setup there is a high risk of being flagged by our DDoS solution as malicious traffic. This can have a severe impact on your service quality or result in termination of your agreement. You MUST NOT conduct load testing without prior approval by us. Without prior approval and setup there is a high risk of being flagged by our DDoS solution as malicious traffic. This can have a severe impact on your service quality or result in termination of your agreement.

View File

@ -29,7 +29,7 @@ You can find out how to register OTP [here](./user-factors).
### Can't remember your otp ### Can't remember your otp
If you have a problem with your OTP, please contact your organization support. If you have a user in the Global Organization feel free to contact support@zitadel.ch If you have a problem with your OTP, please contact your organization support. If you have a user in the Global Organization feel free to contact support@zitadel.com
## Login with Universal Second Factor (U2F) (FaceID, FingerPrint, etc.) ## Login with Universal Second Factor (U2F) (FaceID, FingerPrint, etc.)

View File

@ -11,7 +11,7 @@ At the end of the guide you should have an application able to login a user and
Before we can start building our application we have to do a few configuration steps in ZITADEL Console. Before we can start building our application we have to do a few configuration steps in ZITADEL Console.
You will need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your [Project](https://console.zitadel.ch/projects) and add a new application at the top of the page. You will need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your [Project](https://console.zitadel.ch/projects) and add a new application at the top of the page.
Select User Agent and continue. More about the different app types can you find [here](https://docs.zitadel.ch/docs/guides/authorization/oauth-recommended-flows#different-client-profiles). Select User Agent and continue. More about the different app types can you find [here](https://docs.zitadel.com/docs/guides/authorization/oauth-recommended-flows#different-client-profiles).
We recommend that you use [Authorization Code](../../apis/openidoauth/grant-types#authorization-code) in combination with [Proof Key for Code Exchange](../../apis/openidoauth/grant-types#proof-key-for-code-exchange) for all web applications. We recommend that you use [Authorization Code](../../apis/openidoauth/grant-types#authorization-code) in combination with [Proof Key for Code Exchange](../../apis/openidoauth/grant-types#proof-key-for-code-exchange) for all web applications.
### Redirect URLs ### Redirect URLs

View File

@ -1,4 +1,4 @@
Contact: mailto:security@zitadel.ch Contact: mailto:security@zitadel.com
Expires: Fri, 31 Dec 2021 23:00 +0200 Expires: Fri, 31 Dec 2021 23:00 +0200
Preferred-Languages: en, de Preferred-Languages: en, de
Canonical: https://docs.zitadel.ch/security.txt Canonical: https://docs.zitadel.com/security.txt

View File

@ -2808,7 +2808,7 @@ func TestAddHumanCommand(t *testing.T) {
Username: "username", Username: "username",
PreferredLanguage: language.English, PreferredLanguage: language.English,
Email: Email{ Email: Email{
Address: "support@zitadel.ch", Address: "support@zitadel.com",
}, },
}, },
}, },
@ -2824,7 +2824,7 @@ func TestAddHumanCommand(t *testing.T) {
Username: "username", Username: "username",
PreferredLanguage: language.English, PreferredLanguage: language.English,
FirstName: "hurst", FirstName: "hurst",
Email: Email{Address: "support@zitadel.ch"}, Email: Email{Address: "support@zitadel.com"},
}, },
}, },
want: Want{ want: Want{
@ -2836,7 +2836,7 @@ func TestAddHumanCommand(t *testing.T) {
args: args{ args: args{
a: agg, a: agg,
human: &AddHuman{ human: &AddHuman{
Email: Email{Address: "support@zitadel.ch"}, Email: Email{Address: "support@zitadel.com"},
PreferredLanguage: language.English, PreferredLanguage: language.English,
FirstName: "gigi", FirstName: "gigi",
LastName: "giraffe", LastName: "giraffe",
@ -2880,7 +2880,7 @@ func TestAddHumanCommand(t *testing.T) {
args: args{ args: args{
a: agg, a: agg,
human: &AddHuman{ human: &AddHuman{
Email: Email{Address: "support@zitadel.ch", Verified: true}, Email: Email{Address: "support@zitadel.com", Verified: true},
PreferredLanguage: language.English, PreferredLanguage: language.English,
FirstName: "gigi", FirstName: "gigi",
LastName: "giraffe", LastName: "giraffe",
@ -2930,7 +2930,7 @@ func TestAddHumanCommand(t *testing.T) {
"gigi giraffe", "gigi giraffe",
language.English, language.English,
0, 0,
"support@zitadel.ch", "support@zitadel.com",
true, true,
) )
event.AddPasswordData(&crypto.CryptoValue{ event.AddPasswordData(&crypto.CryptoValue{

View File

@ -1630,7 +1630,7 @@ func TestExistsUser(t *testing.T) {
"displayName", "displayName",
language.German, language.German,
domain.GenderFemale, domain.GenderFemale,
"support@zitadel.ch", "support@zitadel.com",
true, true,
), ),
}, nil }, nil
@ -1656,7 +1656,7 @@ func TestExistsUser(t *testing.T) {
"displayName", "displayName",
language.German, language.German,
domain.GenderFemale, domain.GenderFemale,
"support@zitadel.ch", "support@zitadel.com",
true, true,
), ),
}, nil }, nil

View File

@ -36,7 +36,7 @@ func TestUserProjection_reduces(t *testing.T) {
"displayName": "display-name", "displayName": "display-name",
"preferredLanguage": "ch-DE", "preferredLanguage": "ch-DE",
"gender": 1, "gender": 1,
"email": "email@zitadel.ch", "email": "email@zitadel.com",
"phone": "+41 00 000 00 00" "phone": "+41 00 000 00 00"
}`), }`),
), user.HumanAddedEventMapper), ), user.HumanAddedEventMapper),
@ -73,7 +73,7 @@ func TestUserProjection_reduces(t *testing.T) {
&sql.NullString{String: "display-name", Valid: true}, &sql.NullString{String: "display-name", Valid: true},
&sql.NullString{String: "ch-DE", Valid: true}, &sql.NullString{String: "ch-DE", Valid: true},
&sql.NullInt16{Int16: int16(domain.GenderFemale), Valid: true}, &sql.NullInt16{Int16: int16(domain.GenderFemale), Valid: true},
"email@zitadel.ch", "email@zitadel.com",
&sql.NullString{String: "+41 00 000 00 00", Valid: true}, &sql.NullString{String: "+41 00 000 00 00", Valid: true},
}, },
}, },
@ -95,7 +95,7 @@ func TestUserProjection_reduces(t *testing.T) {
"displayName": "display-name", "displayName": "display-name",
"preferredLanguage": "ch-DE", "preferredLanguage": "ch-DE",
"gender": 1, "gender": 1,
"email": "email@zitadel.ch", "email": "email@zitadel.com",
"phone": "+41 00 000 00 00" "phone": "+41 00 000 00 00"
}`), }`),
), user.HumanAddedEventMapper), ), user.HumanAddedEventMapper),
@ -132,7 +132,7 @@ func TestUserProjection_reduces(t *testing.T) {
&sql.NullString{String: "display-name", Valid: true}, &sql.NullString{String: "display-name", Valid: true},
&sql.NullString{String: "ch-DE", Valid: true}, &sql.NullString{String: "ch-DE", Valid: true},
&sql.NullInt16{Int16: int16(domain.GenderFemale), Valid: true}, &sql.NullInt16{Int16: int16(domain.GenderFemale), Valid: true},
"email@zitadel.ch", "email@zitadel.com",
&sql.NullString{String: "+41 00 000 00 00", Valid: true}, &sql.NullString{String: "+41 00 000 00 00", Valid: true},
}, },
}, },
@ -150,7 +150,7 @@ func TestUserProjection_reduces(t *testing.T) {
"username": "user-name", "username": "user-name",
"firstName": "first-name", "firstName": "first-name",
"lastName": "last-name", "lastName": "last-name",
"email": "email@zitadel.ch" "email": "email@zitadel.com"
}`), }`),
), user.HumanAddedEventMapper), ), user.HumanAddedEventMapper),
}, },
@ -186,7 +186,7 @@ func TestUserProjection_reduces(t *testing.T) {
&sql.NullString{}, &sql.NullString{},
&sql.NullString{String: "und", Valid: false}, &sql.NullString{String: "und", Valid: false},
&sql.NullInt16{}, &sql.NullInt16{},
"email@zitadel.ch", "email@zitadel.com",
&sql.NullString{}, &sql.NullString{},
}, },
}, },
@ -208,7 +208,7 @@ func TestUserProjection_reduces(t *testing.T) {
"displayName": "display-name", "displayName": "display-name",
"preferredLanguage": "ch-DE", "preferredLanguage": "ch-DE",
"gender": 1, "gender": 1,
"email": "email@zitadel.ch", "email": "email@zitadel.com",
"phone": "+41 00 000 00 00" "phone": "+41 00 000 00 00"
}`), }`),
), user.HumanRegisteredEventMapper), ), user.HumanRegisteredEventMapper),
@ -245,7 +245,7 @@ func TestUserProjection_reduces(t *testing.T) {
&sql.NullString{String: "display-name", Valid: true}, &sql.NullString{String: "display-name", Valid: true},
&sql.NullString{String: "ch-DE", Valid: true}, &sql.NullString{String: "ch-DE", Valid: true},
&sql.NullInt16{Int16: int16(domain.GenderFemale), Valid: true}, &sql.NullInt16{Int16: int16(domain.GenderFemale), Valid: true},
"email@zitadel.ch", "email@zitadel.com",
&sql.NullString{String: "+41 00 000 00 00", Valid: true}, &sql.NullString{String: "+41 00 000 00 00", Valid: true},
}, },
}, },
@ -267,7 +267,7 @@ func TestUserProjection_reduces(t *testing.T) {
"displayName": "display-name", "displayName": "display-name",
"preferredLanguage": "ch-DE", "preferredLanguage": "ch-DE",
"gender": 1, "gender": 1,
"email": "email@zitadel.ch", "email": "email@zitadel.com",
"phone": "+41 00 000 00 00" "phone": "+41 00 000 00 00"
}`), }`),
), user.HumanRegisteredEventMapper), ), user.HumanRegisteredEventMapper),
@ -304,7 +304,7 @@ func TestUserProjection_reduces(t *testing.T) {
&sql.NullString{String: "display-name", Valid: true}, &sql.NullString{String: "display-name", Valid: true},
&sql.NullString{String: "ch-DE", Valid: true}, &sql.NullString{String: "ch-DE", Valid: true},
&sql.NullInt16{Int16: int16(domain.GenderFemale), Valid: true}, &sql.NullInt16{Int16: int16(domain.GenderFemale), Valid: true},
"email@zitadel.ch", "email@zitadel.com",
&sql.NullString{String: "+41 00 000 00 00", Valid: true}, &sql.NullString{String: "+41 00 000 00 00", Valid: true},
}, },
}, },
@ -322,7 +322,7 @@ func TestUserProjection_reduces(t *testing.T) {
"username": "user-name", "username": "user-name",
"firstName": "first-name", "firstName": "first-name",
"lastName": "last-name", "lastName": "last-name",
"email": "email@zitadel.ch" "email": "email@zitadel.com"
}`), }`),
), user.HumanRegisteredEventMapper), ), user.HumanRegisteredEventMapper),
}, },
@ -358,7 +358,7 @@ func TestUserProjection_reduces(t *testing.T) {
&sql.NullString{}, &sql.NullString{},
&sql.NullString{String: "und", Valid: false}, &sql.NullString{String: "und", Valid: false},
&sql.NullInt16{}, &sql.NullInt16{},
"email@zitadel.ch", "email@zitadel.com",
&sql.NullString{}, &sql.NullString{},
}, },
}, },
@ -984,7 +984,7 @@ func TestUserProjection_reduces(t *testing.T) {
repository.EventType(user.HumanEmailChangedType), repository.EventType(user.HumanEmailChangedType),
user.AggregateType, user.AggregateType,
[]byte(`{ []byte(`{
"email": "email@zitadel.ch" "email": "email@zitadel.com"
}`), }`),
), user.HumanEmailChangedEventMapper), ), user.HumanEmailChangedEventMapper),
}, },
@ -1007,7 +1007,7 @@ func TestUserProjection_reduces(t *testing.T) {
{ {
expectedStmt: "UPDATE projections.users_humans SET (email, is_email_verified) = ($1, $2) WHERE (user_id = $3)", expectedStmt: "UPDATE projections.users_humans SET (email, is_email_verified) = ($1, $2) WHERE (user_id = $3)",
expectedArgs: []interface{}{ expectedArgs: []interface{}{
"email@zitadel.ch", "email@zitadel.com",
false, false,
"agg-id", "agg-id",
}, },
@ -1023,7 +1023,7 @@ func TestUserProjection_reduces(t *testing.T) {
repository.EventType(user.UserV1EmailChangedType), repository.EventType(user.UserV1EmailChangedType),
user.AggregateType, user.AggregateType,
[]byte(`{ []byte(`{
"email": "email@zitadel.ch" "email": "email@zitadel.com"
}`), }`),
), user.HumanEmailChangedEventMapper), ), user.HumanEmailChangedEventMapper),
}, },
@ -1046,7 +1046,7 @@ func TestUserProjection_reduces(t *testing.T) {
{ {
expectedStmt: "UPDATE projections.users_humans SET (email, is_email_verified) = ($1, $2) WHERE (user_id = $3)", expectedStmt: "UPDATE projections.users_humans SET (email, is_email_verified) = ($1, $2) WHERE (user_id = $3)",
expectedArgs: []interface{}{ expectedArgs: []interface{}{
"email@zitadel.ch", "email@zitadel.com",
false, false,
"agg-id", "agg-id",
}, },

View File

@ -30,8 +30,8 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
description: "This API is intended to configure and manage the IAM instance itself."; description: "This API is intended to configure and manage the IAM instance itself.";
contact:{ contact:{
name: "CAOS developers of ZITADEL" name: "CAOS developers of ZITADEL"
url: "https://zitadel.ch" url: "https://zitadel.com"
email: "hi@zitadel.ch" email: "hi@zitadel.com"
} }
license: { license: {
name: "Apache 2.0", name: "Apache 2.0",
@ -56,7 +56,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
external_docs: { external_docs: {
description: "Detailed information about ZITADEL", description: "Detailed information about ZITADEL",
url: "https://docs.zitadel.ch" url: "https://docs.zitadel.com"
} }
security_definitions: { security_definitions: {
@ -379,7 +379,7 @@ service AdminService {
tags: "orgs"; tags: "orgs";
tags: "global"; tags: "global";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Organizations"; url: "https://docs.zitadel.com/administrate#Organizations";
description: "detailed information about organizations"; description: "detailed information about organizations";
}; };
responses: { responses: {
@ -405,7 +405,7 @@ service AdminService {
tags: "orgs"; tags: "orgs";
tags: "global"; tags: "global";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Organizations"; url: "https://docs.zitadel.com/administrate#Organizations";
description: "detailed information about organizations"; description: "detailed information about organizations";
}; };
responses: { responses: {
@ -439,7 +439,7 @@ service AdminService {
tags: "orgs"; tags: "orgs";
tags: "global"; tags: "global";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Organizations"; url: "https://docs.zitadel.com/administrate#Organizations";
description: "detailed information about organizations"; description: "detailed information about organizations";
}; };
responses: { responses: {
@ -478,7 +478,7 @@ service AdminService {
tags: "orgs"; tags: "orgs";
tags: "global"; tags: "global";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Organizations"; url: "https://docs.zitadel.com/administrate#Organizations";
description: "detailed information about organizations"; description: "detailed information about organizations";
}; };
responses: { responses: {
@ -514,7 +514,7 @@ service AdminService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#What_are_Identity_Providers"; url: "https://docs.zitadel.com/administrate#What_are_Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -551,7 +551,7 @@ service AdminService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#What_are_Identity_Providers"; url: "https://docs.zitadel.com/administrate#What_are_Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -590,7 +590,7 @@ service AdminService {
tags: "oidc"; tags: "oidc";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/concepts#OpenID_Connect_1_0_and_OAuth_2_0"; url: "https://docs.zitadel.com/concepts#OpenID_Connect_1_0_and_OAuth_2_0";
description: "detailed descriptions about oidc configuration"; description: "detailed descriptions about oidc configuration";
}; };
responses: { responses: {
@ -663,7 +663,7 @@ service AdminService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#What_are_Identity_Providers"; url: "https://docs.zitadel.com/administrate#What_are_Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -700,7 +700,7 @@ service AdminService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#What_are_Identity_Providers"; url: "https://docs.zitadel.com/administrate#What_are_Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -737,7 +737,7 @@ service AdminService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#What_are_Identity_Providers"; url: "https://docs.zitadel.com/administrate#What_are_Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -773,7 +773,7 @@ service AdminService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#What_are_Identity_Providers"; url: "https://docs.zitadel.com/administrate#What_are_Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -812,7 +812,7 @@ service AdminService {
tags: "identity provider"; tags: "identity provider";
tags: "oidc"; tags: "oidc";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/concepts#OpenID_Connect_1_0_and_OAuth_2_0"; url: "https://docs.zitadel.com/concepts#OpenID_Connect_1_0_and_OAuth_2_0";
description: "detailed descriptions about oidc configuration"; description: "detailed descriptions about oidc configuration";
}; };
responses: { responses: {
@ -907,7 +907,7 @@ service AdminService {
tags: "domain policy"; tags: "domain policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the domain policy"; description: "detailed information about the domain policy";
}; };
responses: { responses: {
@ -936,7 +936,7 @@ service AdminService {
tags: "domain policy"; tags: "domain policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the domain policy"; description: "detailed information about the domain policy";
}; };
responses: { responses: {
@ -963,7 +963,7 @@ service AdminService {
tags: "domain policy"; tags: "domain policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the domain policy"; description: "detailed information about the domain policy";
}; };
responses: { responses: {
@ -991,7 +991,7 @@ service AdminService {
tags: "domain policy"; tags: "domain policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the domain policy"; description: "detailed information about the domain policy";
}; };
responses: { responses: {
@ -1019,7 +1019,7 @@ service AdminService {
tags: "domain policy"; tags: "domain policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the domain policy"; description: "detailed information about the domain policy";
}; };
responses: { responses: {
@ -1047,7 +1047,7 @@ service AdminService {
tags: "orgiam"; tags: "orgiam";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the orgiam"; description: "detailed information about the orgiam";
}; };
responses: { responses: {
@ -1073,7 +1073,7 @@ service AdminService {
tags: "domain policy"; tags: "domain policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the domain policy"; description: "detailed information about the domain policy";
}; };
responses: { responses: {
@ -1101,7 +1101,7 @@ service AdminService {
tags: "domain policy"; tags: "domain policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the domain policy"; description: "detailed information about the domain policy";
}; };
responses: { responses: {
@ -1127,7 +1127,7 @@ service AdminService {
tags: "domain policy"; tags: "domain policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the domain policy"; description: "detailed information about the domain policy";
}; };
responses: { responses: {
@ -1154,7 +1154,7 @@ service AdminService {
tags: "domain policy"; tags: "domain policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the domain policy"; description: "detailed information about the domain policy";
}; };
responses: { responses: {
@ -1181,7 +1181,7 @@ service AdminService {
tags: "domain policy"; tags: "domain policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the domain policy"; description: "detailed information about the domain policy";
}; };
responses: { responses: {
@ -1208,7 +1208,7 @@ service AdminService {
tags: "domainpolicy"; tags: "domainpolicy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#IAM_Access_Preference"; url: "https://docs.zitadel.com/administrate#IAM_Access_Preference";
description: "detailed information about the domainpolicy"; description: "detailed information about the domainpolicy";
}; };
responses: { responses: {
@ -1369,7 +1369,7 @@ service AdminService {
tags: "login policy"; tags: "login policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Login_Options"; url: "https://docs.zitadel.com/administrate#Login_Options";
description: "detailed information about the login policy"; description: "detailed information about the login policy";
}; };
responses: { responses: {
@ -1397,7 +1397,7 @@ service AdminService {
tags: "login policy"; tags: "login policy";
tags: "policy"; tags: "policy";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Login_Options"; url: "https://docs.zitadel.com/administrate#Login_Options";
description: "detailed information about the login policy"; description: "detailed information about the login policy";
}; };
responses: { responses: {
@ -1426,7 +1426,7 @@ service AdminService {
tags: "policy"; tags: "policy";
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Identity_Providers"; url: "https://docs.zitadel.com/administrate#Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -1455,7 +1455,7 @@ service AdminService {
tags: "policy"; tags: "policy";
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Identity_Providers"; url: "https://docs.zitadel.com/administrate#Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -1483,7 +1483,7 @@ service AdminService {
tags: "policy"; tags: "policy";
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Identity_Providers"; url: "https://docs.zitadel.com/administrate#Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -1510,7 +1510,7 @@ service AdminService {
tags: "policy"; tags: "policy";
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Identity_Providers"; url: "https://docs.zitadel.com/administrate#Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -1539,7 +1539,7 @@ service AdminService {
tags: "policy"; tags: "policy";
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Identity_Providers"; url: "https://docs.zitadel.com/administrate#Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -1578,7 +1578,7 @@ service AdminService {
tags: "policy"; tags: "policy";
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Identity_Providers"; url: "https://docs.zitadel.com/administrate#Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -1616,7 +1616,7 @@ service AdminService {
tags: "policy"; tags: "policy";
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Identity_Providers"; url: "https://docs.zitadel.com/administrate#Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -1645,7 +1645,7 @@ service AdminService {
tags: "policy"; tags: "policy";
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Identity_Providers"; url: "https://docs.zitadel.com/administrate#Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -1684,7 +1684,7 @@ service AdminService {
tags: "policy"; tags: "policy";
tags: "identity provider"; tags: "identity provider";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Identity_Providers"; url: "https://docs.zitadel.com/administrate#Identity_Providers";
description: "detailed information about identity providers"; description: "detailed information about identity providers";
}; };
responses: { responses: {
@ -1722,7 +1722,7 @@ service AdminService {
tags: "password policy"; tags: "password policy";
tags: "password complexity"; tags: "password complexity";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Password_complexity"; url: "https://docs.zitadel.com/administrate#Password_complexity";
description: "detailed information about the password complexity policy"; description: "detailed information about the password complexity policy";
}; };
responses: { responses: {
@ -1751,7 +1751,7 @@ service AdminService {
tags: "password policy"; tags: "password policy";
tags: "password complexity"; tags: "password complexity";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#Password_complexity"; url: "https://docs.zitadel.com/administrate#Password_complexity";
description: "detailed information about the password complexity policy"; description: "detailed information about the password complexity policy";
}; };
responses: { responses: {
@ -2286,7 +2286,7 @@ service AdminService {
tags: "member"; tags: "member";
tags: "roles"; tags: "roles";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#ZITADEL_s_management_roles"; url: "https://docs.zitadel.com/administrate#ZITADEL_s_management_roles";
description: "detailed information about the IAM member roles"; description: "detailed information about the IAM member roles";
}; };
responses: { responses: {
@ -2315,7 +2315,7 @@ service AdminService {
tags: "member"; tags: "member";
tags: "iam member"; tags: "iam member";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#ZITADEL_s_management_roles"; url: "https://docs.zitadel.com/administrate#ZITADEL_s_management_roles";
description: "detailed information about the IAM member roles"; description: "detailed information about the IAM member roles";
}; };
responses: { responses: {
@ -2344,7 +2344,7 @@ service AdminService {
tags: "member"; tags: "member";
tags: "iam member"; tags: "iam member";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#ZITADEL_s_management_roles"; url: "https://docs.zitadel.com/administrate#ZITADEL_s_management_roles";
description: "detailed information about the IAM member roles"; description: "detailed information about the IAM member roles";
}; };
responses: { responses: {
@ -2384,7 +2384,7 @@ service AdminService {
tags: "member"; tags: "member";
tags: "iam member"; tags: "iam member";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#ZITADEL_s_management_roles"; url: "https://docs.zitadel.com/administrate#ZITADEL_s_management_roles";
description: "detailed information about the IAM member roles"; description: "detailed information about the IAM member roles";
}; };
responses: { responses: {
@ -2422,7 +2422,7 @@ service AdminService {
tags: "member"; tags: "member";
tags: "iam member"; tags: "iam member";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/administrate#ZITADEL_s_management_roles"; url: "https://docs.zitadel.com/administrate#ZITADEL_s_management_roles";
description: "detailed information about the IAM member roles"; description: "detailed information about the IAM member roles";
}; };
responses: { responses: {
@ -2460,7 +2460,7 @@ service AdminService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "views"; tags: "views";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/concepts#Software_Architecture"; url: "https://docs.zitadel.com/concepts#Software_Architecture";
description: "details of ZITADEL's event driven software concepts"; description: "details of ZITADEL's event driven software concepts";
}; };
responses: { responses: {
@ -2487,7 +2487,7 @@ service AdminService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "failed events"; tags: "failed events";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/concepts#Software_Architecture"; url: "https://docs.zitadel.com/concepts#Software_Architecture";
description: "details of ZITADEL's event driven software concepts"; description: "details of ZITADEL's event driven software concepts";
}; };
responses: { responses: {
@ -2516,7 +2516,7 @@ service AdminService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "failed events"; tags: "failed events";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/concepts#Software_Architecture"; url: "https://docs.zitadel.com/concepts#Software_Architecture";
description: "details of ZITADEL's event driven software concepts"; description: "details of ZITADEL's event driven software concepts";
}; };
responses: { responses: {
@ -3591,7 +3591,7 @@ message UpdateLabelPolicyRequest {
]; ];
bool hide_login_name_suffix = 3 [ bool hide_login_name_suffix = 3 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
description: "hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.ch/concepts#Reserved_Scopes"; description: "hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.com/concepts#Reserved_Scopes";
} }
]; ];
string warn_color = 4 [(validate.rules).string = {max_len: 50}]; string warn_color = 4 [(validate.rules).string = {max_len: 50}];

View File

@ -24,9 +24,9 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
version: "1.0"; 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 logged in user.";
contact:{ contact:{
name: "CAOS developers of ZITADEL" name: "ZITADEL"
url: "https://zitadel.ch" url: "https://zitadel.com"
email: "hi@zitadel.ch" email: "hi@zitadel.com"
} }
license: { license: {
name: "Apache License 2.0", name: "Apache License 2.0",
@ -49,7 +49,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
external_docs: { external_docs: {
description: "Detailed information about ZITADEL", description: "Detailed information about ZITADEL",
url: "https://docs.zitadel.ch" url: "https://docs.zitadel.com"
} }
}; };

View File

@ -33,9 +33,9 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
version: "1.0"; 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, organisations, projects, clients, users and so on if they have the necessary access rights.";
contact:{ contact:{
name: "CAOS developers of ZITADEL" name: "ZITADEL"
url: "https://zitadel.ch" url: "https://zitadel.com"
email: "hi@zitadel.ch" email: "hi@zitadel.com"
} }
license: { license: {
name: "Apache License 2.0", name: "Apache License 2.0",
@ -59,7 +59,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
external_docs: { external_docs: {
description: "Detailed information about ZITADEL", description: "Detailed information about ZITADEL",
url: "https://docs.zitadel.ch" url: "https://docs.zitadel.com"
} }
extensions: { extensions: {
@ -4663,10 +4663,10 @@ message GetDefaultLabelPolicyResponse {
message AddCustomLabelPolicyRequest { message AddCustomLabelPolicyRequest {
string primary_color = 1 [(validate.rules).string = {max_len: 50}]; string primary_color = 1 [(validate.rules).string = {max_len: 50}];
// hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.ch/concepts#Reserved_Scopes // hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.com/concepts#Reserved_Scopes
bool hide_login_name_suffix = 3 [ bool hide_login_name_suffix = 3 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
description: "hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.ch/concepts#Reserved_Scopes"; description: "hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.com/concepts#Reserved_Scopes";
} }
]; ];
string warn_color = 4 [(validate.rules).string = {max_len: 50}]; string warn_color = 4 [(validate.rules).string = {max_len: 50}];
@ -4687,7 +4687,7 @@ message UpdateCustomLabelPolicyRequest {
string primary_color = 1 [(validate.rules).string = {max_len: 50}]; string primary_color = 1 [(validate.rules).string = {max_len: 50}];
bool hide_login_name_suffix = 3 [ bool hide_login_name_suffix = 3 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
description: "hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.ch/concepts#Reserved_Scopes"; description: "hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.com/concepts#Reserved_Scopes";
} }
]; ];
string warn_color = 4 [(validate.rules).string = {max_len: 50}]; string warn_color = 4 [(validate.rules).string = {max_len: 50}];

View File

@ -62,10 +62,10 @@ message LabelPolicy {
description: "defines if the organisation's admin changed the policy" description: "defines if the organisation'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. Details about this scope in https://docs.zitadel.ch/concepts#Reserved_Scopes // hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.com/concepts#Reserved_Scopes
bool hide_login_name_suffix = 5 [ bool hide_login_name_suffix = 5 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
description: "hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.ch/concepts#Reserved_Scopes"; description: "hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.com/concepts#Reserved_Scopes";
} }
]; ];
// hex value for secondary color // hex value for secondary color

View File

@ -19,9 +19,9 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
version: "1.0"; version: "1.0";
description: "This API is intended to configure and manage the different tenants whithin ZITADEL."; description: "This API is intended to configure and manage the different tenants whithin ZITADEL.";
contact:{ contact:{
name: "CAOS developers of ZITADEL" name: "ZITADEL"
url: "https://zitadel.ch" url: "https://zitadel.com"
email: "hi@zitadel.ch" email: "hi@zitadel.com"
} }
license: { license: {
name: "Apache 2.0", name: "Apache 2.0",
@ -46,7 +46,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
external_docs: { external_docs: {
description: "Detailed information about ZITADEL", description: "Detailed information about ZITADEL",
url: "https://docs.zitadel.ch" url: "https://docs.zitadel.com"
} }
responses: { responses: {
@ -182,7 +182,7 @@ service SystemService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "views"; tags: "views";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/concepts#Software_Architecture"; url: "https://docs.zitadel.com/concepts#Software_Architecture";
description: "details of ZITADEL's event driven software concepts"; description: "details of ZITADEL's event driven software concepts";
}; };
responses: { responses: {
@ -210,7 +210,7 @@ service SystemService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "views"; tags: "views";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/concepts#Software_Architecture"; url: "https://docs.zitadel.com/concepts#Software_Architecture";
description: "details of ZITADEL's event driven software concepts"; description: "details of ZITADEL's event driven software concepts";
}; };
responses: { responses: {
@ -234,7 +234,7 @@ service SystemService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "failed events"; tags: "failed events";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/concepts#Software_Architecture"; url: "https://docs.zitadel.com/concepts#Software_Architecture";
description: "details of ZITADEL's event driven software concepts"; description: "details of ZITADEL's event driven software concepts";
}; };
responses: { responses: {
@ -259,7 +259,7 @@ service SystemService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
tags: "failed events"; tags: "failed events";
external_docs: { external_docs: {
url: "https://docs.zitadel.ch/concepts#Software_Architecture"; url: "https://docs.zitadel.com/concepts#Software_Architecture";
description: "details of ZITADEL's event driven software concepts"; description: "details of ZITADEL's event driven software concepts";
}; };
responses: { responses: {