TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-04-16 01:41:30 +00:00
Code Issues Packages Projects Releases Wiki Activity
zitadel/docs/docs/apis/apis.md
Fabi c223a9ed61
docs: access zitadel apis (#1627) 
* doc: access zitadel apis

* doc: access zitadel apis

* doc: swagger
2021-04-20 21:37:30 +02:00

3.1 KiB
Raw Blame History

title
ZITADEL APIs

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 API 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/
GRPC 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

Latest API Version

Management API

The management API is as the name states the interface where systems can mutate IAM objects like, organisations, projects, clients, users and so on if they have the necessary access rights.

Service URI
REST https://api.zitadel.ch/management/v1/
GRPC https://api.zitadel.ch/caos.zitadel.management.api.v1.ManagementService/

Latest API Version

Administration API aka Admin

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

Service URI
REST https://api.zitadel.ch/admin/v1/
GRPC https://api.zitadel.ch/caos.zitadel.admin.api.v1.AdminService/

[Latest