Service account kezelés

Alapok

A Service account-okat a rendszer által biztosított API végpontok eléréséhez használhatjuk. Minden service accountnak van egy azonosítója, amit login névként kell használni, és egy jelszava. Ezeket használva az API végpontokat hagyományos HTTP authentikációs header-el lehet meghívni.

Jelenleg a következő API végpontokhoz használhatók a service account-ok:

• api.atomdmp.com
• database.atomdmp.com

Ugyanaz a service account mindegyik végponthoz használható, feltéve, hogy rendelkezik a megfelelő szerepkörökkel (lásd lentebb).

A service account-okat a Config / Service Accounts menü alatt lehet kezelni: Itt egy lista látható az aktív account-okkal: Egy konkrét account jelszavát a Password gombra kattintva lehet lekérni.

A service account-oknak be lehet különböző szerepköröket állítani, ezekkel lehet korlátozni, hogy milyen API végpontokat érhetnek el. Az egyes API végpontok dokumentációjánál jelezve lesz, hogy milyen szerepkörökre van szükség az adott API használatához.

Új account létrehozása

Új account-ot az Add gombra kattintva lehet generálni. Mivel minden account-al el lehet érni minden API végpontot, így nem érdemes egyszerre egynél több aktív account-ot kezelni.

Szerepkörök módosítása

Egy service account szerepköreit egyszerűen a listában a checkbox-ok be, illetve kipipálásával lehet beállítani, majd az “Update roles” gombra kattintva elmenteni. Egy gomb egy konkrét account-hoz tartozik, így ha több service account is van, akkor egyesével kell azokat beállítani és elmenteni.

Account törlése

Amennyiben egy account hozzáférését bármilyen okból vissza kell vonni (például a jelszava publikussá válik), meg kell szüntetni az adott account-ot a Revoke gombbal, egy új account-ot generálni, és annak az adatait beállítani az API kliensbe.

Authentikáció és tesztelés

Az authentikációhoz Basic típusú Authorization header-t kell beállítani, a legtöbb HTTP kliens ezt natívan megteszi, amennyiben beállítjuk a felhasználónevet és jelszót.

A kapcsolatot a GET https://database.atomdmp.com/v1/whoami végponton lehet tesztelni, a request body-ban nem kell küldeni semmilyen adatot, azonban a HTTP Authentikációs adatokat a kiválasztott service account adataival kell feltölteni.

Sikeres hívás és aktív service account esetén HTTP 200 választ ad a végpont, illetve visszaadja a service account adatait:

{
   "login": "8d184e1536485ccb859639c7bc67625f86b73d9850ad21d1f16ca21aa553524f891470",
   "domain": "test1.wnftest.com",
   "roles": [
       "entity.list",
       "entity.view",
       "profile.delete",
       "profile.insert",
       "profile.list",
       "profile.update",
       "profile.view"
   ],
   "createdAt": "2020-09-30T13:28:41+02:00"
}