Breadcrumbs

User Settings

Data Storage Model

  • User settings are stored as key/value pairs in the metadata structure of the user object.

  • For example, a user’s location is stored as follows:

<field>
    <key>WEB_LOCATION</key>
    <value>"Cologne"</value>
</field>


API Usage

Retrieve User Metadata

  • Use the following API endpoint to retrieve the user settings:

GET /API/user/{USERNAME}/metadata/


Example Response

<metadataDocument>
  <metadata>
    <field>
        <key>WEB_LOCATION</key>
        <value>"Cologne"</value>
    </field>
    <field>
        <key>THEME</key>
        <value>"Dark"</value>
    </field>
  </metadata>
</metadataDocument>


Modify User Settings

  • User settings can be updated via standard API calls by modifying or adding new key/value pairs to the user metadata.

  • This allows external systems or automation scripts to easily adjust user preferences.

Configuration Notes

  • No database schema changes are required for administrators.

  • Changes take effect immediately after updates are performed via API or UI.

  • Ensure external tools interacting with the user API are prepared to handle the key/value pair structure.