TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-02-28 23:47:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update api introduction (#3781)

Browse Source
This commit is contained in:
Livio Spring 2022-06-21 10:03:30 +02:00 committed by GitHub
parent c2e0c8c37c
commit 1daa924fa3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -21,7 +21,8 @@ All of our APIs are generated by proto definitions. You can find all the proto d
### Swagger Documentation ### 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/) The easiest way to have a look at them is, to import them in the [Swagger Editor](https://editor.swagger.io/)
<ApiCard title="Authentication" type="AUTH"> <ApiCard title="Authentication" type="AUTH">
@ -38,7 +39,7 @@ The authentication API (aka Auth API) is used for all operations on the currentl
### GRPC ### GRPC
Endpoint: 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: Definition:
[Auth Proto](/docs/apis/proto/auth) [Auth Proto](/docs/apis/proto/auth)
@ -46,13 +47,13 @@ Definition:
### REST ### REST
Endpoint: Endpoint:
[https://api.zitadel.ch/auth/v1/](https://api.zitadel.ch/auth/v1/) {your_domain}/auth/v1/
Swagger Editor: 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: Definition:
[Swagger Definition](https://api.zitadel.ch/openapi/v2/swagger/auth.swagger.json) [Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/auth.swagger.json)
</div> </div>
</Column> </Column>
@ -74,7 +75,7 @@ To identify the current organization you can send a header `x-zitadel-orgid` or
### GRPC ### GRPC
Endpoint: 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: Definition:
[Management Proto](/docs/apis/proto/management) [Management Proto](/docs/apis/proto/management)
@ -82,13 +83,13 @@ Definition:
### REST ### REST
Endpoint: Endpoint:
[https://api.zitadel.ch/management/v1/](https://api.zitadel.ch/management/v1/) {your_domain}/management/v1/
Swagger Editor: 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: Definition:
[Swagger Definition](https://api.zitadel.ch/openapi/v2/swagger/management.swagger.json) [Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/management.swagger.json)
</div> </div>
</Column> </Column>
@ -108,7 +109,7 @@ This API is intended to configure and manage one ZITADEL instance itself.
### GRPC ### GRPC
Endpoint: 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: Definition:
[Admin Proto](/docs/apis/proto/admin) [Admin Proto](/docs/apis/proto/admin)
@ -116,13 +117,13 @@ Definition:
### REST ### REST
Endpoint: Endpoint:
[https://api.zitadel.ch/admin/v1/](https://api.zitadel.ch/admin/v1/) {your_domain}/admin/v1/
Swagger Editor: 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: Definition:
[Swagger Definition](https://api.zitadel.ch/openapi/v2/swagger/admin.swagger.json) [Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/admin.swagger.json)
</div> </div>
</Column> </Column>
@ -142,7 +143,7 @@ This API is intended to manage the different ZITADEL instances within the system
### GRPC ### GRPC
Endpoint: 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: Definition:
[System Proto](/docs/apis/proto/system) [System Proto](/docs/apis/proto/system)
@ -150,13 +151,13 @@ Definition:
### REST ### REST
Endpoint: Endpoint:
[https://api.zitadel.ch/system/v1/](https://api.zitadel.ch/system/v1/) {your_domain}/system/v1/
Swagger Editor: 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: Definition:
[Swagger Definition](https://api.zitadel.ch/openapi/v2/swagger/system.swagger.json) [Swagger Definition](https://zitadel.cloud/openapi/v2/swagger/system.swagger.json)
</div> </div>
</Column> </Column>
@ -176,7 +177,7 @@ The Assets API allows you to up- and download all kinds of assets. This can be f
### REST ### REST
Endpoint: Endpoint:
[https://api.zitadel.ch/assets/v1/](https://api.zitadel.ch/assets/v1/) {your_domain}/assets/v1/
Definition: Definition:
[Assets](./assets/assets.md) [Assets](./assets/assets.md)
@ -213,10 +214,11 @@ In the table below you can see the URI of those calls.
## Domains ## Domains
| Domain Name | Example | Description | ZITADEL hosts everything under a single domain: `{instance}.zitadel.cloud` or your custom domain `{your_domain}`
| :---------- | :-------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| base_url | `{instance}.zitadel.cloud` or custom domain {your_domain} | ZITADEL has only one url, the different apis will be found under different paths. | :::note
| issuer | `issuer.zitadel.ch` | Provides the [OpenID Connect 1.0 Discovery Endpoint](openidoauth/endpoints#openid-connect-10-discovery) | Changes from ZITADEL V1:
| api | `{base_rul}/api` | All ZITADEL API's are located under this domain. | Be aware that issuer, api, accounts and console domains do not exist anymore.
| 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 |
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/`.