Skip to content

创建访问控制

调用该接口以当前身份(应用或用户)为指定日历添加访问控制,即日历成员权限。

Tip: - 当前身份由 Header Authorization 的 Token 类型决定。tenant_access_token 指应用身份,user_access_token 指用户身份。

  • 如果使用应用身份调用该接口,则需要确保应用开启了机器人能力
  • 当前身份需要有日历的 owner 权限,并且日历的类型只能为 primary 或 shared。你可以调用查询日历信息接口,获取日历类型以及当前身份对该日历的访问权限。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/calendar/v4/calendars/:calendar_id/acls
HTTP MethodPOST
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可calendar:calendar 更新日历及日程信息 calendar:calendar.acl:create 新增日历访问控制权限
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
calendar_idstring需要添加访问控制的日历 ID。
创建共享日历时会返回日历 ID。你也可以调用以下接口获取某一日历的 ID。 - 查询主日历信息 - 查询日历列表 - 搜索日历
示例值:"feishu.cn_xxxxxxxxxx@group.calendar.feishu.cn"

查询参数

名称类型必填描述
user_id_typestring用户 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

请求体

名称类型必填描述
rolestring对日历的访问权限。
示例值:"writer"
可选值有
- unknown: 未知权限。unknown 是 role 参数枚举值之一,但 role 作为请求参数时,不支持传入 unknown。 - free_busy_reader: 游客,只能看到忙碌、空闲信息。 - reader: 订阅者,可查看所有日程详情。 - writer: 编辑者,可创建及修改日程。 - owner: 管理员,可管理日历及共享设置。
scopeacl_scope权限的生效范围。
  └ typestring权限生效范围的类型。
注意:目前只支持 user,且当 type=user 时,user_id 需要传入和 user_id_type 一致的用户 ID 类型。例如,user_id_type=open_id 时,user_id 需要传入用户的 open_id。
示例值:"user"
可选值有
- user: 用户
  └ user_idstring用户 ID。当 type=user 时,必须设置该参数值。关于用户 ID 的更多介绍可参见用户相关的 ID 概念
示例值:"ou_xxxxxx"

请求体示例

json
{
    "role": "writer",
    "scope": {
        "type": "user",
        "user_id": "ou_xxxxxx"
    }
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
datacalendar.acl-
  └ acl_idstring访问控制 ID。该 ID 在单个日历实体内唯一,不同日历实体可能存在重复的访问控制 ID。
  └ rolestring对日历的访问权限。
可选值有
- unknown: 未知权限。 - free_busy_reader: 游客,只能看到忙碌、空闲信息。 - reader: 订阅者,可查看所有日程详情。 - writer: 编辑者,可创建及修改日程。 - owner: 管理员,可管理日历及共享设置。
  └ scopeacl_scope权限生效范围。
    └ typestring权限生效范围的类型。
可选值有
- user: 用户
    └ user_idstring用户 ID,更多介绍可参见用户相关的 ID 概念

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "acl_id": "user_xxxxxx",
        "role": "writer",
        "scope": {
            "type": "user",
            "user_id": "ou_xxxxxx"
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
400190002invalid parameters in request无效的请求参数。排查建议如下: - 确认请求参数的字段名称、传参类型正确。 - 确认已经申请了相应资源的权限。 - 确认相应资源未被删除。
500190003internal service error内部服务错误,请咨询技术支持
429190004method rate limited方法频率限制。建议稍后再试,并适当减小请求 QPS。
429190005app rate limited应用频率限制。建议稍后再试,并适当减小请求 QPS。
403190006wrong unit for app tenant请求错误。你需要检查应用 App ID 和 App Secret 是否正确,如仍未解决请咨询技术支持
404190007app bot_id not found应用的 bot_id 没有找到。你需要确保应用开启了机器人能力。如仍未解决请咨询技术支持
429190010current operation rate limited当前操作被限流,原因一般为公用资源并发抢占失败。你可以适当降低当前操作频率,然后重试。
404191000calendar not found日历没有找到。你需要检查并改为正确的日历 ID。
400191001invalid calendar_idcalendar_id 无效。你需要检查并改为正确的日历 ID。
403191002no calendar access_role当前身份没有日历的访问权限。如需查询某一日历信息,则需要确保当前身份拥有该日历的访问权限。
403191003calendar is deleted日历已经被删除。你需要检查并改为正确的日历 ID。
403191004invalid calendar type日历类型错误。你可以调用查询日历信息接口获取日历类型信息,然后确保日历类型适用于当前接口。
404192000acl not found访问控制(ACL)未找到。你需要确保传入了正确的 ACL ID。
404195100user is dismiss or not exist in the tenant当前身份或指定用户已经离职,或者不在该租户内。请检查并改为正确的身份来调用接口。

更多错误码信息,参见通用错误码

内容来源:飞书开放平台 · 自动爬取整理