mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 21:47:32 +00:00
chore: rename docs links (#3668)
This commit is contained in:
Florian Forster
@@ -2981,7 +2981,7 @@ This is an empty request
|
||||
| Field | Type | Description | Validation |
|
||||
| ----- | ---- | ----------- | ----------- |
|
||||
| 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 /> |
|
||||
| background_color | string | - | string.max_len: 50<br /> |
|
||||
| font_color | string | - | string.max_len: 50<br /> |
|
||||
|
||||
@@ -33,7 +33,7 @@ title: zitadel/policy.proto
|
||||
| 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. 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 | |
|
||||
| background_color | string | hex value for background color | |
|
||||
| font_color | string | hex value for font color | |
|
||||
|
||||
@@ -90,13 +90,13 @@ This case describes how to change it on the organization.
|
||||
|
||||
|
||||
### 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
|
||||
|
||||
- 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.
|
||||
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.
|
||||
|
||||
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
|
||||
|
||||
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).
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
> **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
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@ So what do we want to achieve with delegated authentication?
|
||||
|
||||
* Instead of sending around the user’s credentials
|
||||
* 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
|
||||
|
||||
|
||||
@@ -115,7 +115,7 @@ If you don’t 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.
|
||||
|
||||
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 don’t have any technical limitations, you should prefer this method over other methods.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
### 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.
|
||||
|
||||
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
|
||||
|
||||
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).
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
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).
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ If you had such a use case, ZITADEL manager roles must be assigned to those user
|
||||
### 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.
|
||||
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
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ In this session you can refresh knowledge about existing and gain experience wit
|
||||
* Review of customer feedback
|
||||
* Q&A
|
||||
|
||||
**Price**: [Get a quote](https://zitadel.ch/contact)
|
||||
**Price**: [Get a quote](https://zitadel.com/contact)
|
||||
|
||||
## 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
|
||||
* Q&A
|
||||
|
||||
**Price**: [Get a quote](https://zitadel.ch/contact)
|
||||
**Price**: [Get a quote](https://zitadel.com/contact)
|
||||
@@ -63,14 +63,14 @@ Data processing | CH | custom | custom
|
||||
|
||||
### 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
|
||||
---|---|---|---
|
||||
Maintained by CAOS | yes | yes, product only | no
|
||||
24x7 monitoring | yes | yes, product only | yes, product only
|
||||
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
|
||||
|
||||
|
||||
@@ -33,5 +33,5 @@ For our API rate limits please check the [API Endpoint Rate Limits](/docs/apis/r
|
||||
|
||||
## 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.
|
||||
|
||||
@@ -29,7 +29,7 @@ You can find out how to register OTP [here](./user-factors).
|
||||
|
||||
### 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.)
|
||||
|
||||
|
||||
@@ -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.
|
||||
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.
|
||||
|
||||
### Redirect URLs
|
||||
|
||||
4
docs/static/security.txt
vendored
4
docs/static/security.txt
vendored
@@ -1,4 +1,4 @@
|
||||
Contact: mailto:security@zitadel.ch
|
||||
Contact: mailto:security@zitadel.com
|
||||
Expires: Fri, 31 Dec 2021 23:00 +0200
|
||||
Preferred-Languages: en, de
|
||||
Canonical: https://docs.zitadel.ch/security.txt
|
||||
Canonical: https://docs.zitadel.com/security.txt
|
||||
Reference in New Issue
Block a user