TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-12-05 09:52:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: access zitadel apis (#1627)

Browse Source 
* doc: access zitadel apis

* doc: access zitadel apis

* doc: swagger
This commit is contained in:
Fabi
2021-04-20 21:37:30 +02:00
committed by GitHub
parent fdcf728d71
commit c223a9ed61
7 changed files with 176 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/docs/apis/apis.md
View File

@@ -6,6 +6,11 @@ All of our APIs are generated by proto defintions. You can find all the proto de
> 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://api.zitadel.ch/openapi/v2/swagger/](https://api.zitadel.ch/openapi/v2/swagger/)
The easiest way to have a look at them is, to import them in the [Swagger Editor](https://editor.swagger.io/)
## Authentication API aka Auth
The authentication API (aka Auth API) is used for all operations on the currently logged in user.

2
docs/docs/apis/openidoauth/scopes.md
View File

@@ -26,6 +26,6 @@ In addition to the standard compliant scopes we utilize the following scopes.
| urn:zitadel:iam:org:project:role:{rolename} | `urn:zitadel:iam:org:project:role:user` | By using this scope a client can request the claim urn:zitadel:iam:roles:rolename} to be asserted when possible. As an alternative approach you can enable all roles to be asserted from the [project](../../guides/projects) a client belongs to. |
| urn:zitadel:iam:org:domain:primary:{domainname} | `urn:zitadel:iam:org:domain:primary:acme.ch` | When requesting this scope **ZITADEL** will enforce that the user is a member of the selected organization. If the organization does not exist a failure is displayed |
| urn:zitadel:iam:role:{rolename} | | |
| urn:zitadel:iam:org:project:id:{projectid}:aud | ZITADEL's Project id is `urn:zitadel:iam:org:project:id:69234237810729019:aud` | By adding this scope, the requested projectid will be added to the audience of the access and id token |
| `urn:zitadel:iam:org:project:id:{projectid}:aud` | ZITADEL's Project id is `urn:zitadel:iam:org:project:id:69234237810729019:aud` | By adding this scope, the requested projectid will be added to the audience of the access and id token |
> If access to ZITADEL's API's is needed with a service user the scope `urn:zitadel:iam:org:project:id:69234237810729019:aud` needs to be used with the JWT Profile request