De Canva-beheerders-API instellen en gebruiken

Je kunt de Canva Admin API gebruiken om het beheer van je organisatie te automatiseren vanuit je eigen systemen. Beheer gebruikers, teams, groepen en lidmaatschappen en haal auditlogboekgebeurtenissen op, zonder deze taken handmatig in Canva uit te voeren.

• Beschikbaar voor Canva Enterprise, Canva Districts en Canva Campus.
• Toegankelijk voor hoofdbeheerders.
• Beschikbaar voor organisaties met één of meerdere teams.

Controleer voordat je de Admin API instelt of je organisatie aan de volgende vereisten voldoet:

• Organisatieniveau: De Admin API is organisatiegebonden. De API is beschikbaar voor organisaties met één of meerdere teams met een Canva Enterprise-, Canva Districts- of Canva Campus-abonnement.
• Account van een hoofdbeheerder: Alleen hoofdbeheerders kunnen API-clients voor de Admin API maken en beheren in de Canva-instellingen.
• Interne of externe technische expertise: Je organisatie heeft technische expertise nodig om de integratie te bouwen en te onderhouden. Canva biedt geen ondersteuning bij de implementatie.
  • Kan je team geen API-integratie bouwen? Dan is SCIM-inrichting geschikter om het gebruikersbeheer in je organisatie te automatiseren.
• Kennis van je Canva-structuur: Zorg dat je goed begrijpt hoe je organisatie, teams en groepen in Canva zijn ingericht voordat je de integratie bouwt.
• Account met multi-factorauthenticatie (MFA) of beheerd via eenmalige aanmelding (SSO): De hoofdbeheerder die de Admin API instelt, moet MFA hebben ingeschakeld of een account hebben dat via SSO wordt beheerd. Het account moet worden beheerd door of eigendom zijn van de organisatie namens welke de hoofdbeheerder handelt.

De Admin API biedt endpoints voor:

• Gebruikers, teams en groepen: maken, bekijken, bijwerken en verwijderen.
• Lidmaatschappen: mensen toevoegen aan of verwijderen uit teams en groepen, en hun rollen instellen.
• Auditlogboeken: auditlogboekgebeurtenissen ophalen volgens een schema.
• Teamuitnodigingen: mensen uitnodigen voor een team (ook mensen buiten je organisatie), openstaande uitnodigingen bekijken, een bestaande uitnodigingslink ophalen aan de hand van het exacte e-mailadres en uitnodigingen annuleren.

Een hoofdbeheerder maakt een Admin API-client aan en gebruikt deze om de API aan te roepen.

Volg de documentatie van de Canva Admin API om je clientgegevens om te zetten in een toegangstoken en API-verzoeken te versturen.

Deel de documentatie over verificatie met de Canva Admin API met je technische team voor meer informatie over het verifiëren van API-verzoeken en het gebruik van OAuth 2.0-bearertokens.

Acties die via de Admin API worden uitgevoerd, worden geregistreerd op naam van de Admin API-client en niet van de afzonderlijke beheerder die de client heeft gebruikt.

In auditlogboeken toont het veld Actor de naam en client-ID van de Admin API-client. Zo kun je zien welke integratie een actie heeft uitgevoerd.

Je kunt ook zien welke hoofdbeheerder een specifieke API-client heeft gemaakt, bijgewerkt of verwijderd.

Lees voor meer informatie Over auditlogboeken van Canva.

Hoofdbeheerders kunnen de Admin API gebruiken om mensen uit te nodigen voor een team, ook externe medewerkers buiten je organisatie.

Goed om te weten

• Elke uitnodiging die je maakt, is voor één team en één e-mailadres.
• Je kunt elke uitnodiging één keer gebruiken; de uitnodiging verloopt na 30 dagen.
• Afhankelijk van je instellingen stuurt Canva de genodigde mogelijk niet automatisch een e-mail. Deel in dat geval de uitnodigingslink rechtstreeks met de genodigde.
• Houd uitnodigingslinks privé. Een uitnodigingslink werkt alleen voor het e-mailadres waarvoor deze is gemaakt.
• De bestaande instellingen voor uitnodigingen en domeinen van je team blijven van toepassing op de mensen die je uitnodigt.
• Als er al een openstaande uitnodiging voor de genodigde is, levert een nieuwe uitnodiging dezelfde uitnodigingsregistratie op. De vervaldatum wordt dan opnieuw ingesteld op 30 dagen na het verzoek en de rol van de genodigde wordt bijgewerkt naar de aangevraagde rol.

Bekijk de documentatie van de Canva Admin API voor meer informatie over endpoints.

Zowel de Admin API als SCIM kunnen gebruikersinrichting ondersteunen.

De Admin API ondersteunt meer dan alleen gebruikersinrichting voor het beheer van Canva-organisaties. Je kunt er ook teams, groepen, lidmaatschappen en auditlogboeken mee beheren.

SCIM ondersteunt standaardinrichting en het ongedaan maken daarvan. Als je alleen standaardinrichting voor gebruikers nodig hebt of als je team geen aangepaste API-integratie kan bouwen, is SCIM geschikter voor jouw behoeften.

Heeft mijn organisatie een ontwikkelaar nodig om de Admin API te gebruiken?

Ja. Voor de Admin API heeft je organisatie interne of externe technische expertise nodig om de integratie te bouwen en te onderhouden. Canva biedt geen ondersteuning bij de implementatie. Kan je team geen API-integratie bouwen? Dan is SCIM-inrichting geschikter om het gebruikersbeheer in je organisatie te automatiseren.

Moet iedereen in mijn organisatie MFA of SSO hebben om de Admin API te gebruiken?

Nee. Alleen de hoofdbeheerder die de Admin API instelt, moet MFA hebben ingeschakeld of een account hebben dat via SSO wordt beheerd. Het account moet worden beheerd door of eigendom zijn van de organisatie namens welke de hoofdbeheerder handelt. Andere leden van de organisatie hebben geen MFA of SSO nodig om de Admin API te laten werken.

Kan mijn organisatie externe medewerkers uitnodigen met de Admin API?

Ja. Hoofdbeheerders kunnen de Admin API gebruiken om mensen uit te nodigen voor teams, ook externe medewerkers. De bestaande instellingen voor uitnodigingen en domeinen van je team blijven van toepassing op de mensen die je uitnodigt.

Kunnen we een bestaande uitnodigingslink opnieuw ophalen zonder een nieuwe uitnodiging te maken?

Ja. Je kunt een bestaande uitnodigingslink ophalen met het exacte e-mailadres van de genodigde, zonder een nieuwe uitnodiging te maken.