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 revisionslogfilen 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 følgende krav:

• Organisationsniveau: Admin API er afgrænset 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 tekniske ressourcer: Din organisation skal have tekniske ressourcer til at udvikle og vedligeholde integrationen. Canva tilbyder ikke implementeringssupport.
  • Hvis dit team ikke kan udvikle en API-integration, er SCIM-provisionering bedre egnet 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 dine grupper er konfigureret i Canva, før du udvikler integrationen.
• Konto med multifaktorgodkendelse (MFA) eller SSO-administration: Den organisationsadministrator, der konfigurerer Admin API, skal enten have MFA aktiveret eller bruge en SSO-administreret konto. 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: Tilføj eller fjern personer fra teams og grupper, og tildel dem roller.
• Revisionslogfiler: Hent hændelser fra revisionslogfilen efter en tidsplan.
• Teaminvitationer: Inviter personer til et team (herunder personer uden for din organisation), se afventende invitationer, hent et eksisterende invitationslink ved hjælp af den nøjagtige e-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-dokumentation for at udveksle dine klientoplysninger med et adgangstoken og begynde at sende API-anmodninger.

Del dokumentationen om godkendelse i Canva Admin API med dit tekniske team for at få tekniske oplysninger om godkendelse af API-anmodninger og brug af OAuth 2.0-bærertokens.

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 dens klient-id. Det gør det nemmere at identificere, hvilken integration der udførte en handling.

Du kan også identificere den organisationsadministrator, der har oprettet, opdateret eller slettet en bestemt API-klient.

Se Om Canvas revisionslogfiler for at få flere oplysninger.

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

Værd at vide

• Hver invitation, du opretter, gælder for ét team og én e-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 e-mail til den inviterede. Del i så fald invitationslinket direkte med vedkommende.
• Hold invitationslinks private. Et invitationslink virker kun for den e-mailadresse, det blev oprettet til.
• De eksisterende indstillinger for invitationer og domæner på dit team gælder stadig for de personer, du inviterer.
• Hvis der allerede findes en afventende invitation til den inviterede, returneres den samme invitationspost, når du opretter en ny invitation. Udløbsdatoen nulstilles til 30 dage fra anmodningen, og invitationens rolle opdateres til den ønskede rolle.

Se dokumentationen til Canva Admin API. for at få oplysninger om endpoints.

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

Admin API understøtter administration af Canva-organisationer ud over brugerprovisionering. Det omfatter teams, grupper, medlemskaber og revisionslogfiler.

SCIM understøtter standardiseret provisionering og deprovisionering. Hvis du kun har brug for standardiseret brugerprovisionering, eller hvis dit team ikke kan udvikle en brugerdefineret API-integration, er SCIM bedre egnet 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 tekniske ressourcer til at udvikle og vedligeholde integrationen. Canva tilbyder ikke implementeringssupport. Hvis dit team ikke kan udvikle en API-integration, er SCIM-provisionering bedre egnet til at automatisere brugeradministrationen i din organisation.

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

Nej. Kun den organisationsadministrator, der konfigurerer Admin API, skal enten have MFA aktiveret eller bruge en SSO-administreret konto. 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 Admin API kan fungere.

Kan min organisation invitere eksterne samarbejdspartnere via Admin API?

Ja. Organisationsadministratorer kan bruge Admin API til at invitere personer til teams, herunder eksterne samarbejdspartnere. De eksisterende indstillinger for invitationer og domæner på dit team 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 e-mailadresse uden at oprette en ny invitation.