Wie können bestehende Gruppen über die API befüllt werden?

In der Praxis kann es vorkommen, dass Gruppen manuell über die Mitarbeiter App erstellt wurden, die im nachhinein durch die API mit Nutzer:innen befüllt werden sollen.

In diesem Fall ist es notwendig erst die ID dieser Gruppen über den GET "Get all existing groups" Request abzufragen. Alle Gruppen, welche in der Antwort keine external_ID haben wurden entweder per Excel-Import oder über das Admin Dashboard händisch in der App erstellt.

External ID vergeben

Um die Gruppen ohne external_ID für den Import von Nutzer:innen über die API zur Verfügung zu stellen, muss eine external_ID vergeben werden. Dafür wird im POST Request "Create or update multiple groups at once", die aus dem vorherigen Request im optionalen Feld group_ID angegeben und zusätzlich ein neuer eindeutiger Wert im Feld external_ID durch den Kunden vergeben.

Um die Nutzer:innen nun in die neu für die API verfügbar gemachte Gruppe zu importieren, sollte sichergestellt sein, dass die dafür vorgesehenen Nutzer:innen über einen "member of" tag verfügen, der als "value" die neu vergebene external_ID der Gruppe hat.

Beispiel:

Du willst Nutzer:innen in die Gruppe "Standort Stuttgart"  über die API  hinzufügen.

1. Über den "Get all existing groups" Request suchst du die Gruppe mit dem Namen "Standort Stuttgart". Von dieser Gruppe merkst du dir die ID, das ist die interne_ID der Gruppe.
2. Jetzt kannst du die Gruppe über den "Create or update multiple groups at once" Request updaten und zu einer externen Gruppe machen. Dafür gibst du als group_ID die ID der internen Gruppe an, die du im vorherigen Schritt herausgefunden hast. Als external_ID setzt du einen Wert mit dem du die Gruppe in deinem System später wieder identifizieren kannst. Die restlichen Felder füllst du mit neuen Informationen oder überträgst diese aus dem Request in Schritt 1.
3. Jetzt kannst du Nutzer:innen über die API zu dieser Gruppe hinzufügen. Dazu verwendest du den "Create or update multiple users at once" Request. In diesen setzt du für die dementsprechenden Nutzer:innen einen Tag mit dem key "memberOf" und als "value" verwendest du die external_ID, die im vorherigen Schritt der Gruppe vergeben wurde. Die Gruppe "Standort Stuttgart" kann jetzt über die API verwaltet werden. In weiteren Requests musst du die group_ID zum Updaten der Gruppe nicht mehr mitschicken.