User Settings 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	Retrieve a list of all existing contents stored by the user specified by `userId`. /userservice/api/users/{userId}/contents
DELETE as of 2021 Summer	deleteAllContent	HTTP status code	Deletes all existing contents stored for the user specified by `userId`. /userservice/api/users/{userId}/contents
GET as of 2021 Summer	getContent	Binary data	Retrieves the content specified by `contentId` that is stored for the user specified by `userId`. /userservice/api/users/{userId}/contents/{contentId}
HEAD as of 2021 Summer	getContentInfo	HTTP status code	Retrieves content information on the content specified by `contentId` that is stored for the user specified by `userId`. /userservice/api/users/{userId}/contents/{contentId}
POST as of 2021 Summer	setContent	HTTP status code	Creates or updates the content specified by `contentId` that is stored for the user specified by `userId` with the data passed as a file in the multipart request body. /userservice/api/users/{userId}/contents/{contentId}
DELETE as of 2021 Summer	deleteContent	HTTP status code	Deletes the content specified by `contentId` that is stored for the user specified by `userId`. /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, deprecated as of 2021 Winter	getUsers	JSON	Retrieve information on all users, optionally filtered by a search query defined in the request URL. /userservice/api/users
GET as of 2021 Summer, deprecated as of 2021 Winter	getUser	JSON	Retrieves the information on the user specified by `userId`. /userservice/api/users/{userId}
	User Settings - Manage custom settings (for example, layout settings)
GET as of 2021 Summer	getSettings	JSON	Retrieves a list of all existing settings on the user specified by `userId`. /userservice/api/users/{userId}/settings
DELETE as of 2021 Summer	deleteAllSettings	HTTP status code	Deletes all existing settings stored for the user specified by `userId`. /userservice/api/users/{userId}/settings
GET as of 2021 Summer	getSetting	JSON	Retrieves the set of settings specified by `settingId` that is stored for the user specified by `userId`. /userservice/api/users/{userId}/settings/{settingId}
HEAD as of 2021 Summer	getSettingInfo	HTTP status code	Retrieves information on the set of settings specified by `settingId` that is stored for the user specified by `userId`. /userservice/api/users/{userId}/settings/{settingId}
POST as of 2021 Summer	setSetting	HTTP status code	Creates or updates the set of settings specified by `settingId` that is stored for the user specified by `userId` with the data passed in JSON structure in the request body. /userservice/api/users/{userId}/settings/{settingId}
DELETE as of 2021 Summer	deleteSetting	HTTP status code	Deletes the set of settings specified by `settingId` that is stored for the user specified by `userId`. /userservice/api/users/{userId}/settings/{settingId}

User Settings Endpoints

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

User Info - Access to detailed user information (for example, first name, last name and email)

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