| Endpoint | Authentication | Query Parameters | Description |
|---|---|---|---|
| / | - | - | API root; shows available endpoints. |
| /info | - | - | Service-specific information. |
| /info/authorisation | HTTP Bearer1 | - | Authorisation information for specific OP (issuer of given token). |
| /verify_user | HTTP Bearer2 | username: str | Verifies if a given token belongs to given local account (username). |
| /user | - | - | User API root; shows available endpoints. |
| /user/get_status | HTTP Bearer2 | - | Get information about your local account. |
| /user/deploy | HTTP Bearer2 | - | Provision local account. |
| /user/suspend | HTTP Bearer2 | - | Suspend local account. |
| /admin | - | - | Admin API root; shows available endpoints. |
| /admin/suspend | HTTP Bearer3 | sub: str iss: str |
Suspends the local account belonging to OIDC user uniquely identified by sub and iss. |
| /admin/resume | HTTP Bearer3 | sub: str iss: str |
Restores the suspended local account belonging to OIDC user uniquely identified by sub and iss. |
1 requires valid access token from a supported OP
2 requires valid access token of an authorised user
3 requires valid access token of an authorised user with admin role