对象

ApiKeyCreate

字段

• namestring必填

  length ≥ 1, length ≤ 64

• rolestring

  默认值："editor"

• data_profilestring | null

  密钥的数据权限档案。不传时，密钥获得组织的默认档案。数据权限档案不适用于 admin 角色。管理员密钥可以看到组织的所有数据，指定 full 以外的档案会返回 400 api_keys.data_profile_not_applicable。

• expires_atstring (date-time) | null

  密钥的过期时间（ISO 8601，须为将来的时间）。null 或不传值表示密钥永不过期。

• scopesarray of ApiKeyScope | null

  密钥的权限范围。不传时按角色确定：admin 获得 read、write、admin；editor 和 verifier 获得 read、write；viewer 获得 read。权限范围 system 只能由部署管理员签发。也接受细粒度的 resource:action 权限范围（ApiKeyScope）；旧版的 read、write 和 admin 会展开为相应的权限范围集合。

• collection_idsarray of integer | null

  将密钥限制在组织的这些合集中。卡片、搜索、回答和事件只在这些合集中有效，此限制叠加在角色和数据权限档案之上。不传值或传入空列表表示不限制。如果发起调用的密钥本身仅限部分合集，新密钥只能位于它的合集中。不传该字段时，新密钥获得发起调用的密钥的合集。传入空列表或不在其列表中的合集时，返回 400 api_keys.invalid_collections。

  items ≤ 100

• allowed_cidrsarray of string | null

  可使用该密钥的网络，例如 10.0.0.0/8 或 2001:db8::/32。单个地址视为只含一个地址的网络。来自其他地址的请求返回 403 api_keys.ip_not_allowed。不传值表示不限制。

  items ≤ 50

使用方

• POST/v1/api-keys创建 API 密钥