Users API

Users API pracuje primárně s členstvím uživatele v company space. V odpovědích a validacích se proto mísí údaje globálního uživatele a jeho členství v prostoru.

K čemu to použít

Users API je most mezi vaší personální evidencí a členstvím lidí v company space. Hodí se všude tam, kde by jinak někdo přepisoval lidi ručně.

• Nástup se zadává jednou, v HR systému. Personalistka založí nového zaměstnance. Váš systém ho přes Users API vytvoří v company space, čímž vznikne aktivní členství. Jako klíč používá personal_id, protože e-mail se může časem změnit. Nikdo nezakládá tutéž osobu dvakrát.
• Odchod je archivace, ne smazání. Zaměstnanec odejde a HR systém ho archivuje. Členství se interně revokuje, ale záznam nezaniká. Když se za rok vrátí, obnova mu členství vrátí a nevzniká druhý účet.
• Reorganizace propíše nové vedoucí. Oddělení dostane nového šéfa. Váš systém u každého člena zaktualizuje supervizora, kterého může zadat interním ID, personal_id nebo e-mailem. Odpadá ruční překlikávání desítek lidí.
• Noční porovnání dvou evidencí. Skript si vypíše uživatele, případně zúžené podle stavu, a porovná je s HR. Kdo chybí, toho založí; kdo odešel, toho archivuje. Rozdíly se neřeší až při auditu.

Než začnete, dohodněte s druhou stranou primární identifikátor. Zbytek stránky vysvětluje, proč to pro HR bývá personal_id, a na které hraniční případy narazíte.

Podporované úlohy

Úloha	Poznámka
Výpis uživatelů	Podporuje filtrování podle stavu a sync_status.
Detail uživatele	Lze dohledávat interním ID nebo personal_id.
Vytvoření uživatele	Zakládá aktivní členství v company space.
Aktualizace uživatele	Mění údaje uživatele i jeho členství.
Archivace	Interně revokuje členství.
Obnova	Vrací revokované členství zpět.

Identifikátory

Pro integrace je důležité dohodnout, jestli primárním identifikátorem bude:

• interní ID,
• personal_id,
• e-mail.

E-mail je uživatelsky čitelný, ale nemusí být stabilní. personal_id je často lepší pro HR integrace.

Hraniční případy

• Archivace není fyzické smazání.
• Změna full_name se může promítnout do dalších členství stejného globálního uživatele.
• Supervisor lze zadat přes interní ID, personal_id nebo e-mail.
• Validace posledního vlastníka chrání company space před ztrátou vlastníka.