TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2024-12-12 11:04:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
9f0638fac9
zitadel/site/docs/develop/00-overview.en.md
Florian Forster 9f0638fac9
chore: spell check automation and spellcheck (#889) 
* test spell check

* fix indenting

* test

* add something to test

* test spellcheck

* spelling improvements

* improve spelling and ignore list

* Update site/docs/start/00-quick-start.de.md
2020-10-26 13:54:29 +01:00

1.6 KiB
Raw Blame History

title description
Overview …

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 service's 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.

  //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 a 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
GRPC https://api.zitadel.ch/caos.zitadel.auth.api.v1.AuthService/GetMyUser