设置并使用Canva可画管理员API

你可以使用 Canva可画管理员 API，从自己的系统自动执行组织管理任务。管理用户、团队、群组和成员关系，并检索审计日志事件，无需在 Canva可画中手动完成这些任务。

• 适用于 Canva可画企业版、Canva可画学区版和 Canva可画校园版。
• 组织管理员可以使用。
• 适用于单团队和多团队组织。

在设置管理员 API 之前，请确认你的组织满足以下要求：

• 组织层级： 管理员 API 的适用范围是组织。Canva可画企业版、Canva可画学区版和 Canva可画校园版的单团队和多团队组织均可使用。
• 组织管理员账号： 只有组织管理员可以在 Canva可画设置中创建和管理管理员 API 客户端。
• 内部或外包工程资源：你的组织需要具备工程资源来构建和维护集成。Canva可画不提供实施支持。
  • 如果你的团队无法基于 API 进行开发，使用 SCIM 配置自动管理组织中的用户会更合适。
• 熟悉 Canva可画组织结构：在构建集成之前，请先清楚了解组织、团队和群组在 Canva可画中的设置方式。
• 多重身份验证 (MFA) 或由单点登录（SSO）管理的账号： 配置管理员 API 的组织管理员必须启用 MFA，或使用由 SSO 管理的账号。该账号必须由其代表的组织管理或拥有。

管理员 API 提供以下端点：

• 用户、团队和群组：创建、读取、更新和删除。
• 成员关系：将成员添加到团队和群组或从中移除，并设置其角色。
• 审计日志：按计划检索审计日志事件。
• 团队邀请：邀请成员加入团队（包括组织外部的成员）、查看待处理邀请、通过准确的电子邮件地址检索现有邀请链接，以及取消邀请。

组织管理员创建管理员 API 客户端，并使用该客户端调用 API。

按照 Canva可画管理员 API 文档，将客户端凭据兑换为访问令牌，然后开始发送 API 请求。

如需了解 API 请求身份验证和 OAuth 2.0 持有者令牌的技术细节，请将 Canva可画管理员 API 身份验证文档分享给你的工程团队。

通过管理员 API 执行的操作会记录在管理员 API 客户端名下，而不是调用该客户端的管理员个人名下。

在审计日志中，“操作者”字段会显示管理员 API 客户端名称和客户端 ID，帮助你识别执行操作的集成。

你也可以查看创建、更新或删除特定 API 客户端的组织管理员。

如需了解详情，请参阅 关于 Canva可画审计日志。

组织管理员可以使用管理员 API 邀请成员加入团队，包括组织外部的协作者。

须知

• 每份邀请仅适用于一个团队和一个电子邮件地址。
• 每份邀请只能使用一次，并且会在 30 天后过期。
• 根据你的设置，Canva可画可能不会自动向受邀者发送电子邮件。如有需要，请直接将邀请链接分享给受邀者。
• 请妥善保管邀请链接。邀请链接仅对创建邀请时指定的电子邮件地址有效。
• 团队现有的邀请和域名设置仍适用于你邀请的成员。
• 如果受邀者已有待处理邀请，创建新邀请时会返回同一条邀请记录；邀请有效期将重置为自请求之日起 30 天，且邀请角色会更新为所请求的角色。

如需了解端点详情，请参阅Canva可画管理员 API 文档。

管理员 API 和 SCIM 都支持用户配置。

管理员 API 除了支持用户配置，还支持 Canva可画组织管理，包括团队、群组、成员关系和审计日志。

SCIM 支持标准配置和取消配置。如果你只需要标准用户配置，或者团队无法构建自定义 API 集成，那么 SCIM 会更适合你的需求。

我的组织需要开发人员才能使用管理员 API 吗？

是的。使用管理员 API 要求组织具备内部或外包工程资源，以构建和维护集成。Canva可画不提供实施支持。如果你的团队无法基于 API 进行开发，使用SCIM 配置自动管理组织中的用户会更合适。

组织中的每个人都需要启用 MFA 或使用 SSO，才能使用管理员 API 吗？

不需要。只有配置管理员 API 的组织管理员必须启用 MFA，或使用由 SSO 管理的账号。该账号必须由其代表的组织管理或拥有。组织中的其他成员无需专门启用 MFA 或使用 SSO，管理员 API 也能正常运行。

我的组织可以使用管理员 API 邀请外部协作者吗？

可以。组织管理员可以使用管理员 API 邀请成员加入团队，包括外部协作者。团队现有的邀请和域名设置仍适用于你邀请的成员。

我们能否再次检索现有邀请链接，而不创建新邀请？

可以。你可以通过受邀者准确的电子邮件地址检索现有邀请链接，无需生成新邀请。