Endpoint

/v1/web-ui/settings

GET

Return settings (such as the inactivity timeout) that the Web UI uses. Because the Web UI can apply these settings before the user logs in, this method doesn't require authentication.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "web_ui_settings",
  "type": "object",
  "properties": {
    "inactivity_timeout": {
      "description": "When set, the Web UI logs out users after they are inactive for the specified time duration.",
      "type": "object",
      "properties": {
        "nanoseconds": {
          "description": "nanoseconds",
          "type": "string"
        }
      }
    },
    "login_banner": {
      "description": "When set, the Web UI shows a banner with the specified Markdown string on the login screen.",
      "type": "string"
    }
  }
}

PUT

Replace all the settings that the Web UI uses. These settings take effect immediately for new UI sessions.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "web_ui_settings",
  "type": "object",
  "properties": {
    "inactivity_timeout": {
      "description": "When set, the Web UI logs out users after they are inactive for the specified time duration.",
      "type": "object",
      "properties": {
        "nanoseconds": {
          "description": "nanoseconds",
          "type": "string"
        }
      }
    },
    "login_banner": {
      "description": "When set, the Web UI shows a banner with the specified Markdown string on the login screen.",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "web_ui_settings",
  "type": "object",
  "properties": {
    "inactivity_timeout": {
      "description": "When set, the Web UI logs out users after they are inactive for the specified time duration.",
      "type": "object",
      "properties": {
        "nanoseconds": {
          "description": "nanoseconds",
          "type": "string"
        }
      }
    },
    "login_banner": {
      "description": "When set, the Web UI shows a banner with the specified Markdown string on the login screen.",
      "type": "string"
    }
  }
}

PATCH

Replace individual Web UI settings. These settings take effect immediately for new Web UI sessions.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "web_ui_settings_patch",
  "type": "object",
  "properties": {
    "inactivity_timeout": {
      "description": "When set, the Web UI logs out users after they are inactive for the specified time duration.",
      "type": "object",
      "properties": {
        "nanoseconds": {
          "description": "nanoseconds",
          "type": "string"
        }
      }
    },
    "login_banner": {
      "description": "When set, the Web UI shows a banner with the specified Markdown string on the login screen.",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "web_ui_settings",
  "type": "object",
  "properties": {
    "inactivity_timeout": {
      "description": "When set, the Web UI logs out users after they are inactive for the specified time duration.",
      "type": "object",
      "properties": {
        "nanoseconds": {
          "description": "nanoseconds",
          "type": "string"
        }
      }
    },
    "login_banner": {
      "description": "When set, the Web UI shows a banner with the specified Markdown string on the login screen.",
      "type": "string"
    }
  }
}