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 auditlogs 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 team en organisaties met meerdere teams.

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

• Organisatieniveau: De Admin API is beperkt tot de organisatie. Ze is beschikbaar voor organisaties met één team en organisaties met meerdere teams met een Canva Enterprise-, Canva Districts- of Canva Campus-abonnement.
• Account van een organisatiebeheerder: Alleen organisatiebeheerders kunnen API-clients voor de Admin API aanmaken 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-provisioning geschikter om het gebruikersbeheer binnen je organisatie te automatiseren.
• Vertrouwd zijn met je Canva-structuur: Zorg dat je goed begrijpt hoe je organisatie, teams en groepen in Canva zijn ingericht voordat je de integratie bouwt.
• Multifactorauthenticatie (MFA) of een account dat wordt beheerd via eenmalige aanmelding (SSO): De organisatiebeheerder die de Admin API instelt, moet MFA ingeschakeld hebben of een account hebben dat wordt beheerd via SSO. Het account moet worden beheerd door of eigendom zijn van de organisatie waarvoor de beheerder optreedt.

De Admin API biedt eindpunten voor:

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

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

Volg de documentatie van de Canva Admin API 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 de technische aspecten van API-verificatie en het gebruik van bearer tokens van OAuth 2.0.

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

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

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

Bekijk voor meer informatie Over auditlogs van Canva.

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 aanmaakt, is 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 indien nodig de uitnodigingslink 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 mensen die je uitnodigt.
• Bestaat er al een openstaande uitnodiging voor de genodigde, dan levert een nieuwe uitnodiging dezelfde uitnodigingsregistratie op. De vervaldatum wordt 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 de eindpunten.

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

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

SCIM ondersteunt standaardprovisioning en het ongedaan maken van provisioning. 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. Je organisatie heeft 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-provisioning 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 organisatiebeheerder die de Admin API instelt, moet MFA ingeschakeld hebben of een account hebben dat wordt beheerd via SSO. Het account moet worden beheerd door of eigendom zijn van de organisatie waarvoor de beheerder optreedt. 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. 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 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.