You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
62 lines
1.4 KiB
62 lines
1.4 KiB
# 密码状态接口文档
|
|
|
|
## 获取密码状态
|
|
|
|
### 接口描述
|
|
|
|
获取当前密码功能的启用状态。
|
|
|
|
### 基本信息
|
|
|
|
| 属性 | 值 |
|
|
|------|-----|
|
|
| 方法名 | `/m9z/password/status` |
|
|
| 请求方式 | POST (JSON-RPC) |
|
|
| 是否需要认证 | 否（免白名单） |
|
|
| 描述 | 查询密码保护功能的当前启用状态 |
|
|
|
|
### 请求参数
|
|
|
|
无请求参数。
|
|
|
|
### 响应参数
|
|
|
|
| 字段名 | 类型 | 必填 | 描述 |
|
|
|--------|------|------|------|
|
|
| enabled | boolean | 是 | 密码保护功能是否已启用 |
|
|
|
|
### 响应示例
|
|
|
|
**成功响应：**
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"id": 1,
|
|
"result": {
|
|
"enabled": true
|
|
}
|
|
}
|
|
```
|
|
|
|
**响应字段说明：**
|
|
|
|
| 字段 | 说明 |
|
|
|------|------|
|
|
| `enabled: true` | 密码保护已启用，所有需要认证的接口必须先通过密码验证 |
|
|
| `enabled: false` | 密码保护已禁用，所有接口可直接访问 |
|
|
|
|
### 相关接口
|
|
|
|
| 接口 | 方法 | 描述 |
|
|
|------|------|------|
|
|
| 密码验证 | `/m9z/password/verify` | 验证密码并获取会话 ID |
|
|
| 修改密码 | `/m9z/password/change` | 修改当前密码 |
|
|
| 启用密码 | `/m9z/password/enable` | 启用密码保护 |
|
|
| 禁用密码 | `/m9z/password/disable` | 禁用密码保护 |
|
|
|
|
### 备注
|
|
|
|
- 该接口无需认证，属于白名单接口
|
|
- `enabled` 状态值存储在配置文件中，重启服务后会恢复为配置文件中的默认值
|
|
- 默认密码为 `123456`，盐值为 `m9zTty`
|