User Groups API

User Groups API slouží pro synchronizaci skupin a jejich členů. Změna členství ve skupině může spustit změnu studijních úkolů, protože obsah bývá přiřazený skupinám.

K čemu to použít

Obsah bývá přiřazený skupinám, takže kdo je ve které skupině, rozhoduje i o tom, co má kdo studovat. User Groups API drží toto členství v souladu s vaší organizační strukturou.

• Přesun do jiného týmu přinese správná školení. Skladník přejde na expedici. Váš systém ho odebere ze skupiny skladu a přidá do skupiny expedice podle personal_id. Protože je obsah přiřazený skupinám, mohou se s tím změnit i jeho studijní úkoly. Nikdo nemusí přepočítávat, co mu chybí.
• Skupiny nesou kód z vašeho systému. Oddělení se přejmenuje. Váš systém nastaví každé skupině external_id podle kódu organizační jednotky a páruje podle něj, ne podle name. Přejmenování pak synchronizaci nerozbije.
• Nástup celé směny najednou. Přichází čtyřicet lidí. Váš systém je přidá po dávkách a po každé dávce ověří výsledek výpisem skupiny. Kdo není mezi aktivními uživateli, má celou operaci shodit chybou, takže integrace má pro chybějící a archivované lidi postup připravený předem.

Než pošlete první dávku, přečtěte si níže, jak endpointy členství lidi identifikují a co se stane, když někoho nenajdou.

Podporované úlohy

Úloha	Poznámka
Výpis skupin	Vrací skupiny v company space.
Aktualizace skupiny	Lze měnit například external_id, name, self_assignable.
Přidání uživatelů	Lze identifikovat uživatele podle interních ID, personal_id nebo e-mailů.
Odebrání uživatelů	Stejné identifikační možnosti jako u přidání.

Identifikátory uživatelů

Endpointy pro členství podporují:

• primary_ids,
• personal_ids,
• emails.

Pokud některý uživatel není nalezen mezi aktivními uživateli v company space, operace má skončit chybou. Integrace by proto měla mít předem vyřešený postup pro chybějící nebo archivované uživatele.

Doporučený synchronizační model

Pro periodickou synchronizaci je lepší posílat změny po dávkách a po každém batchi ověřit výsledek výpisem skupiny. Hromadné operace mohou mít doménové dopady na přiřazení obsahu a reporting.