Konfigurer og bruk Canva administrator API

Du kan bruke Canva Admin API til å automatisere administrasjonen av organisasjonen fra dine egne systemer. Administrer brukere, team, grupper og medlemskap, og hent hendelser fra revisjonsloggen uten å måtte utføre disse oppgavene manuelt i Canva.

• Tilgjengelig for Canva Enterprise, Canva Districts og Canva for Campus.
• Tilgjengelig for organisasjonsadministratorer.
• Tilgjengelig for organisasjoner med ett eller flere team.

Før du konfigurerer Admin API, må du sørge for at organisasjonen oppfyller disse kravene:

• Organisasjonsnivå: Admin API gjelder for hele organisasjonen. Den er tilgjengelig for organisasjoner med ett eller flere team på Canva Enterprise-, Canva Districts- og Canva Campus-abonnementer.
• Konto for organisasjonsadministrator: Det er bare organisasjonsadministratorer som kan opprette og administrere Admin API-klienter i Canva-innstillingene.
• Intern eller innleid teknisk kompetanse: Organisasjonen trenger tekniske ressurser for å bygge og vedlikeholde integrasjonen. Canva tilbyr ikke hjelp med implementeringen.
  • Hvis teamet ditt ikke kan utvikle en løsning med et API, passer SCIM-klargjøring bedre for automatisering av brukeradministrasjon i organisasjonen.
• Kjennskap til Canva-strukturen deres: Sørg for at du har god forståelse av hvordan organisasjonen, teamene og gruppene er satt opp i Canva før du bygger integrasjonen.
• Konto med flerfaktorautentisering (MFA) eller administrert med enkel pålogging (SSO): Organisasjonsadministratoren som konfigurerer Admin API, må enten ha MFA aktivert eller ha en konto som administreres med SSO. Kontoen må administreres eller eies av organisasjonen administratoren handler på vegne av.

Admin API har endepunkter for:

• Brukere, team og grupper: Opprette, lese, oppdatere og slette.
• Medlemskap: Legge til eller fjerne personer fra team og grupper, og angi rollene deres.
• Revisjonslogger: Hente hendelser fra revisjonsloggen etter en fast tidsplan.
• Teaminvitasjoner: Invitere personer til et team (også personer utenfor organisasjonen), se ventende invitasjoner, hente en eksisterende invitasjonskobling ved hjelp av den nøyaktige e-postadressen og avbryte invitasjoner.

En organisasjonsadministrator oppretter en Admin API-klient og bruker den til å kalle opp API-et.

Følg dokumentasjonsn for Canva Admin API for å bytte klientlegitimasjonen din mot et tilgangstoken og begynne å sende API-forespørsler.

Hvis du vil ha teknisk informasjon om autentisering av API-forespørsler og bruk av OAuth 2.0-bærertokener, kan du dele dokumentasjonen for autentisering med Canva Admin API med det tekniske teamet ditt.

Handlinger som utføres via Admin API, registreres på Admin API-klienten i stedet for på den enkelte administratoren som brukte klienten.

I revisjonsloggene viser Actor-feltet navnet på Admin API-klienten og klient-ID-en. Dette gjør det enklere å se hvilken integrasjon som utførte en handling.

Du kan også finne ut hvilken organisasjonsadministrator som opprettet, oppdaterte eller slettet en bestemt API-klient.

Du finner mer informasjon under Om revisjonslogger i Canva.

Organisasjonsadministratorer kan bruke Admin API til å invitere personer til et team, også eksterne samarbeidspartnere utenfor organisasjonen.

Dette bør du vite

• Hver invitasjon du oppretter, gjelder for ett team og én e-postadresse.
• Hver invitasjon kan brukes én gang, og den utløper etter 30 dager.
• Avhengig av oppsettet ditt kan det hende Canva ikke sender en e-postinvitasjon automatisk. Del i så fall invitasjonskoblingen direkte med den inviterte.
• Hold invitasjonskoblinger private. En invitasjonskobling fungerer bare for e-postadressen den ble opprettet for.
• De eksisterende innstillingene for invitasjoner og domener i teamet ditt gjelder fortsatt for personene du inviterer.
• Hvis det allerede finnes en ventende invitasjon for den inviterte, returneres den samme invitasjonsposten når du oppretter en ny invitasjon. Utløpsdatoen tilbakestilles da til 30 dager fra forespørselen, og rollen i invitasjonen oppdateres til rollen du ba om.

Du finner informasjon om endepunktene i dokumentasjonen for Canva Admin API.

Både Admin API og SCIM kan brukes til klargjøring av brukere.

Admin API støtter mer enn bare klargjøring av brukere når du skal administrere Canva-organisasjonen. Det omfatter team, grupper, medlemskap og revisjonslogger.

SCIM støtter standardisert klargjøring og avvikling av brukerkontoer. Hvis du bare trenger standardisert klargjøring av brukere, eller teamet ditt ikke kan utvikle en egendefinert API-integrasjon, passer SCIM bedre for behovene dine.

Trenger organisasjonen min en utvikler for å bruke Admin API?

Ja. Organisasjonen trenger interne eller innleide tekniske ressurser for å bygge og vedlikeholde integrasjonen. Canva tilbyr ikke hjelp med implementeringen. Hvis teamet ditt ikke kan utvikle en løsning med et API, passer SCIM-klargjøring bedre for automatisering av brukeradministrasjon i organisasjonen.

Trenger alle i organisasjonen min MFA eller SSO for å bruke Admin API?

Nei. Det er bare organisasjonsadministratoren som konfigurerer Admin API, som må ha MFA aktivert eller en konto som administreres med SSO. Kontoen må administreres eller eies av organisasjonen administratoren handler på vegne av. Andre medlemmer av organisasjonen trenger ikke MFA eller SSO for at Admin API skal fungere.

Kan organisasjonen min invitere eksterne samarbeidspartnere med Admin API?

Ja. Organisasjonsadministratorer kan bruke Admin API til å invitere personer til team, også eksterne samarbeidspartnere. De eksisterende innstillingene for invitasjoner og domener i teamet ditt gjelder fortsatt for personene du inviterer.

Kan vi hente en eksisterende invitasjonskobling på nytt uten å opprette en ny invitasjon?

Ja. Du kan hente en eksisterende invitasjonskobling ved å bruke den inviterte personens nøyaktige e-postadresse, uten å opprette en ny invitasjon.