Settings Resources

Get the List of Settings

GET /settings

Get a list of all available settings and their current state.

Note This is a list of network wide settings accessible without authentication through this endpoint.

General

Name Description
allow_inactive_user_interaction see: /resources/settings/user, property: allow_inactive_user_interaction.
anonymize_deleted_users see: /resources/settings/user, property: anonymize_deleted_users.
anonymize_users_email see: /resources/settings/user, property: anonymize_users_email.
appendix_user_info_clip see: /resources/settings/user, property: appendix_user_info_clip.
appendix_user_search_clip see: /resources/settings/user, property: appendix_user_search_clip.
default_solution_validation_period see: /resources/settings/solution-validation, property: default_period_id.
delete_solved_questions see: /resources/settings/content, property: delete_solved_questions.
disclaimer_enabled see: /resources/settings/disclaimer, property: disclaimer_enabled.
email_delivery_enabled see: /resources/settings/email, property: enabled.
fullname_reversed see: /resources/settings/user, property: fullname_reversed.
google_analytics_tracking_id see: /resources/settings/analytics, property: google_analytics_tracking_id.
hide_tags see: /resources/settings/content, property: hide_tags.
hint_emails_enabled see: /resources/hint, property: enabled.
invitation_email_allowed_domains see: /resources/user, property: invitation_email_allowed_domains.
layout Contains all layout settings. see: /resources/settings/layout.
layout_starmind_branding_enabled see: /resources/settings/layout, property: starmind_branding_enabled.
notification_channel_email_enabled see: /resources/email-notification, property: enabled.
notification_channel_skype_for_business_enabled see: /resources/settings/skype-for-business, property: enabled.
piwik_analytics_url see: /resources/settings/analytics, property: piwik_url.
piwik_analytics_page_id see: /resources/settings/analytics, property: piwik_page_id.
question_flagging_enabled see: /resources/question-flagging, property: enabled.
question_title_max_length see: /resources/settings/content, property: question_title_max_length.
show_average_rating_to_user see: /resources/settings/content, property: show_average_rating_to_user.
solution_validation_enabled see: /resources/settings/solution-validation, property: enabled.
solution_value_enabled see: /resources/settings/solution-value, property: enabled.
solution_value_allow_all see: /resources/settings/solution-value, property: allow_all.
upload_file_types see: /resources/settings/content, property: upload_file_types.
user_creation_default_roles see: /resources/settings/user, property: user_creation_default_roles.
user_custom_fields see: /resources/settings/user, property: user_custom_fields.
user_score Contains all user-score settings. see: /resources/settings/user-score.
user_score_enabled Deprecated: Use user_score instead.
user_score_frontend_enabled Deprecated: Use user_score instead.
canny_integration_enabled see: /resources/settings/canny, property: enabled.
workspaces_enabled see: /resources/settings/workspaces, property: enabled.

Content editing

The allowed content editing settings.

Name Description
content_allow_html_tables see: /resources/settings/content, property: content_allow_html_tables.
content_allow_raw_html_tags see: /resources/settings/content, property: content_allow_raw_html_tags.

Language

Languages are defined as 2 digit, ISO 3166-1 alpha-2 codes.

Name References
available_interface_languages see: /resources/settings/network, property: available_interface_languages.
default_language see: /resources/settings/network, property: language.
use_formal_language see: /resources/settings/user, property: use_formal_language.

Name Type Value
available_content_languages array of language codes All supported content langauges

Name Type Value
available_translation_providers array of string All available translation providers for configuration. An admin needs to configure which one to use.
translations_rolled_out boolean Whether translations are enabled for the network.
translation_provider string The currently selected provider. May be null.
default_translation_provider string The default translation provider. It is, by definition, present in available_translation_providers.

Public read only settings

Name Type Description
default_user_image string Absolute URL to the default user image
data_privacy_agreement_enabled string see: /resources/settings/gdpr, property: agreement_enabled.
network_name string The network-name as configured in:
/resources/settings/network, property: name.
static_host string The host:port as configured in the static section found in the application.conf
user_knowhow_map_visible_by_everyone boolean Setting controls if the Know-How Map of a user is visible to everyone or only the user itself. Default is true.
feedback_rating_enabled boolean Enables the dialog for the user to give feedback as a comment after giving a rating. Default is true.

Response

Note: The following is an non-exhaustive list of network settings.

{
    "anonymize_deleted_users": false,
    "notification_channel_email_enabled": true,
    "allow_inactive_user_interaction": true,
    "solution_value_allow_all": false,
    "notification_channel_skype_for_business_enabled": false,
    "piwik_analytics_url": "https://analytics.example.com",
    "piwik_analytics_page_id": 999,
    "available_content_languages": [
        "en",
        "fr",
        "de",
        "it",
        "es"
    ],
    "user_score": {
        "start": "2017-12-28T21:00:00.000Z",
        "frontend_enabled": true,
        "enabled": true
    }
}