Konfigurera och använd Canva administratör API

Du kan använda Canva Admin API för att automatisera organisationshanteringen 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-distrikt och Canva för Campus.
• Tillgängligt för organisationsadministratörer.
• Tillgängligt för organisationer med ett eller flera team.

Se till att organisationen uppfyller följande krav innan du konfigurerar Admin API:

• Organisationsnivå: Admin API hanteras på organisationsnivå. Det är tillgängligt för organisationer med ett eller flera team som har abonnemangen Canva för företag, Canva-distrikt eller 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 implementeringssupport.
  • Om teamet inte kan bygga en lösning baserad på ett API passar SCIM-provisionering bättre för att automatisera användarhanteringen i organisationen.
• Kunskap om Canva-strukturen: Se till att ha en tydlig bild av hur organisationen, teamen och grupperna är uppsatta i Canva innan du bygger integreringen.
• Multifaktorautentisering (MFA) eller konto som hanteras med enkel inloggning (SSO): Organisationsadministratören som konfigurerar Admin API måste ha MFA aktiverat eller ett konto som hanteras med SSO. Kontot måste hanteras eller ägas av organisationen som personen agerar på uppdrag av.

Admin API tillhandahåller slutpunkter för:

• Användare, team och grupper: Skapa, läsa, uppdatera och ta bort.
• Medlemskap: Lägg till eller ta bort personer från team och grupper och ange deras roller.
• Granskningsloggar: Hämta händelser från granskningsloggen enligt ett schema.
• Teaminbjudningar: Bjud in personer till ett team (även personer utanför organisationen), visa väntande inbjudningar, hämta en befintlig inbjudningslänk med hjälp av den exakta e-postadressen och avbryt 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 APIn för att byta klientuppgifterna mot en åtkomsttoken och börja skicka API-förfrågningar.

Dela dokumentationen om autentisering för Canva Admin API med teknikteamet för teknisk information om autentisering av API-förfrågningar och användning av OAuth 2.0-bärartoken.

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

I granskningsloggar visar fältet Actor Admin API-klientens namn och klient-ID. På så sätt kan du se vilken integrering som utförde en åtgärd.

Du kan också ta reda på 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.

Viktigt att veta

• 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.
• Inställningarna kan innebära att Canva inte skickar ett e-postmeddelande till den inbjudna personen 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 personer 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 förfrågan och inbjudningsrollen uppdateras till den begärda rollen.

Information om slutpunkterna 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 fler delar av organisationshanteringen i Canva än enbart provisionering av användare. Det omfattar team, grupper, medlemskap och granskningsloggar.

SCIM stöder standardiserad provisionering och avprovisionering. Om du bara behöver standardiserad provisionering av användare, 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 för att bygga och underhålla integreringen. Canva erbjuder inte implementeringssupport. Om teamet inte kan bygga en lösning baserad på 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 MFA aktiverat eller ett konto som hanteras med SSO. Kontot måste hanteras eller ägas av organisationen som personen agerar på uppdrag av. Ö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 personer 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 hjälp av den inbjudna personens exakta e-postadress, utan att skapa en ny inbjudan.