用户管理 users

管理员管理平台账号:增删改查、启停、重设口令、关闭动态口令。删除前须先停用。

点击任一接口,右侧显示对应的调用示例。

用户账号鉴权: 仅管理员13 个接口

鉴权

请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。

X-API-Key

鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。

约定

分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。

时间一律 RFC 3339(UTC);金额单位为分。

写操作成功回 200/201/204;重复提交按资源唯一键回 409。

GET/api/v2/users列出用户

鉴权: 仅管理员

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
idsstring 只列这些 id:逗号分隔的正整数,去重后至多 200 个(同 page_size 上限,超了或格式错 422);空串等同不传。与其他条件取交集;看不到的 id 不返回也不报错。分页照旧,一次取回要把 page_size 设成不少于 id 个数。
emailstring 邮箱
phonestring 手机号
usernamestring 用户名
POST/api/v2/users创建用户

鉴权: 仅管理员

请求体 application/json

字段类型说明
currencyCurrencyBrief 账户货币(ISO 4217)与符号,余额、充值、订单都按它记,面板金额显示用;没开过账户时为新用户默认。
emailstring 邮箱
enabledboolean 是否启用
login_ip_allowstring[] 登录 IP 白名单(IP 或 CIDR);空 = 不限。
login_verifyLoginVerify 登录二次验证:none 不要求;email / sms 登录时还要邮件/短信验证码(须平台允许且已绑定对应地址)。
可选值 ["none","email","sms"]
passwordstring 创建时必填;修改时给了即重设口令,吊销该用户全部会话并删其全部 API Key(审计 detail 记 api_keys_revoked)。
phonestring 手机号
rolestring 账号角色:admin 管理员,tenant 租户。
可选值 ["admin","tenant"]
totp_enabledboolean 是否已启用动态口令。
username必填string 用户名
POST/api/v2/users/batch批量启停或删除用户

鉴权: 仅管理员

请求体 application/json

字段类型说明
action必填string enable 启用、disable 停用、delete 删除。
可选值 ["enable","disable","delete"]
ids必填integer[] 要操作的用户 id,一次 1~100 个。
GET/api/v2/users/{id}获取用户

鉴权: 仅管理员

PUT/api/v2/users/{id}修改用户

鉴权: 仅管理员

请求体 application/json

字段类型说明
currencyCurrencyBrief 账户货币(ISO 4217)与符号,余额、充值、订单都按它记,面板金额显示用;没开过账户时为新用户默认。
emailstring 邮箱
enabledboolean 是否启用
login_ip_allowstring[] 登录 IP 白名单(IP 或 CIDR);空 = 不限。
login_verifyLoginVerify 登录二次验证:none 不要求;email / sms 登录时还要邮件/短信验证码(须平台允许且已绑定对应地址)。
可选值 ["none","email","sms"]
passwordstring 创建时必填;修改时给了即重设口令,吊销该用户全部会话并删其全部 API Key(审计 detail 记 api_keys_revoked)。
phonestring 手机号
rolestring 账号角色:admin 管理员,tenant 租户。
可选值 ["admin","tenant"]
totp_enabledboolean 是否已启用动态口令。
username必填string 用户名
PUT/api/v2/users/{user_id}/account冻结或解冻用户账户

鉴权: 仅管理员

请求体 application/json

字段类型说明
freeze_reasonstring 冻结原因;未冻结为空。
frozen必填boolean 是否已冻结;冻结后扣款一律被拒。
GET/api/v2/users/{user_id}/api-keys列出指定用户的 API Key

鉴权: 仅管理员

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
POST/api/v2/users/{user_id}/api-keys为指定用户开通 API Key

鉴权: 仅管理员

请求体 application/json

字段类型说明
allow_ipsApiKeyAllowIps 调用 IP 白名单(只收单个 IP,最多 200 个);空 = 不限。不在名单里的调用按凭据无效回 401。
expires_atstring 过期时间
name必填string 名称
passwordstring 创建时必填;修改时给了即重设口令,吊销该用户全部会话并删其全部 API Key(审计 detail 记 api_keys_revoked)。
scopes必填string[] 授权范围,取值同创建时的 scopes。
totp_codestring 操作者本人动态口令(TOTP)的 6 位当前码;账号须已启用动态口令。
PUT/api/v2/users/{user_id}/api-keys/{id}改指定用户 API Key 的 IP 白名单或重置

鉴权: 仅管理员

请求体 application/json

字段类型说明
allow_ipsApiKeyAllowIps 调用 IP 白名单(只收单个 IP,最多 200 个);空 = 不限。不在名单里的调用按凭据无效回 401。
passwordstring 创建时必填;修改时给了即重设口令,吊销该用户全部会话并删其全部 API Key(审计 detail 记 api_keys_revoked)。
resetboolean 为 true 时换新 key,旧 key 立即失效。
totp_codestring 操作者本人动态口令(TOTP)的 6 位当前码;账号须已启用动态口令。
POST/api/v2/users/{user_id}/recharges给用户充值或扣款

鉴权: 仅管理员

请求体 application/json

字段类型说明
amount_cents必填integer 金额(分),须为正整数。
currencyCurrencyBrief 账户货币(ISO 4217)与符号,余额、充值、订单都按它记,面板金额显示用;没开过账户时为新用户默认。
directionstring credit 充值(缺省)、debit 扣款。
可选值 ["credit","debit"]默认 "credit"
remarkstring 备注

用户管理对象

