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 er avgrenset til organisasjonen. Det er tilgjengelig for organisasjoner med ett eller flere team på Canva Enterprise-, Canva Districts- og Canva for Campus-abonnementer.
• Organisasjonsadministratorkonto: Bare organisasjonsadministratorer kan opprette og administrere Admin API-klienter i Canva-innstillingene.
• Intern eller ekstern utviklingskompetanse: Organisasjonen trenger utviklingsressurser for å bygge og vedlikeholde integrasjonen. Canva tilbyr ikke implementeringsstøtte.
  • Hvis teamet ditt ikke kan bygge mot et API, passer SCIM-klargjøring bedre for automatisering av brukeradministrasjon i organisasjonen.
• Kjennskap til Canva-strukturen: Sørg for å ha en tydelig forståelse av hvordan organisasjonen, teamene og gruppene er satt opp i Canva før du bygger integrasjonen.
• Flerfaktorautentisering (MFA) eller konto 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 vedkommende handler på vegne av.

Admin API tilbyr endepunkter for:

• Brukere, team og grupper: Opprett, les, oppdater og slett.
• Medlemskap: Legg til eller fjern personer fra team og grupper, og angi rollene deres.
• Revisjonslogger: Hent hendelser fra revisjonsloggen etter en tidsplan.
• Teaminvitasjoner: Inviter personer til et team (også personer utenfor organisasjonen), vis ventende invitasjoner, hent en eksisterende invitasjonskobling ved hjelp av den nøyaktige e-postadressen, og avbryt invitasjoner.

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

Følg dokumentasjonen 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 av Canva Admin API med utviklingsteamet ditt.

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

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

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

Hvis du vil ha mer informasjon, kan du se 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 at Canva ikke sender invitasjonen automatisk på e-post. Del i så fall invitasjonskoblingen direkte med den inviterte.
• Hold invitasjonskoblinger private. En invitasjonskobling fungerer bare for e-postadressen den ble opprettet for.
• Teamets eksisterende innstillinger for invitasjoner og domener 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 til 30 dager fra forespørselen, og rollen i invitasjonen oppdateres til den forespurte rollen.

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

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

Admin API støtter administrasjon av Canva-organisasjoner utover klargjøring av brukere. Dette omfatter team, grupper, medlemskap og revisjonslogger.

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

Trenger organisasjonen min en utvikler for å bruke Admin API?

Ja. Organisasjonen trenger interne eller eksterne utviklingsressurser for å bygge og vedlikeholde integrasjonen. Canva tilbyr ikke implementeringsstøtte. Hvis teamet ditt ikke kan bygge mot et API, passer SCIM-klargjøring bedre for automatisering av brukeradministrasjon i organisasjonen.

Må alle i organisasjonen ha MFA eller SSO for å bruke Admin API?

Nei. Bare 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 vedkommende handler på vegne av. Andre medlemmer av organisasjonen trenger ikke MFA eller SSO spesifikt 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. Teamets eksisterende innstillinger for invitasjoner og domener 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 hjelp av den inviterte personens nøyaktige e-postadresse, uten å opprette en ny invitasjon.