# 身份与权限 ## 认证任务速查 | 用户意图 | 首选命令 / 回答 | |---|---| | 获取全部权限 | `lark-cli auth login --domain all --no-wait --json` | | 按业务域授权 | `lark-cli auth login --domain docs --domain drive --no-wait --json`;`--domain` 可重复,也可用逗号分隔 | | 指定单个 scope 授权 | `lark-cli auth login --scope "" --no-wait --json` | | 检查当前登录态、是谁登录、token 是否有效 | `lark-cli auth status --json --verify`;回答时引用 `identity`、`verified`、`identities.user.status`、`identities.user.userName`、`identities.user.openId`(用户 open id)、`identities.user.tokenStatus`、`identities.user.scope` | | 快速查看当前身份状态 | `lark-cli whoami`;实际生效的那一个身份 | | 退出当前机器的用户登录态 | `lark-cli auth logout --json`;`loggedOut:true` 表示注销成功 | | bot 缺少权限 | 不要执行 `auth login`;引导用户在开发者后台开通 bot scope,优先复用错误里的 `console_url` | | 取消用户对应用的全部服务端授权 | `auth logout` 只清本机登录态;服务端授权需用户在飞书授权管理页取消 | | 只取消一个 scope | CLI 不支持单独撤销一个已授予 scope;可重新走最小 scope 授权,或让用户在授权管理页处理 | 机器读取 JSON 时,为减少 `_notice` 干扰,可在命令前加: ```bash LARKSUITE_CLI_NO_UPDATE_NOTIFIER=1 LARKSUITE_CLI_NO_SKILLS_NOTIFIER=1 lark-cli auth status --json --verify ``` ## 身份类型 两种身份类型,通过 `--as` 切换: | 身份 | 标识 | 获取方式 | 适用场景 | |------|------|---------|---------| | user 用户身份 | `--as user` | `lark-cli auth login` 等 | 访问用户自己的资源(日历、云空间/云盘/云存储等) | | bot 应用身份 | `--as bot` | 自动,只需 appId + appSecret | 应用级操作,访问bot自己的资源 | ## 身份选择原则 输出的 `[identity: bot/user]` 代表当前身份。bot 与 user 表现差异很大,需确认身份符合目标需求: - **Bot 看不到用户资源**:无法访问用户的日历、云空间(云盘/云存储)文档、邮箱等个人资源。例如 `--as bot` 查日程返回 bot 自己的(空)日历 - **Bot 无法代表用户操作**:发消息以应用名义发送,创建文档归属 bot - **Bot 权限**:只需在飞书开发者后台开通 scope,无需 `auth login` - **User 权限**:后台开通 scope + 用户通过 `auth login` 授权,两层都要满足 ## 身份延续 - CLI命令执行时,身份选择优先级为:显式 `--as` 优先;省略时由 CLI 根据当前配置和可用凭证自动选择(可通过 `lark-cli whoami` 查看 `identity` 和选择逻辑)。 - 因此,盲目省略 `--as` 是不可控的,在明确需要保持某一身份时,建议全程显式选择。 ## 权限不足处理 遇到权限相关错误时,**根据当前身份类型采取不同解决方案**。 错误响应中包含关键信息: - `missing_scopes`:列出缺失的 scope (N选1) - `console_url`:飞书开发者后台的权限配置链接 - `hint`:建议的修复命令 ### Bot 身份(`--as bot`) 将错误中的 `console_url` 原样提供给用户,引导去后台开通 scope。**禁止**对 bot 执行 `auth login`。 ### User 身份(`--as user`) ```bash lark-cli auth login --domain --no-wait --json # 按业务域发起授权 lark-cli auth login --scope "" --no-wait --json # 按具体 scope 发起授权(推荐,符合最小权限原则) ``` **规则**:auth login 必须指定范围(`--scope`、`--domain` 或 `--recommend`)。多次 login 的 scope 会累积(增量授权)。 ### Agent 代理发起认证(推荐) 当你作为 AI agent 需要帮用户完成认证时,优先使用 split-flow,避免在同一轮对话中阻塞等待用户授权: ```bash # 发起授权(立即返回 device_code 和 verification_url) lark-cli auth login --scope "calendar:calendar:readonly" --no-wait --json ``` 拿到 `verification_url` 后,将它原样作为本轮最终消息发给用户,并结束本轮/交还控制权。不要在同一轮中展示 URL 后立刻执行 `--device-code` 阻塞轮询;在不透传中间输出的 agent harness 里,这会导致用户永远看不到 URL。 用户回复已完成授权后,再在后续步骤执行: ```bash lark-cli auth login --device-code ``` **Split-Flow 完整步骤**: **第一步:发起授权(当前轮)** 1. 执行 `lark-cli auth login --scope "xxx" --no-wait --json`(必须加 `--no-wait --json`) 2. 从 JSON 输出中提取 `verification_url` 和 `device_code` 3. 生成二维码:`lark-cli auth qrcode --output "xxx"` 4. 将 URL 和二维码展示给用户(先 URL,后二维码) 5. **结束本轮对话前,必须明确告知用户**:"请完成授权后,回来告诉我已授权完成,我会帮你完成后续步骤" **第二步:完成授权(后续轮)** 1. 等待用户回复"已完成授权" 2. **由你(AI agent)亲自执行**:`lark-cli auth login --device-code ` 3. 此命令会轮询授权状态并完成登录 4. 如果返回授权成功,流程结束 **关键规则**: - **你必须亲自执行 `--device-code` 命令**,不要指示用户自行执行 - **不要在同一轮中展示 URL 后立刻执行 `--device-code`**,这会导致用户看不到 URL - **禁止跨流程缓存 `verification_url` 或 `device_code`**:每次需要重新发起授权时,必须沿用所需的 `--scope`、`--domain` 或 `--recommend` 选择以及任何 `--exclude` 值,并附加 `--no-wait --json` 生成新的链接。不要复用已过期的授权链接或 device code