获取访问控制列表
调用该接口以当前身份(应用或用户)获取指定日历的访问控制列表。
Tip: - 当前身份由 Header Authorization 的 Token 类型决定。tenant_access_token 指应用身份,user_access_token 指用户身份。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/calendar/v4/calendars/:calendar_id/acls |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | calendar:calendar 更新日历及日程信息 calendar:calendar.acl:read 读取日历访问控制权限 calendar:calendar:readonly 获取日历、日程及忙闲信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
calendar_id | string | 日历 ID。 创建共享日历时会返回日历 ID。你也可以调用以下接口获取某一日历的 ID。 - 查询主日历信息 - 查询日历列表 - 搜索日历 示例值:"feishu.cn_xxxxxxxxxx@group.calendar.feishu.cn" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id_type | string | 否 | 用户 ID 类型 示例值:open_id 可选值有: - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:xxx |
page_size | int | 否 | 分页大小,即一次请求返回的最大条目数。 注意:最小值 10,即取值小于 10 时统一按 10 处理。 示例值:10 默认值: 20数据校验规则: - 最大值: 50 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ acls | calendar.acl\[\] | 日历对应的访问控制列表。 |
└ acl_id | string | 访问控制 ID。该 ID 在单个日历实体内唯一,不同日历实体可能存在重复的访问控制 ID。 |
└ role | string | 对日历的访问权限。 可选值有: - unknown: 未知权限。 - free_busy_reader: 游客,只能看到忙碌、空闲信息。 - reader: 订阅者,可查看所有日程详情。 - writer: 编辑者,可创建及修改日程。 - owner: 管理员,可管理日历及共享设置。 |
└ scope | acl_scope | 权限生效范围。 |
└ type | string | 权限生效范围的类型。 可选值有: - user: 用户 |
└ user_id | string | 用户 ID,更多介绍可参见用户相关的 ID 概念。 |
└ has_more | boolean | 是否还有更多项 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"acls": [
{
"acl_id": "user_xxxxxx",
"role": "writer",
"scope": {
"type": "user",
"user_id": "ou_xxxxxx"
}
}
],
"has_more": false,
"page_token": "xxx"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 190002 | invalid parameters in request | 无效的请求参数。排查建议如下: - 确认请求参数的字段名称、传参类型正确。 - 确认已经申请了相应资源的权限。 - 确认相应资源未被删除。 |
| 500 | 190003 | internal service error | 内部服务错误,请咨询技术支持。 |
| 429 | 190004 | method rate limited | 方法频率限制。建议稍后再试,并适当减小请求 QPS。 |
| 429 | 190005 | app rate limited | 应用频率限制。建议稍后再试,并适当减小请求 QPS。 |
| 403 | 190006 | wrong unit for app tenant | 请求错误。你需要检查应用 App ID 和 App Secret 是否正确,如仍未解决请咨询技术支持。 |
| 404 | 190007 | app bot_id not found | 应用的 bot_id 没有找到。你需要确保应用开启了机器人能力。如仍未解决请咨询技术支持。 |
| 400 | 190008 | page_token or sync_token expired | page_token 或 sync_token 已过期。你需要置空 token 参数值,然后重试。 |
| 429 | 190010 | current operation rate limited | 当前操作被限流,原因一般为公用资源并发抢占失败。你可以适当降低当前操作频率,然后重试。 |
| 404 | 191000 | calendar not found | 日历没有找到。你需要检查并改为正确的日历 ID。 |
| 400 | 191001 | invalid calendar_id | calendar_id 无效。你需要检查并改为正确的日历 ID。 |
| 403 | 191002 | no calendar access_role | 当前身份没有日历的访问权限。如需查询某一日历信息,则需要确保当前身份拥有该日历的访问权限。 |
| 403 | 191003 | calendar is deleted | 日历已经被删除。你需要检查并改为正确的日历 ID。 |
| 403 | 191004 | invalid calendar type | 日历类型错误。你可以调用查询日历信息接口获取日历类型信息,然后确保日历类型适用于当前接口。 |
| 404 | 192000 | acl not found | 访问控制(ACL)未找到。你需要确保传入了正确的 ACL ID。 |
| 404 | 195100 | user is dismiss or not exist in the tenant | 当前身份或指定用户已经离职,或者不在该租户内。请检查并改为正确的身份来调用接口。 |
更多错误码信息,参见通用错误码。
