Skip to main content

Overview

APIs#

ZITADEL provides four APIs for different use cases. Three of these APIs are built with GRPC and 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 ZITADEL uses multipart form data for certain elements.

Proto#

All of our APIs are generated by proto defintions. You can find all the proto definitions in the Proto API Definitions.

More about Protocol Buffer

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/ The easiest way to have a look at them is, to import them in the Swagger Editor

Authentication#

The authentication API (aka Auth API) is used for all operations on the currently logged in user. The user id is taken from the sub claim in the token.

Management#

The management API is as the name states the interface where systems can mutate IAM objects like, organizations, projects, clients, users and so on if they have the necessary access rights. To identify the current organization you can send a header x-zitadel-orgid or if no header is set, the organization of the authenticated user is set.

Administration#

This API is intended to configure and manage the IAM itself.

Assets#

The Assets API allows you to up- and download all kinds of assets. This can be files such as logos, fonts or user avatar.

Example#

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

Domains#

Domain NameExampleDescription
issuerissuer.zitadel.chProvides the OpenID Connect 1.0 Discovery Endpoint
apiapi.zitadel.chAll ZITADEL API's are located under this domain.
loginaccounts.zitadel.chThe accounts.* page provides server renderer pages like login and register and as well the authorization_endpoint for OpenID Connect
consoleconsole.zitadel.chWith the console.* domain we serve the assets for the management gui