The USERSERVICE API allows accessing and managing custom user information, settings and content.If the path parameter userId is specified in a request URL, the corresponding endpoint operates on the data of the user specified by this ID. In order to work with the data of the currently authorized user, the path alias /me can be used instead of /users/{userId}. For example, a GET /api/me request leads to the same result as calling the GET /api/users/{userId} endpoint.
Note: Accessing or managing the data of users other than the currently authorized user may require administrative rights (as configured in the service parameter app.security.admin-role). If the service is accessed with administrative rights, no further checks on existence of users are performed. This allows more flexibility to users and apps with admin rights. For instance, it is possible to remove the data of users stored by USERSERVICE that have left the system and are no longer in the security system, or to prepare data for users that are about to be added to the system.
This API requires Keycloak as identity provider for yuuvis® Momentum.
In order to use the endpoints, a valid JWT token is required which is provided after successful authentication with valid credentials.
All endpoints are available via the Swagger-UI https://<host>/userservice/swagger-ui.html.
| HTTP Method as of product version | Purpose | Response Format | Description |
|---|---|---|---|
User Contents - Manage custom content (for example, profile pictures) | |||
| GET as of 2021 Summer | getContents | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET userservice/api/users/{userId}/contents'. /userservice/api/users/{userId}/contents |
| DELETE as of 2021 Summer | deleteAllContent | HTTP status code | Error rendering macro 'excerpt-include' : No link could be created for 'DELETE userservice/api/users/{userId}/contents'. /userservice/api/users/{userId}/contents |
GET | getContent | Binary data | Error rendering macro 'excerpt-include' : No link could be created for 'GET userservice/api/users/{userId}/contents/{contentId}'. /userservice/api/users/{userId}/contents/{contentId} |
HEAD | getContentInfo | HTTP status code | Error rendering macro 'excerpt-include' : No link could be created for 'HEAD /userservice/api/users/{userId}/contents/{contentId}'. /userservice/api/users/{userId}/contents/{contentId} |
| POST as of 2021 Summer | setContent | HTTP status code | Error rendering macro 'excerpt-include' : No link could be created for 'POST /userservice/api/users/{userId}/contents/{contentId}'. /userservice/api/users/{userId}/contents/{contentId} |
DELETE | deleteContent | HTTP status code | Error rendering macro 'excerpt-include' : No link could be created for 'DELETE /userservice/api/users/{userId}/contents/{contentId}'. /userservice/api/users/{userId}/contents/{contentId} |
User Info - Access to detailed user information (for example, first name, last name and email) | |||
| GET as of 2021 Summer | getUsers | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET userservice/api/users'. /userservice/api/users |
| GET as of 2021 Summer | getUser | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET /userservice/api/users/{userId}'. /userservice/api/users/{userId} |
User Settings - Manage custom settings (for example, layout settings) | |||
| GET as of 2021 Summer | getSettings | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET /userservice/api/users/{userId}/settings'. /userservice/api/users/{userId}/settings |
| DELETE as of 2021 Summer | deleteAllSettings | HTTP status code | Error rendering macro 'excerpt-include' : No link could be created for 'DELETE /userservice/api/users/{userId}/settings'. /userservice/api/users/{userId}/settings |
| GET as of 2021 Summer | getSetting | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET userservice/api/users/{userId}/settings/{settingId}'. /userservice/api/users/{userId}/settings/{settingId} |
| HEAD as of 2021 Summer | getSettingInfo | HTTP status code | Error rendering macro 'excerpt-include' : No link could be created for 'HEAD userservice/api/users/{userId}/settings/{settingId}'. /userservice/api/users/{userId}/settings/{settingId} |
| POST as of 2021 Summer | setSetting | HTTP status code | Error rendering macro 'excerpt-include' : No link could be created for 'POST userservice/api/users/{userId}/settings/{settingId}'. /userservice/api/users/{userId}/settings/{settingId} |
| DELETE as of 2021 Summer | deleteSetting | HTTP status code | Error rendering macro 'excerpt-include' : No link could be created for 'DELETE userservice/api/users/{userId}/settings/{settingId}'. /userservice/api/users/{userId}/settings/{settingId} |