2020-10-16 14:13:02 +02:00
|
|
|
---
|
|
|
|
title: Overview
|
|
|
|
description: …
|
|
|
|
---
|
|
|
|
|
feat: docs rehaul, fix missing context in console, quickstarts (#1212)
* onboarding components, routing, steps
* onboarding component, toc
* fix onboarding mixin
* header
* refactor docs
* fix layout
* cleanup routing
* docs routing
* fix conventions
* de en routing
* docs, guide contents, nav
* rem i18n support
* fix routing from docs
* rollup onwarn changes, preload
* update svelte plugin, update rollup config
* move docs
* revert img style, remove code table
* rem de completely
* rollup optim, template
* angular quickstart, quickstart overview page, update deps
* fix link
* pack, slug
* prefetch binding, hidden links
* export log
* guards route ch
* fix homepage
* angular docs
* docs
* resolve fsh
* overview
* docs
* docs
* packages fix race condition
* nav, home link
* add vue, aspnet
* doc optimizations
* embed status pal
* angular guide
* angular guide
* dotnet, angular guide
* viewbox
* typo
* block onboarding route for non iam writers
* set links from component data
* fix: fetch org context in guard, more main cnt (#1192)
* change get started guide, fix code blockquotes, typos
* flutter guide
* h2 spacing
* highlight strong
* plus
* rm start sublinks
* add proxy quickstart
* regex
* prevent outside click, fix project grant write
Co-authored-by: Florian Forster <florian@caos.ch>
Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2021-02-16 16:59:18 +01:00
|
|
|
<i class="las la-code" style="font-size: 100px; height: 100px; color:#6c8eef" ></i>
|
|
|
|
|
2020-10-16 14:13:02 +02:00
|
|
|
> All documentations are under active work and subject to change soon!
|
|
|
|
|
|
|
|
### APIs
|
|
|
|
|
2020-10-26 13:03:51 +01:00
|
|
|
---
|
|
|
|
|
2020-10-16 14:13:02 +02:00
|
|
|
ZITADEL provides three API's for different use cases. These API's are built with GRPC and then generate a REST service.
|
2020-10-26 13:54:29 +01:00
|
|
|
Each service's proto definition is located in the source control on GitHub.
|
2020-10-16 14:13:02 +02:00
|
|
|
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"
|
|
|
|
};
|
|
|
|
}
|
|
|
|
```
|
2020-10-26 13:03:51 +01:00
|
|
|
---
|
|
|
|
|
2020-10-26 13:54:29 +01:00
|
|
|
As you can see the `GetMyUser` function is also available as a REST service under the path `/users/me`.
|
|
|
|
|
2020-10-16 14:13:02 +02:00
|
|
|
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) |
|