docs: improve api docs (#5158)

* integrate docs into nav * generator for local use, production needs to be set by env * fix typo * local dev * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: add header params * rewrite docs links and improve ci * tweak build command * fix path * Update docs/docusaurus.config.js Co-authored-by: Max Peintner <[email protected]> * fix docker * docs: add header params * docs: Add tags to management api. add some descriptions * docs: more descriptions * docs: more descriptions * docs: required fields * docs: example request * docs: example request * docs: example request * docs: example request * docs: example request * docs: user metadata requests * docs: user requests * docs: user requests * docs: user requests * docs: user requests * docs: change nav add first methods to authentication api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: api sidenav * chore: use buf without docker * fix deploy * fix ci * fix vercel * docs: admin * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: security * docs: security * docs: admin api * docs: change to env vars * docs: auth api * docs: remove assets, deprecated requests, menu * reworked page with PaloAltoNetworks/docusaurus-openapi-docs * works with the resolutions * fix broken build by adding assets again * add tags to menu * chore: improve build speed * no-minify * test ssr * ssr 20 * use lazy * increase mem * use default mem * change names * docs: remove assets, deprecated requests, menu * docs: management api * docs: management api * docs: management api * docs: sidebar * not the best word smithing but it is ;-) * more typos * merge main * fix some error * trial * update grpc gateway * trigger vercel build * docs: deprecated requests * docs: deprecated requests --------- Co-authored-by: Fabienne <[email protected]> Co-authored-by: Max Peintner <[email protected]>
2026-11-13 17:35:12 +00:00 · 2023-02-23 18:08:06 +07:00
parent 50728129ee
commit aa9518ac02
68 changed files with 7570 additions and 23543 deletions
@@ -145,7 +145,7 @@ You should get a successful response with a `totalResult` number of 1 and the de
 }
 ```

-With this token you are allowed to access the whole [ZITADEL System API](../../apis/proto/system).
+With this token you are allowed to access the whole [ZITADEL System API](../../apis/system).

 ## Summary

@@ -11,7 +11,7 @@ You need to give a user the [manager role](https://zitadel.com/docs/guides/manag
 If you like to know more about eventsourcing/eventstore and how this works in ZITADEL, head over to our [concepts](../../concepts/eventstore/overview).
 ## Request Events

-Call the [ListEvents](../../apis/proto/admin#listevents) enpoint in the Administration API to get all the events you need.
+Call the [ListEvents](../../apis/admin) enpoint in the Administration API to get all the events you need.
 To further restrict your result you can add the following filters:
 - sequence
 - editor user id
@@ -29,7 +29,7 @@ curl --request POST \

 ## Get event types

-To be able to filter for the different event types ZITADEL knows, you can request the [EventTypesList](../../apis/proto/admin#listeventtypes)
+To be able to filter for the different event types ZITADEL knows, you can request the [EventTypesList](../../apis/admin)

 ```bash
 curl --request POST \
@@ -65,7 +65,7 @@ The following example shows you the event types for a password check (failed/suc

 ## Get aggregate types

-To be able to filter for the different aggregate types (resources) ZITADEL knows, you can request the [AggregateTypesList](../../apis/proto/admin#listaggregatetypes)
+To be able to filter for the different aggregate types (resources) ZITADEL knows, you can request the [AggregateTypesList](../../apis/admin)

 ```bash
 curl --request POST \
@@ -5,7 +5,7 @@ title: Register and Create User
 The ZITADEL API has different possibilities to create users.
 This can be used, if you are building your own registration page.

-[Import Human User](../../../apis/proto/management#importhumanuser)
+[Import Human User](../../../apis/mgmt)

 ## With Username and Password

@@ -28,9 +28,9 @@ If nothing is requested, the type will not be restricted and all possibilities o

 ### Add passwordless to existing user

-If you already have a user in ZITADEL, it is possible to add passworless later.
+If you already have a user in ZITADEL, it is possible to add passwordless later.

-[Add Passwordless Registration ](../../../apis/proto/management#addpasswordlessregistration)
+[Add Passwordless Registration ](../../../apis/mgmt)

 Send the user_id in the request and you will get a link and an expiration as response.
 You can then customize the link the same as described above in the creation process.
@@ -38,6 +38,4 @@ You can then customize the link the same as described above in the creation proc
 The second possibility is to send the link directly to the user per email.
 Use the following request in that case:

-[Send Passwordless Registration ](../../../apis/proto/management#sendpasswordlessregistration)
-
-
+[Send Passwordless Registration ](../../../apis/mgmt)
@@ -29,7 +29,7 @@ You can read more about how ZITADEL handles usernames [here](../manage/console/o
 ZITADEL gives you a basic storage for users and manages phone and email addresses. It also allows you to store your own application data such as preferences or external identifiers to the metadata of a user.

 If you are migrating an existing project and you already have an external identity store you can consider bulk importing your user datasets.
-Read our [Management API definitions](../../apis/proto/management#importhumanuser) for more info. If the users email is not verified or no password is set, a initialization mail will be send.
+Read our [Management API definitions](../../apis/mgmt) for more info. If the users email is not verified or no password is set, a initialization mail will be send.

 :::info
 Requests to the management API are rate limited. Read our [Rate limit Policy](../../legal/rate-limit-policy) for more info.