Configuration options of the instance and their modification. The read only lists of types supported by the instance (identifier types, map formats, image formats, overlay types) are described in References. The endpoints are served from /new_api/configuration/options/.

1. List configuration options

Returns all instance-wide settings - mail server, login providers, logos and other branding, default project, and similar - each with its type, current value, human readable name and the group it is presented in. Options marked as server side are included only for administrators.

1.1. HTTP request

GET /minerva/new_api/configuration/options/ HTTP/1.1

1.2. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/configuration/options/' -X GET

1.3. HTTP response

HTTP/1.1 200 OK

1.4. Response Fields

Path Type Description

[].commonName

String

human readable name of configuration option

[].group

String

group of options where this configuration option belongs to

[].subgroup

String

subgroup of options where this configuration option belongs to

[].type

String

option type

[].value

String

value of the configuration option

[].parameterOrder

Number

sort order

[].valueType

String

type of the configuration option (STRING, INTEGER, etc.)

1.5. Sample Response

[ {
  "type" : "DEFAULT_MAP",
  "valueType" : "STRING",
  "commonName" : "Default Project Id",
  "value" : "empty",
  "group" : "Server",
  "subgroup" : "Content visibility",
  "parameterOrder" : 1301
}, {
  "type" : "LEFT_LOGO_IMG",
  "valueType" : "URL",
  "commonName" : "Left logo icon",
  "value" : "/minerva/images/udl.png",
  "group" : "Interface",
  "subgroup" : "Legend and logo",
  "parameterOrder" : 2101
}, {
  "type" : "LEFT_LOGO_LINK",
  "valueType" : "URL",
  "commonName" : "Left logo link (after click)",
  "value" : "http://wwwen.uni.lu/",
  "group" : "Interface",
  "subgroup" : "Legend and logo",
  "parameterOrder" : 2102
}, {
  "type" : "LEFT_LOGO_TEXT",
  "valueType" : "STRING",
  "commonName" : "Left logo description",
  "value" : "University of Luxembourg",
  "group" : "Interface",
  "subgroup" : "Legend and logo",
  "parameterOrder" : 2103
}, {
  "type" : "RIGHT_LOGO_IMG",
  "valueType" : "URL",
  "commonName" : "Right logo icon",
  "value" : "/minerva/images/lcsb.png",
  "group" : "Interface",
  "subgroup" : "Legend and logo",
  "parameterOrder" : 2104
}, {
  "type" : "RIGHT_LOGO_LINK",
  "valueType" : "URL",
  "commonName" : "Right logo link (after click)",
  "value" : "http://wwwen.uni.lu/lcsb/",
  "group" : "Interface",
  "subgroup" : "Legend and logo",
  "parameterOrder" : 2105
}, {
  "type" : "RIGHT_LOGO_TEXT",
  "valueType" : "STRING",
  "commonName" : "Right logo description",
  "value" : "LCSB - Luxembourg Centre for Systems Biomedicine",
  "group" : "Interface",
  "subgroup" : "Legend and logo",
  "parameterOrder" : 2106
}, {
  "type" : "REQUEST_ACCOUNT_EMAIL",
  "valueType" : "EMAIL",
  "commonName" : "Email used for requesting an account",
  "value" : "",
  "group" : "Server",
  "subgroup" : "Email notification",
  "parameterOrder" : 1108
}, {
  "type" : "X_FRAME_DOMAIN",
  "valueType" : "URL",
  "commonName" : "Domain allowed to connect via x-frame technology",
  "value" : "",
  "group" : "Server",
  "subgroup" : "Content visibility",
  "parameterOrder" : 1305
}, {
  "type" : "CORS_DOMAIN",
  "valueType" : "BOOLEAN",
  "commonName" : "Disable CORS (when disabled 'ORIGIN' http header is required)",
  "value" : "false",
  "group" : "Server",
  "subgroup" : "Advanced",
  "parameterOrder" : 1501
}, {
  "type" : "BIG_FILE_STORAGE_DIR",
  "valueType" : "STRING",
  "commonName" : "Path to store big files",
  "value" : "minerva-big/",
  "group" : "Server",
  "subgroup" : "Advanced",
  "parameterOrder" : 1502
}, {
  "type" : "LEGEND_FILE_1",
  "valueType" : "URL",
  "commonName" : "Legend 1 image file",
  "value" : "/minerva/images/legend_a.png",
  "group" : "Interface",
  "subgroup" : "Legend and logo",
  "parameterOrder" : 2107
}, {
  "type" : "LEGEND_FILE_2",
  "valueType" : "URL",
  "commonName" : "Legend 2 image file",
  "value" : "/minerva/images/legend_b.png",
  "group" : "Interface",
  "subgroup" : "Legend and logo",
  "parameterOrder" : 2108
}, {
  "type" : "LEGEND_FILE_3",
  "valueType" : "URL",
  "commonName" : "Legend 3 image file",
  "value" : "/minerva/images/legend_c.png",
  "group" : "Interface",
  "subgroup" : "Legend and logo",
  "parameterOrder" : 2109
}, {
  "type" : "LEGEND_FILE_4",
  "valueType" : "URL",
  "commonName" : "Legend 4 image file",
  "value" : "/minerva/images/legend_d.png",
  "group" : "Interface",
  "subgroup" : "Legend and logo",
  "parameterOrder" : 2110
}, {
  "type" : "MIN_COLOR_VAL",
  "valueType" : "COLOR",
  "commonName" : "Overlay color for negative values",
  "value" : "FF0000",
  "group" : "Interface",
  "subgroup" : "Overlays",
  "parameterOrder" : 2301
}, {
  "type" : "MAX_COLOR_VAL",
  "valueType" : "COLOR",
  "commonName" : "Overlay color for positive values",
  "value" : "0000FF",
  "group" : "Interface",
  "subgroup" : "Overlays",
  "parameterOrder" : 2302
}, {
  "type" : "SIMPLE_COLOR_VAL",
  "valueType" : "COLOR",
  "commonName" : "Overlay color when no values are defined",
  "value" : "00FF00",
  "group" : "Interface",
  "subgroup" : "Overlays",
  "parameterOrder" : 2303
}, {
  "type" : "NEUTRAL_COLOR_VAL",
  "valueType" : "COLOR",
  "commonName" : "Overlay color for value=0",
  "value" : "FFFFFF",
  "group" : "Interface",
  "subgroup" : "Overlays",
  "parameterOrder" : 2304
}, {
  "type" : "OVERLAY_OPACITY",
  "valueType" : "DOUBLE",
  "commonName" : "Opacity used when drawing data overlays (value between 0.0-1.0)",
  "value" : "0.8",
  "group" : "Interface",
  "subgroup" : "Overlays",
  "parameterOrder" : 2305
}, {
  "type" : "REQUEST_ACCOUNT_DEFAULT_CONTENT",
  "valueType" : "TEXT",
  "commonName" : "Email content used for requesting an account",
  "value" : "Dear Disease map team,\nI would like to request an account in the system.\nKind regards",
  "group" : "Server",
  "subgroup" : "Email notification",
  "parameterOrder" : 1110
}, {
  "type" : "TERMS_OF_USE",
  "valueType" : "URL",
  "commonName" : "URL of platform's Terms of Service",
  "value" : "",
  "group" : "Server",
  "subgroup" : "Document links",
  "parameterOrder" : 1201
}, {
  "type" : "COOKIE_POLICY_URL",
  "valueType" : "URL",
  "commonName" : "Privacy policy (url)",
  "value" : "/minerva/default-cookie-policy.html",
  "group" : "Server",
  "subgroup" : "Document links",
  "parameterOrder" : 1203
}, {
  "type" : "SESSION_LENGTH",
  "valueType" : "INTEGER",
  "commonName" : "Max session inactivity time (in seconds)",
  "value" : "7200",
  "group" : "Server",
  "subgroup" : "Advanced",
  "parameterOrder" : 1503
}, {
  "type" : "MINERVA_ROOT",
  "valueType" : "URL",
  "commonName" : "Minerva root url",
  "value" : "",
  "group" : "Server",
  "subgroup" : "Content visibility",
  "parameterOrder" : 1302
}, {
  "type" : "REQUEST_ACCOUNT_DEFAULT_TITLE",
  "valueType" : "STRING",
  "commonName" : "Email title used for requesting an account",
  "value" : "MINERVA account request",
  "group" : "Server",
  "subgroup" : "Email notification",
  "parameterOrder" : 1109
}, {
  "type" : "ORCID_CLIENT_ID",
  "valueType" : "TEXT",
  "commonName" : "Orcid Client ID",
  "value" : "",
  "group" : "Access",
  "subgroup" : "Oauth",
  "parameterOrder" : 3301
}, {
  "type" : "ORCID_CLIENT_SECRET",
  "valueType" : "PASSWORD",
  "commonName" : "Orcid Client Secret",
  "value" : "********",
  "group" : "Access",
  "subgroup" : "Oauth",
  "parameterOrder" : 3302
}, {
  "type" : "ALLOW_AUTO_REGISTER",
  "valueType" : "BOOLEAN",
  "commonName" : "Allow users to create accounts",
  "value" : "false",
  "group" : "Server",
  "subgroup" : "User registration",
  "parameterOrder" : 1401
}, {
  "type" : "REQUIRE_APPROVAL_FOR_AUTO_REGISTERED_USERS",
  "valueType" : "BOOLEAN",
  "commonName" : "Require admin approval for auto-registered accounts",
  "value" : "true",
  "group" : "Server",
  "subgroup" : "User registration",
  "parameterOrder" : 1402
}, {
  "type" : "MATOMO_URL",
  "valueType" : "URL",
  "commonName" : "Matomo tracking url (for example: https://cdn.matomo.cloud/atcomp.matomo.cloud/container_d9VKcbPg_dev_d48ac09b17cfa365367b6ce.js)",
  "value" : "",
  "group" : "Server",
  "subgroup" : "Advanced",
  "parameterOrder" : 1504
} ]

