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

Canva Admin APIを使うと、独自のシステムから組織の管理を自動化できます。ユーザー、チーム、グループ、メンバーシップを管理したり、管理ログのイベントを取得したりできるため、Canva上でこれらの作業を手動で行う必要はありません。

• Canvaエンタープライズ、Canva Districts、Canva大学・専門学校（教育機関）でご利用いただけます。
• 組織の管理者が利用できます。
• チームが1つの組織と複数のチームがある組織のどちらでもご利用いただけます。

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

• 組織レベル: Admin APIは組織単位で利用できます。Canvaエンタープライズ、Canva Districts、Canva大学・専門学校（教育機関）のプランでは、チームが1つの組織と複数のチームがある組織のどちらでも利用できます。
• 組織の管理者アカウント: 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クライアントに記録されます。

管理ログの「Actor」フィールドには、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を使ってチームにメンバーを招待できます。外部コラボレーターも招待できます。招待するメンバーにも、チームに設定されている既存の招待設定とドメイン設定が適用されます。

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

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