Applies to: reference, configuration

Shell Service Settings

The configuration of the Shell service.

Format Path Filename Purpose
JSON ./conf/shell/ config.json Authentication & MQTT configuration 
{
    "auth": {
        "issuer": "https://login.microsoftonline.com/<TENANT_ID>/v2.0",
        "client_id": "<CLIENT_ID>",
        "redirect_uri": "https://<MOPS_URL>.com/callback",
        "response_type": "code",
        "scope": "openid profile email offline_access api://<CLIENT_ID>/mops",
        "load_user_info": false,
        "rootPath": "",
        "userManagerSettings": {
            "includeIdTokenInSilentRenew": true,
            "accessTokenExpiringNotificationTime": 60
        },
        "log": {
            "type": "console",
            "level": 4
        }
    }
}

Example of auth configuration

Name Type Description
issuer string URL of the authorization server, including the tenant ID.
client_id string Client ID used to identify the application during authentication.
redirect_uri string URI where the authorization server redirects after authentication.
response_type string Response type for the OAuth2 flow, typically code.
scope string Space-separated list of scopes defining access privileges, such as openid, profile, and API scopes.
load_user_info boolean Whether to load additional user information after login. Defaults to false.
rootPath string Root path for the application. Leave empty if not needed.
userManagerSettings object See the 2 descriptions (uMS.) below:
uMS.includeIdTokenInSilentRenew boolean Specifies if ID tokens should be included during silent token renewal.
uMS.accessTokenExpiringNotificationTime int Time (in seconds) before token expiration to trigger a notification. Default is 60.
log object See the 2 descriptions (log.) below:
log.type string Type of logging mechanism, e.g., console.
log.level int Logging verbosity level; higher values provide more detailed logs.