mirror of
https://github.com/zitadel/zitadel.git
synced 2025-10-21 09:40:49 +00:00
chore(documentation): documentation and manuals for ZITADEL (#710)
* chore: cleanup old docs folder * remove docs path trigger * wip docs structure * chore: ignore site changes in ci * add manuals route * new structure * structure * Use correct title * remove trigger for code scan for static site generator * change names * add lorem ipsum to test styling * use h3 to deeplink * add site to dependabot * lint readme.md * remove not needed file * ignore site on pull request code scan * add initial contrib * Minor correction * Added section Developer & Integration * Changed link list layout, added labels, added translations * Added missing <li> tags * Added correct link to section Developer & Integration * Fixing list style * Overhauling description texts and translations * outline * teaser go * outline * wip * rework * wip * wip * wip * hop * wip * first draft for "administrate" done * init outline * fix deploy step * lint * commit wip * commit wip * md lint * Link * fix: path to edit (#711) * wip * wip * wip * what are... * use only features * wip docs * Update 00-user.en.md * project * uppercase en * wip * wip * wip * policies rework * improve text * correct typo * update readme * correct styling * add link to docs guides * make the linter happy * rename * wip * move api to own file * correct links and lint * wip roles and integration * add pkce * reduce padding and margin * wip scope and claims * wip claim & scopes * make the linter happy * insert links where possible * wip * wip roles & providers * Update README.md * Update 00-user.en.md * minor text improvements * use master branch to deploy * use proper ci file * Apply suggestions from code review Co-authored-by: Fabi <38692350+fgerschwiler@users.noreply.github.com> Co-authored-by: Matthias M. Schneider <mati@matimax.info> Co-authored-by: Max Peintner <max@caos.ch> Co-authored-by: Fabi <38692350+fgerschwiler@users.noreply.github.com>
This commit is contained in:
Florian Forster
6
site/docs/develop/00-overview.de.md
Normal file
6
site/docs/develop/00-overview.de.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Übersicht
|
||||
description: …
|
||||
---
|
||||
|
||||
> This Language is not yet translated. Please consult the English version.
|
||||
36
site/docs/develop/00-overview.en.md
Normal file
36
site/docs/develop/00-overview.en.md
Normal file
@@ -0,0 +1,36 @@
|
||||
---
|
||||
title: Overview
|
||||
description: …
|
||||
---
|
||||
|
||||
> All documentations are under active work and subject to change soon!
|
||||
|
||||
### APIs
|
||||
|
||||
ZITADEL provides three API's for different use cases. These API's are built with GRPC and then generate a REST service.
|
||||
Each services proto definition is located in the source control on GitHub.
|
||||
As we generate the REST services and Swagger file out of the proto definition we recommend that you rely on the proto file.
|
||||
We annotate the corresponding REST methods on each possible call as well as the AuthN and AuthZ requirements.
|
||||
|
||||
See below for an example with the call **GetMyUser**.
|
||||
|
||||
```Go
|
||||
//User
|
||||
rpc GetMyUser(google.protobuf.Empty) returns (UserView) {
|
||||
option (google.api.http) = {
|
||||
get: "/users/me"
|
||||
};
|
||||
|
||||
option (caos.zitadel.utils.v1.auth_option) = {
|
||||
permission: "authenticated"
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
As you can see the `GetMyUser` function is also available as REST service under the path `/users/me`.
|
||||
In the table below you can see the URI of those calls.
|
||||
|
||||
| Service | URI |
|
||||
|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| REST | [https://api.zitadel.ch/auth/v1/users/me](https://api.zitadel.ch/auth/v1/users/me) |
|
||||
| GRPC | [https://api.zitadel.ch/caos.zitadel.auth.api.v1.AuthService/GetMyUser](https://api.zitadel.ch/caos.zitadel.auth.api.v1.AuthService/GetMyUser) |
|
||||
6
site/docs/develop/01-authentication.de.md
Normal file
6
site/docs/develop/01-authentication.de.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Authentication API
|
||||
description: …
|
||||
---
|
||||
|
||||
> This Language is not yet translated. Please consult the English version.
|
||||
18
site/docs/develop/01-authentication.en.md
Normal file
18
site/docs/develop/01-authentication.en.md
Normal file
@@ -0,0 +1,18 @@
|
||||
---
|
||||
title: Authentication API
|
||||
description: …
|
||||
---
|
||||
|
||||
### Authentication aka Auth
|
||||
|
||||
The authentication API (aka Auth API) is used for all operations on the currently logged in user.
|
||||
|
||||
| Service | URI |
|
||||
|:--------|:----------------------------------------------------------------------------------------------------------------------------|
|
||||
| REST | [https://api.zitadel.ch/auth/v1/](https://api.zitadel.ch/auth/v1/) |
|
||||
| GRPC | [https://api.zitadel.ch/caos.zitadel.auth.api.v1.AuthService/](https://api.zitadel.ch/caos.zitadel.auth.api.v1.AuthService) |
|
||||
|
||||
> At a later date we might expose functions to build your own login GUI
|
||||
> You can build your own user Register GUI already by utilizing the [Management API](#management)
|
||||
|
||||
[Latest API Version](https://github.com/caos/zitadel/blob/master/pkg/grpc/auth/proto/auth.proto)
|
||||
6
site/docs/develop/02-management.de.md
Normal file
6
site/docs/develop/02-management.de.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Management API
|
||||
description: …
|
||||
---
|
||||
|
||||
> This Language is not yet translated. Please consult the English version.
|
||||
15
site/docs/develop/02-management.en.md
Normal file
15
site/docs/develop/02-management.en.md
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: Management API
|
||||
description: …
|
||||
---
|
||||
|
||||
### Management
|
||||
|
||||
The management API is as the name states the interface where systems can mutate IAM objects like, organisations, projects, clients, user and so on if they have the necessary access rights.
|
||||
|
||||
| Service | URI |
|
||||
|:--------|:----------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| REST | [https://api.zitadel.ch/management/v1/](https://api.zitadel.ch/management/v1/) |
|
||||
| GRPC | [https://api.zitadel.ch/caos.zitadel.management.api.v1.ManagementService/](https://api.zitadel.ch/caos.zitadel.management.api.v1.ManagementService) |
|
||||
|
||||
[Latest API Version](https://github.com/caos/zitadel/blob/master/pkg/grpc/management/proto/management.proto)
|
||||
6
site/docs/develop/03-administration.de.md
Normal file
6
site/docs/develop/03-administration.de.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Admin API
|
||||
description: …
|
||||
---
|
||||
|
||||
> This Language is not yet translated. Please consult the English version.
|
||||
15
site/docs/develop/03-administration.en.md
Normal file
15
site/docs/develop/03-administration.en.md
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: Admin API
|
||||
description: …
|
||||
---
|
||||
|
||||
### Administration aka Admin
|
||||
|
||||
This API is intended to configure and manage the IAM itself.
|
||||
|
||||
| Service | URI |
|
||||
|:--------|:--------------------------------------------------------------------------------------------------------------------------------|
|
||||
| REST | [https://api.zitadel.ch/admin/v1/](https://api.zitadel.ch/admin/v1/) |
|
||||
| GRPC | [https://api.zitadel.ch/caos.zitadel.admin.api.v1.AdminService/](https://api.zitadel.ch/caos.zitadel.admin.api.v1.AdminService) |
|
||||
|
||||
[Latest API Version](https://github.com/caos/zitadel/blob/master/pkg/grpc/admin/proto/admin.proto)
|
||||
Reference in New Issue
Block a user