Konfigurer og brug Canva administrator API

Du kan bruge Canva Admin API til at automatisere administrationen af din organisation fra dine egne systemer. Administrer brugere, teams, grupper og medlemskaber, og hent hændelser fra revisionsloggen uden at skulle udføre disse opgaver manuelt i Canva.

• Tilgængelig for Canva Enterprise, Canva Districts og Canva Campus.
• Tilgængelig for organisationsadministratorer.
• Tilgængelig for organisationer med ét eller flere teams.

Før du konfigurerer Admin API, skal du sikre dig, at din organisation opfylder disse krav:

• Organisationsniveau: Admin API er knyttet til organisationen. Den er tilgængelig for organisationer med ét eller flere teams på abonnementerne Canva Enterprise, Canva Districts og Canva Campus.
• Organisationsadministratorkonto: Kun organisationsadministratorer kan oprette og administrere Admin API-klienter i Canvas indstillinger.
• Interne eller eksterne udviklingsressourcer: Din organisation skal have udviklingsressourcer til at bygge og vedligeholde integrationen. Canva tilbyder ikke implementeringssupport.
  • Hvis dit team ikke kan bygge en integration med et API, er SCIM-provisionering et bedre valg til at automatisere brugeradministrationen i din organisation.
• Kendskab til din Canva-struktur: Sørg for at have et klart overblik over, hvordan din organisation, dine teams og grupper er konfigureret i Canva, før du bygger integrationen.
• Multifaktorgodkendelse (MFA) eller konto administreret via Single Sign-On (SSO): Den organisationsadministrator, der konfigurerer Admin API, skal enten have MFA aktiveret eller have en konto, der administreres via SSO. Kontoen skal administreres eller ejes af den organisation, som vedkommende handler på vegne af.

Admin API indeholder endpoints til:

• Brugere, teams og grupper: Opret, læs, opdater og slet.
• Medlemskaber: Føj personer til eller fjern personer fra teams og grupper, og tildel dem roller.
• Revisionslogfiler: Hent hændelser fra revisionsloggen efter en tidsplan.
• Teaminvitationer: Inviter personer til et team (herunder personer uden for din organisation), vis afventende invitationer, hent et eksisterende invitationslink ved hjælp af den nøjagtige mailadresse, og annuller invitationer.

En organisationsadministrator opretter en Admin API-klient og bruger den til at foretage API-kald.

Følg dokumentationen til Canva Admin API for at udveksle dine klientoplysninger med et adgangstoken og begynde at sende API-anmodninger.

Del dokumentationen om godkendelse med Canva Admin API med dit udviklingsteam for at få tekniske oplysninger om godkendelse af API-anmodninger og brug af OAuth 2.0-bearertokens.

Handlinger, der udføres via Admin API, registreres på Admin API-klienten i stedet for på den enkelte administrator, der brugte klienten.

I revisionslogfiler viser feltet Aktør navnet på Admin API-klienten og klientens id. Det gør det nemmere at finde ud af, hvilken integration der udførte en handling.

Du kan også finde ud af, hvilken organisationsadministrator der har oprettet, opdateret eller slettet en bestemt API-klient.

Du kan få flere oplysninger i Om Canvas revisionslogfiler.

Organisationsadministratorer kan bruge Admin API til at invitere personer til et team, herunder eksterne samarbejdspartnere uden for organisationen.

Vigtigt at vide

• Hver invitation, du opretter, gælder for ét team og én mailadresse.
• Hver invitation kan bruges én gang, og den udløber efter 30 dage.
• Afhængigt af din konfiguration sender Canva muligvis ikke automatisk en mail til den inviterede. Del i så fald invitationslinket direkte med vedkommende.
• Hold invitationslinks private. Et invitationslink virker kun for den mailadresse, det blev oprettet til.
• Dit teams eksisterende indstillinger for invitationer og domæner gælder stadig for de personer, du inviterer.
• Hvis der allerede findes en afventende invitation til den inviterede, returnerer oprettelsen af en ny invitation den samme invitationspost. Udløbsdatoen nulstilles til 30 dage fra anmodningen, og invitationens rolle opdateres til den ønskede rolle.

Du kan få oplysninger om endpoints i dokumentationen til Canva Admin API.

Både Admin API og SCIM kan bruges til brugerprovisionering.

Admin API understøtter mere end brugerprovisionering, når det gælder administration af Canva-organisationer. Det omfatter teams, grupper, medlemskaber og revisionslogfiler.

SCIM understøtter standardprovisionering og -deprovisionering. Hvis du kun har brug for standardprovisionering af brugere, eller hvis dit team ikke kan bygge en brugerdefineret API-integration, er SCIM et bedre valg til dine behov.

Har min organisation brug for en udvikler for at bruge Admin API?

Ja. For at bruge Admin API skal din organisation have interne eller eksterne udviklingsressourcer til at bygge og vedligeholde integrationen. Canva tilbyder ikke implementeringssupport. Hvis dit team ikke kan bygge en integration med et API, er SCIM-provisionering et bedre valg til at automatisere brugeradministrationen i din organisation.

Skal alle i min organisation have MFA eller SSO for at bruge Admin API?

Nej. Kun den organisationsadministrator, der konfigurerer Admin API, skal enten have MFA aktiveret eller have en konto, der administreres via SSO. Kontoen skal administreres eller ejes af den organisation, som vedkommende handler på vegne af. Andre medlemmer af organisationen behøver ikke MFA eller SSO specifikt for at bruge Admin API.

Kan min organisation invitere eksterne samarbejdspartnere via Admin API?

Ja. Organisationsadministratorer kan bruge Admin API til at invitere personer til teams, herunder eksterne samarbejdspartnere. Dit teams eksisterende indstillinger for invitationer og domæner gælder stadig for de personer, du inviterer.

Kan vi hente et eksisterende invitationslink igen uden at oprette en ny invitation?

Ja. Du kan hente et eksisterende invitationslink ved hjælp af den inviteredes nøjagtige mailadresse uden at oprette en ny invitation.