View Source

Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE".

Everything contained within the table is displayed in the (INTERNAL) Reports page.

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

Add a new line to this table and fill it whenever you edit the page.

Name	Date	Product Version	Action
Antje	10 FEB 2021	2.5	Page created.
Antje	15 FEB 2021	2020 Winter	rDOC
Agnieszka	17 FEB 2021	2020 Winter	rLANG
Antje	28 MAY 2021	2021 Summer	version update - all endpoints refactured
Antje	21 FEB 2022	2022 Spring	remove user information endpoints

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	/userservice/api/users/{userId}/contents
DELETE as of 2021 Summer	deleteAllContent	HTTP status code	/userservice/api/users/{userId}/contents
GET as of 2021 Summer	getContent	Binary data	/userservice/api/users/{userId}/contents/{contentId}
HEAD as of 2021 Summer	getContentInfo	HTTP status code	/userservice/api/users/{userId}/contents/{contentId}
POST as of 2021 Summer	setContent	HTTP status code	/userservice/api/users/{userId}/contents/{contentId}
DELETE as of 2021 Summer	deleteContent	HTTP status code	/userservice/api/users/{userId}/contents/{contentId}
	User Settings - Manage custom settings (for example, layout settings)
GET as of 2021 Summer	getSettings	JSON	/userservice/api/users/{userId}/settings
DELETE as of 2021 Summer	deleteAllSettings	HTTP status code	/userservice/api/users/{userId}/settings
GET as of 2021 Summer	getSetting	JSON	/userservice/api/users/{userId}/settings/{settingId}
HEAD as of 2021 Summer	getSettingInfo	HTTP status code	/userservice/api/users/{userId}/settings/{settingId}
POST as of 2021 Summer	setSetting	HTTP status code	/userservice/api/users/{userId}/settings/{settingId}
DELETE as of 2021 Summer	deleteSetting	HTTP status code	/userservice/api/users/{userId}/settings/{settingId}

User Contents - Manage custom content (for example, profile pictures)

User Settings - Manage custom settings (for example, layout settings)