Konfigurera och använd Canva administratör API

Du kan använda Canva Admin API för att automatisera organisationens administration från dina egna system. Hantera användare, team, grupper och medlemskap och hämta händelser från granskningsloggen utan att behöva utföra uppgifterna manuellt i Canva.

• Tillgängligt för Canva för företag, Canva Districts och Canva för Campus.
• Tillgängligt för organisationsadministratörer.
• Tillgängligt för organisationer med ett eller flera team.

Innan du konfigurerar Admin API bör du se till att organisationen uppfyller följande krav:

• Organisationsnivå: Admin API gäller för hela organisationen. Det är tillgängligt för organisationer med ett eller flera team på abonnemangen Canva för företag, Canva Districts och Canva för Campus.
• Organisationsadministratörskonto: Endast organisationsadministratörer kan skapa och hantera Admin API-klienter i Canva-inställningarna.
• Intern eller extern teknisk kompetens: Organisationen behöver tekniska resurser för att bygga och underhålla integreringen. Canva erbjuder inte support för implementering.
  • Om teamet inte kan bygga mot ett API passar SCIM-provisionering bättre för att automatisera användarhanteringen i organisationen.
• Kännedom om Canva-strukturen: Se till att ha en tydlig bild av hur organisationen, teamen och grupperna är konfigurerade i Canva innan du bygger integreringen.
• Konto med multifaktorautentisering (MFA) eller enkel inloggning (SSO): Organisationsadministratören som konfigurerar Admin API måste ha antingen MFA aktiverat eller ett konto som hanteras via SSO. Kontot måste hanteras eller ägas av organisationen som administratören företräder.

Admin API tillhandahåller slutpunkter för:

• Användare, team och grupper: Skapa, läsa, uppdatera och ta bort.
• Medlemskap: Lägga till eller ta bort personer från team och grupper samt ange deras roller.
• Granskningsloggar: Hämta händelser från granskningsloggen enligt ett schema.
• Teaminbjudningar: Bjuda in personer till ett team, även personer utanför organisationen, visa väntande inbjudningar, hämta en befintlig inbjudningslänk med exakt e-postadress och avbryta inbjudningar.

En organisationsadministratör skapar en Admin API-klient och använder den för att anropa API:et.

Följ dokumentationen för Canva Admin API för att byta dina klientuppgifter mot en åtkomsttoken och börja skicka API-förfrågningar.

Dela dokumentationen om autentisering för Canva Admin API med det tekniska teamet för teknisk information om hur man autentiserar API-förfrågningar och använder OAuth 2.0-bärartoken.

Åtgärder som utförs via Admin API registreras för Admin API-klienten i stället för den enskilda administratör som använde klienten.

I granskningsloggar visar fältet Aktör Admin API-klientens namn och klient-ID. Det hjälper dig att se vilken integrering som utförde en åtgärd.

Du kan också se vilken organisationsadministratör som skapade, uppdaterade eller tog bort en viss API-klient.

Mer information finns i Om granskningsloggar i Canva.

Organisationsadministratörer kan använda Admin API för att bjuda in personer till ett team, även externa samarbetspartner utanför organisationen.

Att tänka på

• Varje inbjudan du skapar gäller för ett team och en e-postadress.
• Varje inbjudan kan användas en gång och upphör att gälla efter 30 dagar.
• Beroende på konfigurationen kanske Canva inte skickar inbjudan till den inbjudna automatiskt. Dela i så fall inbjudningslänken direkt med personen.
• Håll inbjudningslänkar privata. En inbjudningslänk fungerar bara för den e-postadress den skapades för.
• Teamets befintliga inställningar för inbjudningar och domäner gäller fortfarande för personerna du bjuder in.
• Om det redan finns en väntande inbjudan för personen returneras samma inbjudningspost när du skapar en ny inbjudan. Giltighetstiden återställs då till 30 dagar från begäran och inbjudans roll uppdateras till den begärda rollen.

Information om slutpunkter finns i dokumentationen för Canva Admin API.

Både Admin API och SCIM kan användas för provisionering av användare.

Admin API stöder mer än bara provisionering av användare och kan användas för att hantera Canva-organisationer. Det omfattar team, grupper, medlemskap och granskningsloggar.

SCIM stöder standardiserad provisionering och avprovisionering. Om du bara behöver standardiserad användarprovisionering, eller om teamet inte kan bygga en anpassad API-integrering, passar SCIM bättre för dina behov.

Behöver organisationen en utvecklare för att använda Admin API?

Ja. För att använda Admin API behöver organisationen interna eller externa tekniska resurser som kan bygga och underhålla integreringen. Canva erbjuder inte support för implementering. Om teamet inte kan bygga mot ett API passar SCIM-provisionering bättre för att automatisera användarhanteringen i organisationen.

Måste alla i organisationen ha MFA eller SSO för att använda Admin API?

Nej. Endast organisationsadministratören som konfigurerar Admin API måste ha antingen MFA aktiverat eller ett konto som hanteras via SSO. Kontot måste hanteras eller ägas av organisationen som administratören företräder. Övriga medlemmar i organisationen behöver inte ha MFA eller SSO för att Admin API ska fungera.

Kan organisationen bjuda in externa samarbetspartner med Admin API?

Ja. Organisationsadministratörer kan använda Admin API för att bjuda in personer till team, även externa samarbetspartner. Teamets befintliga inställningar för inbjudningar och domäner gäller fortfarande för personerna du bjuder in.

Kan vi hämta en befintlig inbjudningslänk igen utan att skapa en ny inbjudan?

Ja. Du kan hämta en befintlig inbjudningslänk med den inbjudnas exakta e-postadress utan att skapa en ny inbjudan.