TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-12-05 10:52:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): fix links for domain migration (#4831)

Browse Source 
* chore(docs): fix links for domain migration

* try trailing slash for netlify

* trial

* fix typo

* test path

* try preview proxied

* test local proxy

* try to define the domain with redirect to /docs

* remove build commands

* debug netlify router and fix image link

* working config

* fix analytics
This commit is contained in:
Florian Forster
2022-12-06 20:33:13 +01:00
committed by GitHub
parent 3539418a4a
commit 065250a108
49 changed files with 210 additions and 201 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs/apis/introduction.mdx
View File

@@ -42,7 +42,7 @@ Endpoint:
{your_domain}/zitadel.auth.v1.AuthService/
Definition:
[Auth Proto](/docs/apis/proto/auth)
[Auth Proto](/apis/proto/auth)
### REST
@@ -78,7 +78,7 @@ Endpoint:
{your_domain}/zitadel.management.v1.ManagementService/
Definition:
[Management Proto](/docs/apis/proto/management)
[Management Proto](/apis/proto/management)
### REST
@@ -112,7 +112,7 @@ Endpoint:
{your_domain}/zitadel.admin.v1.AdminService/
Definition:
[Admin Proto](/docs/apis/proto/admin)
[Admin Proto](/apis/proto/admin)
### REST
@@ -137,7 +137,7 @@ Definition:
This API is intended to manage the different ZITADEL instances within the system.
Checkout the guide how to [access the ZITADEL System API](/docs/guides/integrate/access-zitadel-system-api).
Checkout the guide how to [access the ZITADEL System API](/guides/integrate/access-zitadel-system-api).
</div>
<div className="apicard-right">
@@ -148,7 +148,7 @@ Endpoint:
{your_domain}/zitadel.system.v1.SystemService/
Definition:
[System Proto](/docs/apis/proto/system)
[System Proto](/apis/proto/system)
### REST

24
docs/docs/apis/openidoauth/authrequest.mdx
View File

@@ -20,7 +20,7 @@ This playground should help you to initially craft an authentication request and
## Request parameters explained
Not all request parameters are available in the playground. Please refer to the full documentation of the [authorization endpoint](/docs/apis/openidoauth/endpoints#authorization_endpoint).
Not all request parameters are available in the playground. Please refer to the full documentation of the [authorization endpoint](/apis/openidoauth/endpoints#authorization_endpoint).
### Your Domain
@@ -47,7 +47,7 @@ The <span className="text-yellow-500">Instance Domain</span> to your ZITADEL ins
need code.
</p>
More in the <a href="/docs/apis/openidoauth/endpoints#required-request-parameters">documentation</a> about required Parameters.
More in the <a href="/apis/openidoauth/endpoints#required-request-parameters">documentation</a> about required Parameters.
### Authentication methods
@@ -57,9 +57,9 @@ Depending on the authentication and authorization flow of your application you m
for most application types. The playground appends automatically a code challenge
for PKCE flows.
You need to append a "Code Challenge" by providing a random <span className="text-teal-600">Code Verifier</span> that is being hashed and encoded in the request to the token endpoint, please see our [guide](/docs/guides/integrate/login-users#token-request) for more details.
You need to append a "Code Challenge" by providing a random <span className="text-teal-600">Code Verifier</span> that is being hashed and encoded in the request to the token endpoint, please see our [guide](/guides/integrate/login-users#token-request) for more details.
More in the [documentation](/docs/apis/openidoauth/authn-methods) about authentication methods.
More in the [documentation](/apis/openidoauth/authn-methods) about authentication methods.
### Additional Parameters
@@ -76,7 +76,7 @@ More in the [documentation](/docs/apis/openidoauth/authn-methods) about authenti
of a user. You can skip the account picker by providing the Login hint.
</p>
There are many more additional parameters. Please refer to the [documentation](/docs/apis/openidoauth/endpoints#additional-parameters) about additional parameters.
There are many more additional parameters. Please refer to the [documentation](/apis/openidoauth/endpoints#additional-parameters) about additional parameters.
## Standard Scopes
@@ -84,32 +84,32 @@ Used to request additional information from ZITADEL.
These scopes are defined in the OpenID Connect specification.
The `openid` scope is mandatory.
Not all scopes are available in the playground. Please refer to the full [documentation](/docs/apis/openidoauth/scopes) for the exhaustive list of available standard and reserved scopes.
Not all scopes are available in the playground. Please refer to the full [documentation](/apis/openidoauth/scopes) for the exhaustive list of available standard and reserved scopes.
## Reserved Scopes
You can request additional information that is specific to ZITADEL or customize the behavior of ZITADEL by including reserved scopes.
Please refer to the [documentation](/docs/apis/openidoauth/scopes#reserved-scopes) for a full list of available reserved scopes.
Please refer to the [documentation](/apis/openidoauth/scopes#reserved-scopes) for a full list of available reserved scopes.
### Organization policies and branding
Enforce an organization's policies and branding as well as membership of the user by passing the scope `urn:zitadel:iam:org:id:{id}` with the required <span className="text-purple-500">Organization ID</span>.
Please refer to the full [guide on branding](/docs/guides/manage/customize/branding).
Please refer to the full [guide on branding](/guides/manage/customize/branding).
### Get user metadata
Pass the scope `urn:zitadel:iam:user:metadata` to request a user's metadata.
Please refer to the full [guide on user-metadata](/docs/guides/manage/customize/user-metadata) for further details.
Please refer to the full [guide on user-metadata](/guides/manage/customize/user-metadata) for further details.
### Access core apis
Calling the [core API](/docs/apis/introduction) with the authenticated user, requires that the projectID of ZITADEL is included in the audience claim.
Calling the [core API](/apis/introduction) with the authenticated user, requires that the projectID of ZITADEL is included in the audience claim.
This can be achieved by adding the scope `urn:zitadel:iam:org:project:id:zitadel:aud` to your applications authorization request.
## How to use ZITADEL in your project
Please refer to our [guide](/docs/guides/integrate/login-users) on how to login users.
Please refer to our [guide](/guides/integrate/login-users) on how to login users.
OpenID Connect certified libraries should allow you to customize the parameters and define scopes for the authorization request. You can also continue by using one of our [example applications](/docs/examples/introduction).
OpenID Connect certified libraries should allow you to customize the parameters and define scopes for the authorization request. You can also continue by using one of our [example applications](/examples/introduction).

2
docs/docs/apis/ratelimits/ratelimits.md
View File

@@ -2,7 +2,7 @@
title: ZITADEL Cloud Rate Limits
---
Rate limits are implemented according to our [rate limit policy](/docs/legal/rate-limit-policy.md) with the following rules:
Rate limits are implemented according to our [rate limit policy](/legal/rate-limit-policy.md) with the following rules:
| Path | Description | Throttling | One Minute Banning |
|--------------------------|----------------------------------------|--------------------------------------|----------------------------------------|