2. Get configuration option

Returns a single option identified by its type. Options marked as server side are available only for administrators.

2.1. HTTP request

GET /minerva/new_api/configuration/options/DEFAULT_MAP HTTP/1.1

2.2. Path Parameters

Table 1. /minerva/new_api/configuration/options/{option}
Parameter Description

option

option type

2.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/configuration/options/DEFAULT_MAP' -X GET

2.4. HTTP response

HTTP/1.1 200 OK

2.5. Response Fields

Path Type Description

commonName

String

human readable name of configuration option

group

String

group of options where this configuration option belongs to

subgroup

String

subgroup of options where this configuration option belongs to

type

String

option type

value

String

value of the configuration option

parameterOrder

Number

sort order

valueType

String

type of the configuration option (STRING, INTEGER, etc.)

2.6. Sample Response

{
  "type" : "DEFAULT_MAP",
  "valueType" : "STRING",
  "commonName" : "Default Project Id",
  "value" : "empty",
  "group" : "Server",
  "subgroup" : "Content visibility",
  "parameterOrder" : 1301
}

3. Update configuration option

Replaces a single option identified by its type with a new value, and returns the option as stored. Only the value can be changed; for some options (numeric ones, the default project, the minerva root address) it is validated and the request is rejected when it is not acceptable. Available only for administrators.

3.1. HTTP request

PUT /minerva/new_api/configuration/options/EMAIL_SMTP_PORT HTTP/1.1

3.2. Path Parameters

Table 2. /minerva/new_api/configuration/options/{option}
Parameter Description

option

option type

3.3. Request Fields

Path Type Description

value

String

new option value

3.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/configuration/options/EMAIL_SMTP_PORT' -X PUT \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"value":"25"}' \
    -H 'Content-Type: application/json'

3.5. HTTP response

HTTP/1.1 200 OK

3.6. Response Fields

Path Type Description

commonName

String

human readable name of configuration option

group

String

group of options where this configuration option belongs to

subgroup

String

subgroup of options where this configuration option belongs to

type

String

option type

value

String

value of the configuration option

parameterOrder

Number

sort order

valueType

String

type of the configuration option (STRING, INTEGER, etc.)

3.7. Sample Response

{
  "type" : "EMAIL_SMTP_PORT",
  "valueType" : "INTEGER",
  "commonName" : "SMTP port",
  "value" : "25",
  "group" : "Server",
  "subgroup" : "Email notification",
  "parameterOrder" : 1107
}