字段类型说明
action必填string enable 启用、disable 停用、delete 删除。
可选值 ["enable","disable","delete"]
active_packagesinteger 生效中套餐数(end_at 晚于现在,改账户货币的阻碍之一)。只有管理员 GET /users/{user_id}/account 带。
affectedinteger 处理的用户数。
allow_ipsApiKeyAllowIps 调用 IP 白名单(只收单个 IP,最多 200 个);空 = 不限。不在名单里的调用按凭据无效回 401。
amount_cents必填integer 金额(分),须为正整数。
archivedboolean 已被归档任务搬进档案表(只读)。
avatar_verinteger 头像版本,每次上传变大;没有头像为空。
balance_centsinteger 账户余额(分),同 GET /users/{user_id}/account 的 balance_cents(无账户记 0)。只有 GET /users 列表带,单个用户的读写接口不带。
只读
certifiedboolean 是否已通过实名认证。
client_ipstring 本次请求的来源 IP,与登录 IP 白名单校验用的是同一个取法(白名单比什么就显示什么)。只有 GET /me、PUT /me 带。
只读
created_atstring 创建时间
只读
currenciesAccountCurrencyOption[] 可选的启用货币(基准在前,其余按 code);仅 currency_changeable 为 true 时带,只有 GET /account 与管理员 GET /users/{user_id}/account。
currencyCurrencyBrief 账户货币(ISO 4217)与符号,余额、充值、订单都按它记,面板金额显示用;没开过账户时为新用户默认。
只读
currency_changeableboolean 租户自己现在能不能改账户货币(余额 0、无未付款订单、无生效中套餐)。只有 GET /account 与管理员 GET /users/{user_id}/account 带。
dataobject 附加数据(如套餐购买明细);在线付差额的充值单带 intent(办理意图,state 为 pending/running/done/failed,failed 时 code/reason 写明原因,done 时 user_package_id 为办理的用户套餐)。
default_currencystring 新用户默认的账户货币(ISO 4217);租户端判断「账户币没动过」用(现币 = 它才按界面语言预选)。与 currencies 同时带,仅 currency_changeable 为 true 时有,只有 GET /account 与管理员 GET /users/{user_id}/account。
delegated_sessionboolean 当前会话是否由超管代登录或切换为用户签发(是则口令、邮箱、手机号、登录白名单、二次验证与实名只读)。只有 GET /me、PUT /me 带。
只读
desstring 备注说明
directionstring credit 充值(缺省)、debit 扣款。
可选值 ["credit","debit"]默认 "credit"
emailstring 邮箱
enabledboolean 是否启用
expires_atstring 过期时间
freeze_reasonstring 冻结原因;未冻结为空。
frozenboolean 是否已冻结;冻结后扣款一律被拒。
idinteger 记录 ID
只读
ids必填integer[] 要操作的用户 id,一次 1~100 个。
ip_site_newboolean 名下有使用中(未到期)且开放 IP 网站的套餐:能新建 IP 网站、选新 IP、签 ZeroSSL 付费版(zerossl_api)证书、给 ZeroSSL 账号设 API Key。只有 GET /me 带;管理员恒为 true。
只读
ip_site_onboolean ip_site_new 为 true,或名下已有 IP 网站、IP 证书(SAN 全是 IP)、配了 API Key 的 ZeroSSL 账号任一(免费 ZeroSSL 账号不算):IP 网站相关菜单与页签可见,已有数据可查看、编辑、删除。只有 GET /me 带;管理员恒为 true。
只读
last_used_atstring 最近一次使用时间;从未使用为空。
ledger_idinteger 关联的账户流水 ID;没有则为空。
login_ip_allowstring[] 登录 IP 白名单(IP 或 CIDR);空 = 不限。
login_verifyLoginVerify 登录二次验证:none 不要求;email / sms 登录时还要邮件/短信验证码(须平台允许且已绑定对应地址)。
可选值 ["none","email","sms"]
mch_order_nostring 商户订单号(网关侧订单号);非在线支付为空。
namestring 名称
nicknamestring 昵称;没设为空(界面显示登录名)。
paid_atstring 付款时间;未付款为空。
passwordstring 创建时必填;修改时给了即重设口令,吊销该用户全部会话并删其全部 API Key(审计 detail 记 api_keys_revoked)。
pay_typestring admin/balance/alipay/wxpay 等;空 = 未付款。
phonestring 手机号
prefixstring 明文的前几位,便于辨认。
rate_to_basestring 下单时汇率:1 单位该币 = ? 基准货币(十进制串,8 位小数);之后改汇率不动历史。
remarkstring 备注
resetboolean 为 true 时换新 key,旧 key 立即失效。
rolestring 账号角色:admin 管理员,tenant 租户。
可选值 ["admin","tenant"]
scopesstring[] 授权范围,取值同创建时的 scopes。
secretstring 明文 key(X-API-Key 的值),只在创建时返回一次;库里只存哈希。
statusstring 订单状态:unpaid 待付款、paid 已付款。
可选值 ["unpaid","paid"]
tenant_idinteger 所属租户(用户)ID
只读
totp_codestring 操作者本人动态口令(TOTP)的 6 位当前码;账号须已启用动态口令。
totp_enabledboolean 是否已启用动态口令。
totp_recovery_leftinteger 未用完的 TOTP 恢复码个数。只有 GET /me、PUT /me 且已启用动态口令时带。
只读
transaction_idstring 网关侧交易号;未付款为空。
typestring recharge(管理员充值)/deduct(管理员扣款)/payment(在线支付)/package(套餐)等。
unpaid_ordersinteger 未付款订单数(改账户货币的阻碍之一)。只有管理员 GET /users/{user_id}/account 带,其余读写接口不带。
updated_atstring 更新时间
只读
user_idinteger 用户 ID
usernamestring 用户名

返回与错误

成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。

成功
{
  "id": 1,
  "name": "example"
}
列表
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
失败
{
  "code": "validation_failed",
  "detail": "请求参数不合法",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name 必填"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
开始使用

体验在线演示

访问在线演示,或联系我们获取报价与安装命令