权限范围

全部 scope 的含义、取得方式与两组蕴含关系。

应用可申请的 scope 在控制台勾选,换取令牌时请求的 scope 不得超出该集合。标注「需用户授权」的 scope 仅可通过授权码流程取得;即使已在控制台勾选,客户端凭据流程签发的令牌也不会包含它们。其余 scope 两种流程都可取得,授权码流程签发的令牌同样可以携带 catalog scope 去调用条目端点。

openid需用户授权
以 Hikarinagi 账号登录标准 OIDC 登录,签发 ID 令牌并返回用户的唯一标识 sub
profile需用户授权
读取标准资料声明OIDC profile 声明:用户名、昵称与头像
email需用户授权
读取邮箱地址OIDC email 声明:授权用户的邮箱及其验证状态
offline_access需用户授权
保持登录状态签发刷新令牌,应用可在用户离线时续期访问令牌
catalog:read
读取条目数据不含 NSFW 与乙女向条目
catalog:full
读取条目数据(全部)含 NSFW 与乙女向条目;用户令牌下以该用户账号的内容偏好为上限
catalog:sync
同步条目数据读取条目变更事件流,并在 Galgame、厂商、角色详情中返回 VNDB 与 Bangumi ID;不含 catalog:read
user:read需用户授权
读取用户公开资料授权用户的用户名、昵称、头像与简介
status:read需用户授权
读取用户的状态与评分授权用户在游戏/轻小说/漫画上的观看游玩状态、评分与短评
status:write需用户授权
修改用户的状态与评分代替授权用户标记状态、打分、撤回记录;含 status:read 的读取权限
collection:read需用户授权
读取用户的收藏夹授权用户的收藏夹列表及其中收录的作品
collection:write需用户授权
修改用户的收藏夹代替授权用户新建收藏夹、收录或移除作品;含 collection:read 的读取权限

存在两组蕴含关系:catalog:full 包含 catalog:read,status:write 包含 status:read。申请上位 scope 即可,无需重复勾选。

catalog:sync 面向镜像与同步类应用:它开放条目变更事件流,并让 Galgame、厂商、角色详情多返回一个 external_source 字段(VNDB 与 Bangumi ID);不持有该 scope 时详情中不出现此字段。它不包含 catalog:read,读取条目详情仍需同时申请 catalog:read 或 catalog:full。