Canva管理者APIを設定して使用する

Canva Admin APIを使うと、独自のシステムから組織管理を自動化できます。ユーザー、チーム、グループ、メンバーシップを管理したり、Canvaで手作業を行わずに管理ログのイベントを取得したりできます。

• Canvaエンタープライズ、Canva Districts、Canva大学・専門学校（教育機関）でご利用いただけます。
• 組織の管理者が利用できます。
• 単一チームおよび複数チームの組織で利用できます。

Admin APIを設定する前に、組織が次の要件を満たしていることを確認してください。

• 組織レベル： Admin APIは組織単位で利用できます。Canvaエンタープライズ、Canva Districts、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ベアラートークンの使用に関する技術的な詳細については、 Canva Admin APIの認証に関するドキュメントをエンジニアリングチームに共有してください。

Admin APIを通じて実行された操作は、APIを呼び出した個々の管理者ではなく、Admin APIクライアントに紐づけて記録されます。

管理ログの「実行者」欄には、Admin APIクライアント名とクライアントIDが表示されます。これにより、どの連携機能が操作を実行したかを確認できます。

特定のAPIクライアントを作成、更新、削除した組織の管理者を確認することもできます。

詳しくは、Canvaの管理ログについてをご覧ください。

組織の管理者はAdmin APIを使って、組織外の外部コラボレーターを含むメンバーをチームに招待できます。

知っておきたいこと

• 作成する招待はそれぞれ、1つのチームと1つのメールアドレスに対するものです。
• 招待はそれぞれ1回のみ使用でき、30日後に期限切れになります。
• 設定によっては、Canvaから招待相手にメールが自動送信されない場合があります。必要に応じて、招待リンクを相手に直接共有してください。
• 招待リンクは非公開にしてください。招待リンクは、作成時に指定したメールアドレスでのみ使用できます。
• 招待するメンバーには、チームに設定されている既存の招待設定とドメイン設定が適用されます。
• 招待相手に対する保留中の招待がすでにある場合、新しい招待を作成すると同じ招待レコードが返されます。リクエストから30日後に期限がリセットされ、招待のロールはリクエストされたロールに更新されます。

エンドポイントの詳細については、Canva Admin APIのドキュメントをご覧ください。

Admin APIとSCIMのどちらも、ユーザーのプロビジョニングに利用できます。

Admin APIでは、ユーザーのプロビジョニングに加えて、Canvaの組織管理も行えます。チーム、グループ、メンバーシップ、管理ログが対象です。

SCIMでは、標準的なプロビジョニングとプロビジョニング解除が行えます。標準的なユーザープロビジョニングのみが必要な場合や、チームでカスタムAPI連携機能を構築できない場合は、SCIMが適しています。

Admin APIを使うには、組織に開発者が必要ですか？

はい。Admin APIを利用するには、連携機能を構築・保守するための社内または外部委託のエンジニアリングリソースが組織に必要です。Canvaは実装サポートを提供していません。チームでAPIを使った開発が難しい場合は、組織内のユーザー管理を自動化する方法として、SCIMプロビジョニングが適しています。

Admin APIを使うには、組織内の全員がMFAまたはSSOを利用する必要がありますか？

いいえ。Admin APIを設定する組織の管理者のみ、MFAを有効にするか、SSOで管理されたアカウントを使用する必要があります。そのアカウントは、代理で操作する組織によって管理または所有されている必要があります。Admin APIを利用するために、組織の他のメンバーがMFAまたはSSOを利用する必要はありません。

Admin APIを使って、組織外のコラボレーターを招待できますか？

はい。組織の管理者はAdmin APIを使って、外部コラボレーターを含むメンバーをチームに招待できます。招待するメンバーには、チームに設定されている既存の招待設定とドメイン設定が適用されます。

新しい招待を作成せずに、既存の招待リンクを再取得できますか？

はい。招待相手のメールアドレスを正確に指定すれば、新しい招待を作成せずに既存の招待リンクを取得できます。