設定並使用 Canva 管理員 API

你可以使用 Canva Admin API，透過自己的系統自動化管理組織。管理用戶、團隊、群組和成員資格，並擷取稽核日誌事件，無需在 Canva 手動完成這些工作。

• 適用於 Canva Enterprise、Canva 學區和 Canva 校園版。
• 組織管理員可以使用。
• 適用於單一團隊和多團隊組織。

設定 Admin API 前，請確認你的組織符合以下要求：

• 組織層級： Admin API 適用於組織層級。Canva Enterprise、Canva 學區和 Canva 校園版方案中的單一團隊及多團隊組織均可使用。
• 組織管理員帳戶： 只有組織管理員可以在 Canva 設定中建立和管理 Admin API 用戶端。
• 內部或外判工程團隊：你的組織需要工程資源來建立和維護整合。Canva 不提供實作支援。
  • 如果你的團隊無法使用 API 建置整合，SCIM 佈建 會更適合用來自動化管理組織中的用戶。
• 熟悉 Canva 組織架構：建立整合前，請清楚了解組織、團隊和群組在 Canva 中的設定方式。
• 多重驗證 (MFA) 或由單一登入 (SSO) 管理的帳戶： 設定 Admin API 的組織管理員必須啟用 MFA，或使用由 SSO 管理的帳戶。該帳戶必須由其代表行事的組織管理或擁有。

Admin API 提供以下端點：

• 用戶、團隊和群組：建立、讀取、更新和刪除。
• 成員資格：將成員加入團隊和群組，或從中移除，並設定其角色。
• 稽核日誌：按排程擷取稽核日誌事件。
• 團隊邀請：邀請成員加入團隊（包括組織以外的人士）、檢視待處理的邀請、按完整電郵地址擷取現有邀請連結，以及取消邀請。

組織管理員會建立 Admin API 用戶端，並透過該用戶端呼叫 API。

請按照Canva Admin API 文件說明，以用戶端憑證換取存取憑證，並開始發出 API 請求。

如需了解 API 請求驗證及使用 OAuth 2.0 bearer token 的技術詳情，請將 Canva Admin API 驗證說明分享給你的工程團隊。

透過 Admin API 執行的操作會記錄在 Admin API 用戶端名下，而非呼叫該用戶端的個別管理員名下。

在稽核日誌中，「Actor」欄位會顯示 Admin API 用戶端名稱和用戶端 ID，方便你識別是哪個整合執行了操作。

你亦可以識別建立、更新或刪除特定 API 用戶端的組織管理員。

如需更多資訊，請參閱關於 Canva 稽核日誌。

組織管理員可以使用 Admin API 邀請成員加入團隊，包括組織以外的外部協作者。

須知事項

• 每個邀請只適用於一個團隊和一個電郵地址。
• 每個邀請只可使用一次，並會在30 天後到期。
• 視乎你的設定，Canva 未必會自動向受邀者發送電郵。如有需要，請直接將邀請連結分享給受邀者。
• 請妥善保管邀請連結。每個邀請連結只適用於建立邀請時指定的電郵地址。
• 你邀請的成員仍須遵守團隊現有的邀請和網域設定。
• 如果受邀者已有待處理的邀請，建立新邀請時會返回相同的邀請記錄，並將到期日重設為提出要求後 30 天，同時將邀請角色更新為要求指定的角色。

如需了解端點詳情，請參閱Canva Admin API 文件。

Admin API 和 SCIM 均可支援用戶佈建。

除了用戶佈建，Admin API 還支援 Canva 組織管理，包括團隊、群組、成員資格和稽核日誌。

SCIM 支援標準佈建和取消佈建。如果你只需要標準用戶佈建，或團隊無法建立自訂 API 整合，SCIM 會更符合你的需求。

我的組織需要聘用開發人員才能使用 Admin API 嗎？

需要。你的組織必須具備內部或外判工程資源，以建立和維護整合。Canva 不提供實作支援。如果你的團隊無法使用 API 建置整合，SCIM 佈建會更適合用來自動化管理組織中的用戶。

組織中的所有人都需要使用 MFA 或 SSO 才能使用 Admin API 嗎？

不需要。只有設定 Admin API 的組織管理員必須啟用 MFA，或使用由 SSO 管理的帳戶。該帳戶必須由其代表行事的組織管理或擁有。組織中的其他成員無需特別使用 MFA 或 SSO，Admin API 才能運作。

我的組織可以使用 Admin API 邀請外部協作者嗎？

可以。組織管理員可以使用 Admin API 邀請成員加入團隊，包括外部協作者。你邀請的成員仍須遵守團隊現有的邀請和網域設定。

我們可以再次擷取現有邀請連結，而無需建立新邀請嗎？

可以。你可以使用受邀者的完整電郵地址擷取現有邀請連結，無需建立新邀請。