设置登录横幅

11/12/2025 贡献者

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

参数

该方法有以下输入参数：

名称描述类型默认值必填项

名称	描述	类型	默认值	必填项
横幅	使用条款横幅的所需文本。允许的最大长度为 4,096 个字符。	string	无	否
启用	使用条款横幅的状态。可能值： `true`登录网页界面后，将显示“使用条款”横幅。 `false`：登录网页界面后，不会显示“使用条款”横幅。	布尔值	无	否

横幅

使用条款横幅的所需文本。允许的最大长度为 4,096 个字符。

string

无

否

启用

使用条款横幅的状态。可能值：

布尔值

无

否

此方法具有以下返回值：

名称	描述	类型
横幅	使用条款横幅的当前文本。即使横幅广告被禁用，此值也可以包含文本。	string
启用	使用条款横幅的状态。可能值：正确：登录网页界面后会显示使用条款横幅。错误：登录网页界面后，未显示“使用条款”横幅。	布尔值

名称

描述

类型

横幅

使用条款横幅的当前文本。即使横幅广告被禁用，此值也可以包含文本。

string

启用

使用条款横幅的状态。可能值：

布尔值

该方法的请求类似于以下示例：

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

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

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

10.0