Konton för API-tjänster

Om servicekonton

När en klient gör förfrågningar via den externa API:n görs dessa förfrågningar på uppdrag av användarkontot som tilldelats kunden via inställningen för servicekonto.

• Alla API-klientbegäranshändelser kommer att loggas som tillhörande servicekontoanvändaren.
• Kontroller för åtkomstkontroll kommer att baseras på användaren av servicekontot. Detta innebär att du kan använda roller och behörigheter för att kontrollera de åtgärder som en specifik klient tillåts utföra via sin användare av servicekonto.
• Multitenansbegränsningar kommer att tillämpas på användare av tjänstekonton som tillhör en specifik hyresgäst.

Användarbegränsningar för servicekonto

För att framgångsrikt kunna göra API-förfrågningar måste servicekontoanvändaren vara giltig och ha en miniminivå för åtkomst. För klient-API-klienter måste användare av servicekonto tillhöra samma klient som API-klienten.

Följande kontroller görs för att säkerställa att användaren av servicekontot uppfyller dessa krav:

• Har inte statusen raderad eller avstängd
• Är inte gästanvändare
• Är inte en webbplatsadministratör
• Klienten för servicekontoanvändaren matchar API-klientens klient (t.ex. användare på systemnivå för systemklienter, eller tillhör samma klient som klient för klienter på klientnivå)

Om en eller flera av dessa kontroller misslyckas kommer alla förfrågningar till API från klienten att misslyckas och klienten kommer att markeras som ogiltig. Du måste då uppdatera servicekontot för att välja en ny giltig användare av servicekontot.

Roller och behörigheter för tjänstekonton

Åtkomsten som en specifik klient kommer att ha inom systemet kommer att kontrolleras av de roller som tilldelats till kundens servicekonto. När du konfigurerar servicekontot är det bästa praxis att begränsa servicekontot till att endast bevilja de behörigheter det behöver. Detta innebär att om API-klienttokens skulle fångas upp skulle det begränsa vad som skulle kunna göras med dem.

Det finns en API-användarroll som du kan tilldela till tjänstekontot som ger bred behörighet att slutföra uppgifter för vilka det finns befintliga tjänster. Detta kan begränsas ytterligare genom att skapa dedikerade roller för specifika uppgifter och tilldela dessa till servicekonton i lämpligt sammanhang.

För klienter på systemnivå kan roller tilldelas i systemkontexten. Klienter som är specifika för innehavare kommer endast att ha servicekonton som tillhör den innehavaren, så de måste tilldelas i ett lägre sammanhang - antingen innehavarens sammanhang (för funktioner relaterade till användare) eller innehavarens kategorisammanhang (för funktioner relaterade till kurser eller andra systemobjekt). API-användarrollen kan tilldelas i båda dessa sammanhang.

Konfiguration av rekommenderat servicekonto

Vi rekommenderar att du skapar en dedikerad användare av ett servicekonto för varje klient du skapar. Detta låter dig specificera finkornig åtkomstkontroll för den specifika klienten och säkerställer att det är möjligt att granska API-användning på klientnivå.

Vi rekommenderar att du konfigurerar användare av ditt servicekonto enligt följande:

• Ange ett användarnamn, förnamn och efternamn som tydligt identifierar kontot som ett automatiserat konto och dess syfte. Du kan till exempel namnge kontot 'HR sync API user'. Detta kan hjälpa till att förhindra att kontot tas bort av en annan webbplatsadministratör.
• Ställ in autentiseringsmetoden på Ingen inloggning för att förhindra manuell inloggning.
• Överväg att ställa in en profilbild som förstärker kontots automatiserade karaktär, till exempel din företagslogotyp.
• Vanligtvis vill du inte att användaren av servicekontot ska ta emot e-postmeddelanden. Du kan helt inaktivera notifieringar för användaren genom att gå till deras profil, sedan Inställningar > Äldre notifieringsinställningar . Här kan du markera kryssrutan Inaktivera notifieringar.
• Svar som tas emot från API kommer att visas i användarens tidszon för servicekontot. Överväg den bästa tidszonen och ange användarens tidszon på lämpligt sätt i sin profil.
• Se till att användaren av servicekontot har rätt behörigheter för den uppgift som den kommer att utföra. Se avsnittet Servicekontoroll och behörigheter för mer information.