Felhasználók — users
| Művelet | Mit tesz | Jog |
|---|---|---|
GET /users/list |
lista, szűrőkkel | users:read |
GET /users/get |
egy felhasználó, id vagy code szerint |
users:read |
GET /users/schema |
a mezők leírása | users:read |
POST /users/new |
új felhasználó | users:write |
POST /users/update |
módosítás — csak a küldött mező, updateMask-kal a felsorolt változik |
users:write |
POST /users/disable |
tiltás | users:delete |
POST /users/enable |
feloldás | users:delete |
A mezők
Szekció neve “A mezők”| Mező | Régi | Típus | Listában | Leírás | |
|---|---|---|---|---|---|
id |
integer |
csak olvasható | ✓ | belső azonosító | |
login |
string(8–40) |
kötelező | a bejelentkezési név, egyedi; csak írható — a válasz nem adja | ||
name |
string(60) |
kötelező | ✓ | a név | |
code |
string(40) |
✓ | külső azonosító (id és code), nem kötelezően egyedi: ha több felhasználónál ugyanaz, az id-vel keress |
||
extCode |
extcode |
string(40) |
✓ | egyéb kód, szabadon | |
position |
— | string(64) |
beosztás | ||
phone |
— | string(20) |
telefonszám | ||
email |
— | string(80) |
e-mail cím, a formája ellenőrzött | ||
note |
— | string |
megjegyzés | ||
roleId |
groupid |
integer |
✓ | a szerepkör belső azonosítója, szerepkör nélkül üres; bemenetben csak a schema válaszában álló érték adható — a 0 nem, a szerepkör nem vehető el · jog: users:role |
|
roleName |
groupname |
string |
✓ | a szerepkör neve; bemenetben a roleId helyett is megadható · jog: users:role |
|
folderId |
folderid |
integer |
✓ | a felhasználói mappa azonosítója | |
folderName |
foldername |
string |
✓ | a mappa neve; bemenetben a folderId helyett is megadható |
|
disabled |
boolean |
✓ | tiltott-e a felhasználó, a zárolt felhasználóra is true · jog: users:delete |
||
status |
state |
string |
csak olvasható | ✓ | az állapot: active, disabled vagy locked (zárolt) |
updatedAt |
— | string |
csak olvasható | ✓ | az utolsó módosítás ideje, eltolással — a nem látható adat változására is nő |
Két aktív, azonos nevű szerepkörnél a név nem dönt: ilyenkor az azonosítót küldd.
Jelszót az API nem fogad és nem ad.
GET /users/list Lista
Szekció neve “GET /users/list Lista”A felhasználók listája, lapozva (A lapozás). A törölt felhasználó nincs benne.
A kérés szűrői a query-stringben állnak, mind elhagyható:
| Paraméter | Régi | Típus | Leírás |
|---|---|---|---|
folderId |
— | integer |
csak ennek a mappának a felhasználói |
roleId |
— | integer |
csak ennek a szerepkörnek a felhasználói |
allowDisabled |
allow_disabled |
boolean |
a tiltottak és a zároltak is (true); alapból csak az aktívak |
{ "users": [ { "id": 42, "name": "Kovács Anna", "code": "HR-1042", "extCode": null, "roleId": 5, "roleName": "Operátor", "folderId": 2, "folderName": "Budapest", "disabled": false, "status": "active", "updatedAt": "2026-10-19T09:12:05+02:00" } ], "hasMore": false}curl "$BASE/users/list?roleId=5&allowDisabled=true" -H "X-API-Key: $API_KEY"GET /users/get Egy felhasználó
Szekció neve “GET /users/get Egy felhasználó”Egy felhasználó, minden mezőjével, a login nélkül.
{ "id": 42, "name": "Kovács Anna", "code": "HR-1042", "extCode": null, "position": "Operátor", "phone": "3610000001", "email": "anna.kovacs@example.com", "note": null, "roleId": 5, "roleName": "Operátor", "folderId": 2, "folderName": "Budapest", "disabled": false, "status": "active", "updatedAt": "2026-10-19T09:12:05+02:00"}| HTTP | code |
Mikor |
|---|---|---|
404 |
NOT_FOUND |
törölt felhasználó |
curl "$BASE/users/get?code=HR-1042" -H "X-API-Key: $API_KEY"GET /users/schema A mezők leírása
Szekció neve “GET /users/schema A mezők leírása”A roleId választható értékei a rendszer aktív szerepkörei. A válasz alakja: A mezők leírása.
curl "$BASE/users/schema" -H "X-API-Key: $API_KEY"POST /users/new Új felhasználó
Szekció neve “POST /users/new Új felhasználó”Kötelező a login és a name. A roleId és a roleName nélkül felvett felhasználónak nincs szerepköre, és amíg
nem kap, nem tud belépni.
{ "login": "kovacs.anna", "name": "Kovács Anna", "code": "HR-1042", "email": "anna.kovacs@example.com", "roleName": "Operátor", "folderId": 2}| HTTP | code |
Mikor |
|---|---|---|
422 |
VALIDATION_FAILED |
mezőhiba (fields): ismeretlen roleId (a 0 is), roleName, folderName vagy folderId (INVALID_VALUE) · két aktív szerepkör ugyanazzal a névvel (AMBIGUOUS) |
422 |
VALIDATION_FAILED |
a login foglalt (DUPLICATE) |
curl "$BASE/users/new" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \ -d '{"login": "kovacs.anna", "name": "Kovács Anna", "code": "HR-1042", "roleId": 5}'POST /users/update Módosítás
Szekció neve “POST /users/update Módosítás”{ "code": "HR-1042", "position": "Csoportvezető", "folderName": "Debrecen" }| HTTP | code |
Mikor |
|---|---|---|
404 |
NOT_FOUND |
törölt felhasználó |
422 |
VALIDATION_FAILED |
mezőhiba (fields): ismeretlen roleId (a 0 is), roleName, folderName vagy folderId, két aktív szerepkör ugyanazzal a névvel — mint a new-nál |
422 |
VALIDATION_FAILED |
a login foglalt (DUPLICATE) |
curl "$BASE/users/update" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \ -d '{"code": "HR-1042", "position": "Csoportvezető"}'POST /users/disable Tiltás
Szekció neve “POST /users/disable Tiltás”Tiltja a felhasználót: nem tud belépni, és a felületről is kilép. Az API-n a felhasználó nem törölhető: a kilépőt tiltsd.
{ "code": "HR-1042" }| HTTP | code |
Mikor |
|---|---|---|
404 |
NOT_FOUND |
törölt felhasználó |
curl "$BASE/users/disable" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" -d '{"code": "HR-1042"}'POST /users/enable Feloldás
Szekció neve “POST /users/enable Feloldás”Feloldja a tiltást, és a zárolást is: a felhasználó újra beléphet.
{ "code": "HR-1042" }| HTTP | code |
Mikor |
|---|---|---|
404 |
NOT_FOUND |
törölt felhasználó |
curl "$BASE/users/enable" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" -d '{"code": "HR-1042"}'A régi API-ból
Szekció neve “A régi API-ból”| Cím | Kérés | Válasz | Működés |
|---|---|---|---|
user/list → GET /users/list |
— | az elem status-a szöveg (active · disabled · locked), a régi state szám volt |
— |
user/get → GET /users/get |
— | — | — |
user/new → POST /users/new |
— | — | a pwd nincs; a szerepkörhöz és a disabled-hez külön jog kell; a roleId csak létező, aktív szerepkör — szerepkör nélkül a mező elmarad |
user/update → POST /users/update |
— | — | a pwd nincs; a szerepkörhöz és a disabled-hez külön jog kell; a szerepkör nem vehető el, a roleId: 0 422 |
| — | — | — | csak az újban: users/schema, users/disable, users/enable |