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 Nutzer*innen, 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.
• Zugänglich für Admins der Organisation.
• Verfügbar für Organisationen mit einem oder mehreren Teams.

Bevor du die Admin API einrichtest, solltest du sicherstellen, dass deine Organisation diese 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.
• Konto als Admin der Organisation: Nur Admins der Organisation können in den Canva-Einstellungen Clients für die Admin API erstellen und verwalten.
• Interne oder externe Engineering-Ressourcen: Deine Organisation benötigt Engineering-Ressourcen, um die Integration zu entwickeln 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 Nutzerverwaltung in deiner Organisation zu automatisieren.
• Vertrautheit mit deiner Canva-Struktur: Du solltest genau wissen, wie deine Organisation, Teams und Gruppen in Canva eingerichtet sind, bevor du die Integration entwickelst.
• Konto mit Multi-Faktor-Authentifizierung (MFA) oder Single Sign-On (SSO): Für den Admin der Organisation, der die Admin API einrichtet, 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 der Admin handelt.

Die Admin API bietet Endpunkte für:

• Nutzer*innen, Teams und Gruppen: erstellen, anzeigen, 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.
• Teameinladungen: Personen zu einem Team einladen (auch Personen außerhalb deiner Organisation), ausstehende Einladungen anzeigen, über die genaue E-Mail-Adresse einen vorhandenen Einladungslink abrufen und Einladungen stornieren.

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

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 mit der Canva Admin API. Teile sie mit deinem Engineering-Team.

Aktionen, die über die Admin API ausgeführt werden, 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 Clients der Admin API angezeigt. So kannst du erkennen, welche Integration eine Aktion ausgeführt hat.

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

Weitere Informationen findest du unter Informationen zu Canva-Prüfungsprotokollen.

Admins der Organisation können über die Admin API Personen zu einem Team einladen, auch externe Mitarbeiter*innen 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 ihr.
• Halte Einladungslinks vertraulich. Ein Einladungslink funktioniert nur für die E-Mail-Adresse, für die er erstellt wurde.
• Die bestehenden Einstellungen deines Teams für Einladungen und Domains gelten auch für eingeladene Personen.
• Wenn für die eingeladene Person bereits eine ausstehende Einladung vorliegt, wird beim Erstellen einer neuen Einladung derselbe Einladungseintrag zurückgegeben. Das Ablaufdatum wird auf 30 Tage ab der Anfrage 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 können die Nutzer-Provisionierung unterstützen.

Die Admin API ermöglicht über die Nutzer-Provisionierung hinaus die Verwaltung von Canva-Organisationen. Dazu gehören Teams, Gruppen, Mitgliedschaften und Prüfungsprotokolle.

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

Benötigt meine Organisation Entwickler*innen, um die Admin API zu nutzen?

Ja. Für die Admin API benötigt deine Organisation interne oder externe Engineering-Ressourcen, um die Integration zu entwickeln 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 Nutzerverwaltung in deiner Organisation zu automatisieren.

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

Nein. Nur für den Admin der Organisation, der die Admin API einrichtet, muss entweder MFA aktiviert sein oder das Konto über SSO verwaltet werden. Das Konto muss von der Organisation verwaltet werden oder ihr gehören, in deren Auftrag der Admin handelt. Für die übrigen Mitglieder der Organisation ist MFA oder SSO nicht erforderlich, damit die Admin API funktioniert.

Kann meine Organisation über die Admin API externe Mitarbeiter*innen einladen?

Ja. Admins der Organisation können über die Admin API Personen zu Teams einladen, auch externe Mitarbeiter*innen. Die bestehenden Einstellungen deines Teams für Einladungen und Domains gelten auch für eingeladene Personen.

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

Ja. Du kannst einen vorhandenen Einladungslink über die genaue E-Mail-Adresse der eingeladenen Person abrufen, ohne eine neue Einladung zu erstellen.