De Canva-beheerders-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 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 deze vereisten voldoet:

• Organisatieniveau: De Admin API is gekoppeld aan de organisatie. 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 in de Canva-instellingen Admin API-clients maken en beheren.
• Eigen of uitbesteed technisch team: Je organisatie heeft technische capaciteit 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 binnen 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 multifactorauthenticatie (MFA) of een account dat via eenmalige aanmelding (SSO) wordt beheerd: De hoofdbeheerder die de Admin API configureert, 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 eindpunten 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 volgens een schema ophalen.
• Teamuitnodigingen: mensen uitnodigen voor een team (ook mensen buiten je organisatie), openstaande uitnodigingen bekijken, een bestaande uitnodigingslink ophalen met 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-documentatie om je clientgegevens om te wisselen voor een toegangstoken en API-verzoeken te versturen.

Deel de documentatie over verificatie voor 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 aangeroepen.

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.

Zie Over auditlogboeken van Canva. voor meer informatie.

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, geldt 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 indien nodig 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 het maken van een nieuwe uitnodiging hetzelfde uitnodigingsrecord op. De vervaldatum wordt dan opnieuw ingesteld op 30 dagen na het verzoek en de rol van de genodigde wordt aangepast aan de aangevraagde rol.

Bekijk de documentatie van de Canva Admin API. voor informatie over de eindpunten.

Zowel de Admin API als SCIM kan het inrichten van gebruikers ondersteunen.

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

SCIM ondersteunt standaardinrichting en het ongedaan maken daarvan. Als je alleen standaardinrichting van 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 eigen of uitbestede technische capaciteit 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 binnen je organisatie te automatiseren.

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

Nee. Alleen de hoofdbeheerder die de Admin API configureert, 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 gebruiken.

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 aan te maken.