As of Version

product version 2021 Summer | component version

Request Method GET

Response Format JSON

Description

Retrieves a list of all existing settings on the user specified by userId.

Add the optional query parameter size=<N> with any integer value N to the request URL to divide the hit list into sections. Each of them contains N sets of settings. Only one section is returned in the response body.

Add the optional query parameter page=<n> with any integer value n to the request URL to retrieve the hit list section of index n.

Add the optional query parameter sort with value asc (desc) to sort the hit list in ascending (descending) order.

Response HTTP status codes:

HTTP Status Code	Description
200	OK
401	Unauthorized
404	Not found

Request Example

https://<host>/userservice/api/users/12849a-1bca-f2342/settings

Response Example

200 OK

response body

{
  "hasMoreItems": true,
  "numItems": 50,
  "objects": [
    {
      "id": "myapp.layout"
    }
  ],
  "totalNumItems": 1234
}

Browser not supported