Jump to: navigation, search

Fetch user settings

Method

GET

Syntax

GET /user_settings

Response Body

From 9.0.016

logged_with_saml and slo_enabled are removed.

{
  "user_dbid": <dbid>,                // for example 1234
  "user": "<short_user_name>",        // for example "django"
  "user_first_name": "<first_name>",  // for example "Django"
  "user_last_name": "<last_name>",    // for example "Freeman"
  "timezone": {
    "value": "<current_TZ_value>",    // for example "America/Chicago"
    "values": [
      {
        "value": "<TZ_value>",        // for example "America/Chicago"
        "label": "<TZ_label>"         // for example "America/Chicago (GMT-6)(+DST)"
      },
      ...
    ]
  },
  "language": "<language_ID_string>",                // for example "fr-CA" (IETF notation recommended)
  "date_time_format": "<date_time_format_string>",   // for example "yyyy/MM/dd HH:mm:ss Z"
  "date_format": "<date_format_string>",             // for example "yyyy/MM/dd"
  "first_day_of_week": "<SUNDAY|MONDAY>",            // default: MONDAY
  "last_logged_in": "<date_time_of_last_logging_in>",// for example "2016-05-03T12:30:55+02:00"
  "default_filter": {
    "selected_filter": <filter_name>,                // for example Assigned
    "available_filters": [
      "<filter_name_1>",
      "<filter_name_2>",                             // for example Assigned
      ...
    ]
  },
  "user_privileges": [
    {
      "tenant_dbid": <tenant_dbid>,
      "privileges": [
        "<privilege_1>",  // for example "GLOBAL_TASK_LIST_MODIFY"
        "<privilege_2>",
        ...
      ]
    },
    ...
  ],
  "system_timezone": "<timezone>",                   // time zone from the server; for example "America/Chicago"
  "external_authentication": <true|false>,           // shows whether external authentication is enabled on Config Server.
}

Up to 9.0.015

{
  "user_dbid": <dbid>,                // for example 1234
  "user": "<short_user_name>",        // for example "django"
  "user_first_name": "<first_name>",  // for example "Django"
  "user_last_name": "<last_name>",    // for example "Freeman"
  "timezone": {
    "value": "<current_TZ_value>",    // for example "America/Chicago"
    "values": [
      {
        "value": "<TZ_value>",        // for example "America/Chicago"
        "label": "<TZ_label>"         // for example "America/Chicago (GMT-6)(+DST)"
      },
      ...
    ]
  },
  "language": "<language_ID_string>",                // for example "fr-CA" (IETF notation recommended)
  "date_time_format": "<date_time_format_string>",   // for example "yyyy/MM/dd HH:mm:ss Z"
  "date_format": "<date_format_string>",             // for example "yyyy/MM/dd"
  "first_day_of_week": "<SUNDAY|MONDAY>",            // default: MONDAY
  "last_logged_in": "<date_time_of_last_logging_in>",// for example "2016-05-03T12:30:55+02:00"
  "default_filter": {
    "selected_filter": <filter_name>,                // for example Assigned
    "available_filters": [
      "<filter_name_1>",
      "<filter_name_2>",                             // for example Assigned
      ...
    ]
  },
  "user_privileges": [
    {
      "tenant_dbid": <tenant_dbid>,
      "privileges": [
        "<privilege_1>",  // for example "GLOBAL_TASK_LIST_MODIFY"
        "<privilege_2>",
        ...
      ]
    },
    ...
  ],
  "system_timezone": "<timezone>",                   // time zone from the server; for example "America/Chicago"
  "external_authentication": <true|false>,           // shows whether external authentication is enabled on Config Server.
  "logged_with_saml": false,                         // In 9.0.015: deprecated. Always returns false. 
  "slo_enabled": false                               // In 9.0.015: deprecated. Always returns false. 
}

Notes

  • system_timezone is taken from the server running the iWD Manager application. May be empty if the time zone is not compatible with Joda Time.
  • external_authentication shows using external authentication by Management Framework.
This page was last edited on March 31, 2021, at 12:14.
Comments or questions about this documentation? Contact us for support!