API 令牌配置

Alauda Security Service 允许你在 集成 页面管理 API 令牌。在当前 UI 中,API 令牌归类在 认证令牌 下。

要点

  • API 令牌通常用于 CI/CD、脚本、自动化以及 API 访问。
  • 当你创建新令牌时,你的角色权限会限制你可以为该令牌分配的权限。
  • 如果你希望自定义角色为其他用户创建令牌,则必须为该自定义角色分配所需权限。
  • 认证令牌 部分,UI 会将 API Token 作为专用令牌类型展示,并提供 Generate token 操作。
  • 令牌创建流程包含以下字段:
    • 令牌名称
    • 角色
    • 到期日期
  • 如果你未设置 到期日期,默认值为生成日期起一年后。

操作步骤

  1. 在 Alauda Security Service 门户中,转到 Platform Configuration > Integrations
  2. 滚动到 认证令牌 部分。
  3. 单击 API Token
  4. 单击 Generate token
  5. 令牌名称 中输入一个值。
  6. 选择提供所需访问级别的角色,例如 Continuous IntegrationSensor Creator
  7. (可选)设置 到期日期。如果你将其留空,令牌将在生成日期一年后过期。
  8. 单击 Generate

重要: 复制生成的令牌并妥善保管。你将无法再次查看它。

令牌过期与通知

API 令牌会在创建日期一年后过期。当某个令牌将在少于一周内过期时,Alauda Security Service 会在 Web 界面中提醒你,并通过向 Central 发送日志消息进行通知。

日志消息格式:

Warn: API Token [token name] (ID [token ID]) will expire in less than X days.

配置通知设置

你可以通过配置以下环境变量来更改令牌过期日志进程的默认设置:

Environment VariableDefault ValueDescription
ROX_TOKEN_EXPIRATION_NOTIFIER_INTERVAL1h后台进程检查并记录即将过期令牌的频率。
ROX_TOKEN_EXPIRATION_NOTIFIER_BACKOFF_INTERVAL24h针对即将过期令牌发出通知的频率。
ROX_TOKEN_EXPIRATION_DETECTION_WINDOW168h在令牌过期前触发通知的时间窗口。