TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-12-26 00:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update api intro and postman collection (#10786)

Browse Source 
This PR removes the outdated swagger section and add a reference to the
Postman collection we recently published.
This commit is contained in:
Federico Coppede
2025-09-26 19:04:02 -03:00
committed by GitHub
parent de0667bb24
commit 096eb4fd91
1 changed files with 19 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/docs/apis/introduction.mdx
View File

@@ -242,12 +242,6 @@ All of our APIs are generated by proto definitions. You can find all the proto d
> More about [Protocol Buffer](https://developers.google.com/protocol-buffers)
### Swagger documentation
We provide some json files for the swagger documentation of our APIs with the following link: [https://zitadel.cloud/openapi/v2/swagger/](https://zitadel.cloud/openapi/v2/swagger/)
The easiest way to have a look at them is, to import them in the [Swagger Editor](https://editor.swagger.io/)
### Example
See below for an example with the call **GetMyUser**.
@@ -318,3 +312,22 @@ For easy copying to your reverse proxy configuration, here is the list of URL pa
/zitadel.oidc.v2.OIDCService/
/zitadel.org.v2.OrganizationService/
```
## Postman Collection (Beta)
We published an official Postman collection to help you explore and test the ZITADEL APIs.
The collection is organized by services, and includes a script to automatically authenticate requests. Before using it, make sure to configure the required environment variables in Postman:
| Variable Name | Description |
|-------------------------|-------------|
| `protocol` | **http** for local testing, or **https** for cloud/self hosted instances |
| `custom_domain` | The domain of your Zitadel instance. |
| `service_client_id` | Client ID of service account with **IAM_OWNER** role in your Zitadel instance. |
| `service_client_secret` | Client secret for the service account. |
| `api_client_id` | Client ID of an API application. |
| `api_client_secret` | Client secret for the API application. |
| `project_id` | A project ID within your Zitadel instance. |
[Fork the Postman Collection](https://app.getpostman.com/run-collection/44392838-6417c238-b9b9-4334-bef0-233ae38cbc51?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D44392838-6417c238-b9b9-4334-bef0-233ae38cbc51%26entityType%3Dcollection%26workspaceId%3D54ef8cdd-5ea3-4f31-89f6-20720b45528c)
This release is currently in **beta**, and we welcome your feedback to improve it.