SetLoginBanner

您可以通过 SetLoginBanner 方法配置用户登录到 Element Web 界面时看到的“使用条款”横幅。

参数

此方法具有以下输入参数:

名称 说明 类型 默认值 必需
banner “使用条款”横幅的所需文本。允许的最大长度为 4,096 个字符。 字符串
enabled “使用条款”横幅的状态。可能值:
  • true:登录 Web 界面时显示“使用条款”横幅。
  • false:登录 Web 界面时不显示“使用条款”横幅。
布尔型

返回值

此方法具有以下返回值:

名称 说明 类型
banner “使用条款”横幅的当前文本。即使该横幅已禁用,此值也可以包含文本。 字符串
enabled “使用条款”横幅的状态。可能值:
  • true:登录 Web 界面时显示“使用条款”横幅。
  • false:登录 Web 界面时不显示“使用条款”横幅。
布尔型

请求示例

此方法的请求类似于以下示例:

{
  "id": 3920,
  "method": "SetLoginBanner",
  "params": {
    "banner": "Welcome to NetApp!",
    "enabled": true
  }
}

响应示例

此方法返回类似于以下示例的响应:

{
  "id": 3920,
  "result": {
    "loginBanner": {
      "banner": "Welcome to NetApp!",
      "enabled": true
    }
  }
}