De Canva beheerder API instellen en gebruiken

Met de Canva Admin API kun je het beheer van je organisatie automatiseren vanuit je eigen systemen. Beheer gebruikers, teams, groepen en lidmaatschappen, en haal gebeurtenissen uit het auditlogboek op zonder deze taken handmatig in Canva uit te voeren.

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

Controleer vóór je de Admin API instelt of je organisatie aan deze vereisten voldoet:

• Organisatieniveau: De Admin API werkt op organisatieniveau. Ze is beschikbaar voor organisaties met één of meerdere teams met een Canva Enterprise-, Canva Districts- of Canva Campus-abonnement.
• Account van een organisatiebeheerder: Alleen organisatiebeheerders kunnen in de Canva-instellingen clients voor de Admin API maken en beheren.
• Interne of uitbestede engineeringcapaciteit: Je organisatie heeft engineeringcapaciteit 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-provisioning geschikter om het gebruikersbeheer in je organisatie te automatiseren.
• Vertrouwd zijn met je Canva-structuur: Zorg dat je goed begrijpt hoe je organisatie, teams en groepen in Canva zijn opgezet voordat je de integratie bouwt.
• Account met multifactorauthenticatie (MFA) of een account dat wordt beheerd via eenmalige aanmelding (SSO): De organisatiebeheerder die de Admin API configureert, moet MFA hebben ingeschakeld of een account hebben dat wordt beheerd via SSO. Het account moet worden beheerd door of eigendom zijn van de organisatie namens wie die beheerder 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: gebeurtenissen uit het auditlogboek volgens een schema ophalen.
• Teamuitnodigingen: mensen uitnodigen voor een team (ook mensen buiten je organisatie), openstaande uitnodigingen bekijken, een bestaande uitnodigingslink op basis van het exacte e-mailadres ophalen en uitnodigingen annuleren.

Een organisatiebeheerder maakt een client voor de Admin API en gebruikt die om de API aan te roepen.

Volg de handleiding van de Canva Admin API om je clientgegevens om te wisselen voor een toegangstoken en API-verzoeken te versturen.

Deel de documentatie over authenticatie voor de Canva Admin API met je engineeringteam voor technische 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 client voor de Admin API, niet van de individuele beheerder die de client heeft gebruikt.

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

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

Meer informatie vind je in Over Canva-auditlogboeken.

Organisatiebeheerders 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, geldt voor één team en één e-mailadres.
• Je kunt elke uitnodiging één keer gebruiken. Ze vervalt na 30 dagen.
• Afhankelijk van je instellingen stuurt Canva de genodigde mogelijk niet automatisch een e-mail. Deel de uitnodigingslink indien nodig rechtstreeks met de genodigde.
• Houd uitnodigingslinks privé. Een uitnodigingslink werkt alleen voor het e-mailadres waarvoor die is aangemaakt.
• De bestaande instellingen van je team voor uitnodigingen en domeinen blijven gelden voor de mensen die je uitnodigt.
• Bestaat er al een openstaande uitnodiging voor de genodigde? Dan levert een nieuwe uitnodiging hetzelfde uitnodigingsrecord op, wordt de vervaldatum opnieuw ingesteld op 30 dagen na het verzoek en wordt de rol van de genodigde aangepast aan de gevraagde rol.

Raadpleeg de documentatie van de Canva Admin API voor informatie over de endpoints.

Zowel de Admin API als SCIM kan provisioning van gebruikers ondersteunen.

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

SCIM ondersteunt standaard provisioning en deactivering. Heb je alleen standaardprovisioning van gebruikers nodig, of kan je team geen aangepaste API-integratie bouwen? Dan is SCIM geschikter voor jouw behoeften.

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

Ja. Om de Admin API te gebruiken, heeft je organisatie interne of uitbestede engineeringcapaciteit 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-provisioning geschikter om het gebruikersbeheer in je organisatie te automatiseren.

Heeft iedereen in mijn organisatie MFA of SSO nodig om de Admin API te gebruiken?

Nee. Alleen de organisatiebeheerder die de Admin API configureert, moet MFA hebben ingeschakeld of een account hebben dat wordt beheerd via SSO. Het account moet worden beheerd door of eigendom zijn van de organisatie namens wie die beheerder handelt. Andere leden van de organisatie hebben geen MFA of SSO nodig om de Admin API te kunnen gebruiken.

Kan mijn organisatie externe medewerkers uitnodigen via de Admin API?

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

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

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