Skip to main content

Introduction

APIs#


ZITADEL provides four API's for different use cases. Three 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. The last API (assets) is only a REST API because we use multipart form data.

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.

ServiceURI
RESThttps://api.zitadel.ch/auth/v1/users/me
GRPChttps://api.zitadel.ch/caos.zitadel.auth.api.v1.AuthService/GetMyUser