User settings API

This API is used by the browser application. It provides the login and the preferences of the user. Most integrations use the other APIs instead. For authentication, tenants and general conventions, see Concepts.

All endpoints for the preferences with their parameters and data structures: User settings API reference.

The browser never handles access tokens. The Smart Operations Toolkit logs the user in with the authorization code flow with PKCE against the identity provider of the tenant and keeps the tokens in HttpOnly cookies. The tenant is selected with the query parameter ?tenant={tenantId}, for example:

https://<sot-host>/portal/?tenant={tenantId}

REST API

Path Method Purpose

Path	Method	Purpose
`/portal/api/v1/tenants/{tenantId}/users/{userId}/settings`	`GET`, `PUT`	Read and save the preferences of the logged-in user: language, time format, date format, time zone, theme, agent chat, view layout. `{userId}` must be the subject of the token.
`/portal/api/v1/tenants/{tenantId}/agent-chat-proxy/*`	all	Connection of the chat to the agent. Requires `ai_chat:read`.

/portal/api/v1/tenants/{tenantId}/users/{userId}/settings

GET, PUT

Read and save the preferences of the logged-in user: language, time format, date format, time zone, theme, agent chat, view layout. {userId} must be the subject of the token.

/portal/api/v1/tenants/{tenantId}/agent-chat-proxy/*

all

Connection of the chat to the agent. Requires ai_chat:read.

MCP server

https://<sot-host>/portal/tenants/{tenantId}/mcp

Tool Purpose

Tool	Purpose
`sot-web-portal_query_user_info`	Data of the logged-in user
`sot-web-portal_query_user_settings`	Read the preferences of the logged-in user
`sot-web-portal_manage_user_settings`	Change the preferences of the logged-in user

sot-web-portal_query_user_info

Data of the logged-in user

sot-web-portal_query_user_settings

Read the preferences of the logged-in user

sot-web-portal_manage_user_settings

Change the preferences of the logged-in user

API für Benutzereinstellungen

Diese API nutzt die Browseranwendung. Sie stellt die Anmeldung und die Einstellungen des Benutzers bereit. Die meisten Integrationen verwenden stattdessen die anderen APIs. Authentifizierung, Tenants und allgemeine Konventionen: siehe Konzepte.

Alle Endpunkte für die Einstellungen mit ihren Parametern und Datenstrukturen: Referenz der API für Benutzereinstellungen.

Der Browser verarbeitet nie Zugriffstokens. Das Smart Operations Toolkit meldet den Benutzer mit dem Authorization-Code-Flow mit PKCE beim Identity Provider des Tenants an und speichert die Tokens in HttpOnly-Cookies. Der Tenant wird über den Query-Parameter ?tenant={tenantId} ausgewählt, zum Beispiel:

https://<sot-host>/portal/?tenant={tenantId}

REST-API

Pfad Methode Zweck

Pfad	Methode	Zweck
`/portal/api/v1/tenants/{tenantId}/users/{userId}/settings`	`GET`, `PUT`	Einstellungen des angemeldeten Benutzers lesen und speichern: Sprache, Zeitformat, Datumsformat, Zeitzone, Design, Agent-Chat, Ansichtslayout. `{userId}` muss das Subject des Tokens sein.
`/portal/api/v1/tenants/{tenantId}/agent-chat-proxy/*`	alle	Verbindung des Chats zum Agenten. Erfordert `ai_chat:read`.

/portal/api/v1/tenants/{tenantId}/users/{userId}/settings

GET, PUT

Einstellungen des angemeldeten Benutzers lesen und speichern: Sprache, Zeitformat, Datumsformat, Zeitzone, Design, Agent-Chat, Ansichtslayout. {userId} muss das Subject des Tokens sein.

/portal/api/v1/tenants/{tenantId}/agent-chat-proxy/*

alle

Verbindung des Chats zum Agenten. Erfordert ai_chat:read.

MCP-Server

https://<sot-host>/portal/tenants/{tenantId}/mcp

Tool Zweck

Tool	Zweck
`sot-web-portal_query_user_info`	Daten des angemeldeten Benutzers
`sot-web-portal_query_user_settings`	Einstellungen des angemeldeten Benutzers lesen
`sot-web-portal_manage_user_settings`	Einstellungen des angemeldeten Benutzers ändern

sot-web-portal_query_user_info

Daten des angemeldeten Benutzers

sot-web-portal_query_user_settings

Einstellungen des angemeldeten Benutzers lesen

sot-web-portal_manage_user_settings

Einstellungen des angemeldeten Benutzers ändern

Diese Seite bearbeiten Edit this page