Richte die Canva Admin-API ein und nutze sie

Mit der Canva Admin API kannst du die Verwaltung deiner Organisation über deine eigenen Systeme automatisieren. Verwalte Mitglieder, Teams, Gruppen und Mitgliedschaften und rufe Prüfungsprotokollereignisse ab, ohne diese Aufgaben manuell in Canva erledigen zu müssen.

• Verfügbar für Canva Enterprise, Canva Districts und Canva Campus.
• Für Admins der Organisation zugänglich.
• Verfügbar für Organisationen mit einem oder mehreren Teams.

Bevor du die Admin API einrichtest, stelle sicher, dass deine Organisation die folgenden Voraussetzungen erfüllt:

• Organisationsebene: Die Admin API gilt für die gesamte Organisation. Sie ist für Organisationen mit einem oder mehreren Teams in den Tarifen Canva Enterprise, Canva Districts und Canva Campus verfügbar.
• Admin-Konto der Organisation: Nur Admins der Organisation können in den Canva-Einstellungen Clients für die Admin API erstellen und verwalten.
• Interne oder externe Entwicklungsressourcen: Deine Organisation benötigt Entwicklungsressourcen, um die Integration zu erstellen und zu warten. Canva bietet keine Unterstützung bei der Implementierung.
  • Wenn dein Team keine API-Integration entwickeln kann, eignet sich die SCIM-Provisionierung besser, um die Mitgliederverwaltung in deiner Organisation zu automatisieren.
• Vertrautheit mit deiner Canva-Struktur: Mache dich vor der Entwicklung deiner Integration mit der Struktur deiner Organisation sowie ihrer Teams und Gruppen in Canva vertraut.
• Konto mit Multi-Faktor-Authentifizierung (MFA) oder Single Sign-On (SSO): Für den Admin der Organisation, der die Admin API konfiguriert, muss entweder MFA aktiviert sein oder das Konto muss über SSO verwaltet werden. Das Konto muss von der Organisation verwaltet werden oder ihr gehören, in deren Auftrag die Person handelt.

Die Admin API bietet Endpunkte für:

• Mitglieder, Teams und Gruppen: Erstellen, abrufen, aktualisieren und löschen.
• Mitgliedschaften: Personen zu Teams und Gruppen hinzufügen oder daraus entfernen und ihre Rollen festlegen.
• Prüfungsprotokolle: Prüfungsprotokollereignisse nach einem Zeitplan abrufen.
• Team-Einladungen: Personen in ein Team einladen (auch Personen außerhalb deiner Organisation), ausstehende Einladungen ansehen, einen vorhandenen Einladungslink anhand der genauen E-Mail-Adresse abrufen und Einladungen stornieren.

Ein Admin der Organisation erstellt einen Client für die Admin API und verwendet ihn für API-Aufrufe.

Folge der Dokumentation zur Canva Admin API, um deine Client-Anmeldedaten gegen ein Zugriffstoken einzutauschen und mit API-Anfragen zu beginnen.

Technische Informationen zur Authentifizierung von API-Anfragen und zur Verwendung von OAuth 2.0-Bearer-Tokens findest du in der Dokumentation zur Authentifizierung bei der Canva Admin API. Teile sie mit deinem Entwicklungsteam.

Über die Admin API ausgeführte Aktionen werden dem Client der Admin API zugeordnet und nicht dem einzelnen Admin, der den Client verwendet hat.

In den Prüfungsprotokollen werden im Feld „Akteur“ der Name und die Client-ID des Admin-API-Clients angezeigt. So kannst du erkennen, welche Integration eine Aktion ausgeführt hat.

Du kannst auch feststellen, welcher Admin der Organisation einen bestimmten API-Client erstellt, aktualisiert oder gelöscht hat.

Weitere Informationen findest du unter Über Canva-Prüfungsprotokolle.

Admins der Organisation können über die Admin API Personen in ein Team einladen, auch externe Personen außerhalb deiner Organisation.

Wichtige Hinweise

• Jede Einladung gilt für ein Team und eine E-Mail-Adresse.
• Jede Einladung kann einmal verwendet werden und läuft nach 30 Tagen ab.
• Je nach Einrichtung sendet Canva der eingeladenen Person möglicherweise nicht automatisch eine E-Mail. Teile den Einladungslink bei Bedarf direkt mit der Person.
• Halte Einladungslinks geheim. Ein Einladungslink funktioniert nur mit der E-Mail-Adresse, für die er erstellt wurde.
• Die bestehenden Einladungs- und Domaineinstellungen deines Teams gelten weiterhin für die eingeladenen Personen.
• Wenn für die eingeladene Person bereits eine ausstehende Einladung vorliegt, wird beim Erstellen einer neuen Einladung derselbe Eintrag zurückgegeben. Die Ablaufzeit wird ab der Anfrage auf 30 Tage zurückgesetzt und die Rolle der Einladung auf die angeforderte Rolle aktualisiert.

Details zu den Endpunkten findest du in der Dokumentation zur Canva Admin API.

Sowohl die Admin API als auch SCIM unterstützen die Provisionierung von Mitgliedern.

Die Admin API unterstützt neben der Provisionierung von Mitgliedern auch die Verwaltung der Canva-Organisation. Dazu gehören Teams, Gruppen, Mitgliedschaften und Prüfungsprotokolle.

SCIM unterstützt die standardmäßige Provisionierung und Deprovisionierung. Wenn du nur eine standardmäßige Provisionierung von Mitgliedern benötigst oder dein Team keine eigene API-Integration entwickeln kann, eignet sich SCIM besser.

Benötigt meine Organisation eine Entwickler:in, um die Admin API zu nutzen?

Ja. Deine Organisation benötigt interne oder externe Entwicklungsressourcen, um die Integration zu erstellen und zu warten. Canva bietet keine Unterstützung bei der Implementierung. Wenn dein Team keine API-Integration entwickeln kann, eignet sich die SCIM-Provisionierung besser, um die Mitgliederverwaltung in deiner Organisation zu automatisieren.

Benötigen alle Mitglieder meiner Organisation MFA oder SSO, um die Admin API zu nutzen?

Nein. Nur für den Admin der Organisation, der die Admin API konfiguriert, muss entweder MFA aktiviert sein oder das Konto muss über SSO verwaltet werden. Das Konto muss von der Organisation verwaltet werden oder ihr gehören, in deren Auftrag die Person handelt. Andere Mitglieder der Organisation benötigen weder MFA noch SSO, damit die Admin API funktioniert.

Kann meine Organisation über die Admin API externe Personen einladen?

Ja. Admins der Organisation können über die Admin API Personen in Teams einladen, auch externe Personen. Die bestehenden Einladungs- und Domaineinstellungen deines Teams gelten weiterhin für die eingeladenen Personen.

Können wir einen vorhandenen Einladungslink erneut abrufen, ohne eine neue Einladung zu erstellen?

Ja. Du kannst einen vorhandenen Einladungslink anhand der genauen E-Mail-Adresse der eingeladenen Person abrufen, ohne eine neue Einladung zu erstellen.