hetida-platform-core-api
REST API of the hetida platform core backend (core-backend).
Authentication. Every operation expects a Keycloak-issued JWT as bearer token; a missing or invalid token is answered 401, a token without the required role 403.
Roles. Each operation declares the realm roles that may call it in x-required-roles - one of the listed roles suffices. ADMIN passes every check unless the operation says x-admin-bypass: false. An empty list means the operation carries no role check of its own and any authenticated user passes.
Errors. Every error response is an ErrorDto: message says what went wrong, errorCode classifies it, additionalInformation names violated fields. The declared 400 covers a request the server could not read or validate (malformed body, an id that is not a UUID, a violated bound), the declared 404 an entity named in the path or body that does not exist for the caller's tenant. default stands for anything else, 500 included.
Authentication
- HTTP: Bearer Auth
JWT issued by the Keycloak realm of the platform.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
License
Proprietary - fuseki GmbH