From 1daa924fa3f74d6282db2876515b879923e1e07c Mon Sep 17 00:00:00 2001 From: Livio Spring Date: Tue, 21 Jun 2022 10:03:30 +0200 Subject: [PATCH] docs: update api introduction (#3781) --- docs/docs/apis/introduction.mdx | 52 +++++++++++++++++---------------- 1 file changed, 27 insertions(+), 25 deletions(-) diff --git a/docs/docs/apis/introduction.mdx b/docs/docs/apis/introduction.mdx index ba489579dd..ad71667ace 100644 --- a/docs/docs/apis/introduction.mdx +++ b/docs/docs/apis/introduction.mdx @@ -21,7 +21,8 @@ All of our APIs are generated by proto definitions. You can find all the proto d ### Swagger Documentation -We provide some json files for the swagger documentation of our APIs with the following link: [https://api.zitadel.ch/openapi/v2/swagger/](https://api.zitadel.ch/openapi/v2/swagger/) +We provide some json files for the swagger documentation of our APIs with the following link: [https://zitadel.cloud/openapi/v2/swagger/](https://zitadel.cloud/openapi/v2/swagger/) + The easiest way to have a look at them is, to import them in the [Swagger Editor](https://editor.swagger.io/) @@ -38,7 +39,7 @@ The authentication API (aka Auth API) is used for all operations on the currentl ### GRPC Endpoint: -[https://api.zitadel.ch/caos.zitadel.auth.api.v1.AuthService/](https://api.zitadel.ch/caos.zitadel.auth.api.v1.AuthService) +{your_domain}/caos.zitadel.auth.api.v1.AuthService/ Definition: [Auth Proto](/docs/apis/proto/auth) @@ -46,13 +47,13 @@ Definition: ### REST Endpoint: -[https://api.zitadel.ch/auth/v1/](https://api.zitadel.ch/auth/v1/) +{your_domain}/auth/v1/ Swagger Editor: -[editor.swagger.io](https://editor.swagger.io/?url=https://api.zitadel.ch/openapi/v2/swagger/auth.swagger.json) +[editor.swagger.io](https://editor.swagger.io/?url=https://zitadel.cloud/openapi/v2/swagger/auth.swagger.json) Definition: -[Swagger Definition](https://api.zitadel.ch/openapi/v2/swagger/auth.swagger.json) +[Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/auth.swagger.json) @@ -74,7 +75,7 @@ To identify the current organization you can send a header `x-zitadel-orgid` or ### GRPC Endpoint: -[https://api.zitadel.ch/caos.zitadel.management.api.v1.ManagementService/](https://api.zitadel.ch/caos.zitadel.management.api.v1.ManagementService) +{your_domain}/caos.zitadel.management.api.v1.ManagementService/ Definition: [Management Proto](/docs/apis/proto/management) @@ -82,13 +83,13 @@ Definition: ### REST Endpoint: -[https://api.zitadel.ch/management/v1/](https://api.zitadel.ch/management/v1/) +{your_domain}/management/v1/ Swagger Editor: -[editor.swagger.io](https://editor.swagger.io/?url=https://api.zitadel.ch/openapi/v2/swagger/management.swagger.json) +[editor.swagger.io](https://editor.swagger.io/?url=https://zitadel.cloud/openapi/v2/swagger/management.swagger.json) Definition: -[Swagger Definition](https://api.zitadel.ch/openapi/v2/swagger/management.swagger.json) +[Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/management.swagger.json) @@ -108,7 +109,7 @@ This API is intended to configure and manage one ZITADEL instance itself. ### GRPC Endpoint: -[https://api.zitadel.ch/caos.zitadel.admin.api.v1.AdminService/](https://api.zitadel.ch/caos.zitadel.admin.api.v1.AdminService) +{your_domain}/caos.zitadel.admin.api.v1.AdminService/ Definition: [Admin Proto](/docs/apis/proto/admin) @@ -116,13 +117,13 @@ Definition: ### REST Endpoint: -[https://api.zitadel.ch/admin/v1/](https://api.zitadel.ch/admin/v1/) +{your_domain}/admin/v1/ Swagger Editor: -[editor.swagger.io](https://editor.swagger.io/?url=https://api.zitadel.ch/openapi/v2/swagger/admin.swagger.json) +[editor.swagger.io](https://editor.swagger.io/?url=https://zitadel.cloud/openapi/v2/swagger/admin.swagger.json) Definition: -[Swagger Definition](https://api.zitadel.ch/openapi/v2/swagger/admin.swagger.json) +[Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/admin.swagger.json) @@ -142,7 +143,7 @@ This API is intended to manage the different ZITADEL instances within the system ### GRPC Endpoint: -[https://api.zitadel.ch/caos.zitadel.system.api.v1.SystemService/](https://api.zitadel.ch/caos.zitadel.system.api.v1.SystemService) +{your_domain}/caos.zitadel.system.api.v1.SystemService/ Definition: [System Proto](/docs/apis/proto/system) @@ -150,13 +151,13 @@ Definition: ### REST Endpoint: -[https://api.zitadel.ch/system/v1/](https://api.zitadel.ch/system/v1/) +{your_domain}/system/v1/ Swagger Editor: -[editor.swagger.io](https://editor.swagger.io/?url=https://api.zitadel.ch/openapi/v2/swagger/admin.swagger.json) +[editor.swagger.io](https://editor.swagger.io/?url=https://zitadel.cloud/openapi/v2/swagger/admin.swagger.json) Definition: -[Swagger Definition](https://api.zitadel.ch/openapi/v2/swagger/system.swagger.json) +[Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/system.swagger.json) @@ -176,7 +177,7 @@ The Assets API allows you to up- and download all kinds of assets. This can be f ### REST Endpoint: -[https://api.zitadel.ch/assets/v1/](https://api.zitadel.ch/assets/v1/) +{your_domain}/assets/v1/ Definition: [Assets](./assets/assets.md) @@ -213,10 +214,11 @@ In the table below you can see the URI of those calls. ## Domains -| Domain Name | Example | Description | -| :---------- | :-------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| base_url | `{instance}.zitadel.cloud` or custom domain {your_domain} | ZITADEL has only one url, the different apis will be found under different paths. | -| issuer | `issuer.zitadel.ch` | Provides the [OpenID Connect 1.0 Discovery Endpoint](openidoauth/endpoints#openid-connect-10-discovery) | -| api | `{base_rul}/api` | All ZITADEL API's are located under this domain. | -| login | `{base_url}/ui/login` | The accounts.\* page provides server renderer pages like login and register and as well the authorization_endpoint for OpenID Connect | -| console | `{base_url}/ui/console` | With the console.\* domain we serve the assets for the management gui | +ZITADEL hosts everything under a single domain: `{instance}.zitadel.cloud` or your custom domain `{your_domain}` + +:::note +Changes from ZITADEL V1: +Be aware that issuer, api, accounts and console domains do not exist anymore. +::: + +The domain is used as the OIDC issuer and as the base url for the gRPC and REST APIs, the Login and Console UI, which you'll find under `{your_domain}/ui/console/`.