Automate Certificates 文档

API 密钥和权限范围

API 密钥让脚本或服务无需有人登录即可访问您的工作区。密钥带有权限范围,因此可以把密钥限制在其任务所需的范围内。

创建密钥

  1. 以管理员身份登录并打开 API Keys。
  2. 为密钥命名,选择其权限范围,也可以设置以天为单位的有效期。
  3. 密钥显示时请立即复制。密钥以 xcrt_ 开头,之后无法再次显示。

只有已登录的管理员才能创建或吊销密钥,并且密钥只能获得其创建者拥有的权限范围。除非您另行选择,新密钥默认获得 certs:read。

使用密钥

curl -H "Authorization: Bearer xcrt_your_key" \
     https://api.automate-certificates.com/v1/certificates

权限范围

范围允许
certs:read列出并读取证书及其验证。
certs:write申请、续期、导入、吊销和删除证书。
targets:read列出并读取目标。
targets:write创建、更改和删除目标。
deploy:read读取部署。
deploy:execute运行部署并管理部署规则。
monitoring:read读取监控结果。
alerts:read读取告警。
alerts:write设置告警规则并管理 Webhook。
audit:read读取审计日志。

限定范围的密钥不能做什么

管理成员、角色、API 密钥、ACME 账户和云凭据需要已登录的管理员或完全访问密钥。限定范围的密钥会被拒绝并返回 403 insufficient_scope,即使其所有者是管理员。少数管理员操作,例如运行 Discovery 扫描或批量续期,接受持有相应范围且属于管理员的密钥。

限制

每个套餐允许固定数量的密钥。每个工作区的请求限制为每分钟 120 次。