Personen einladen¶

Mit einer Einladung fügen Sie jemanden Ihrer Organisation hinzu, mit den Rollen, Gruppen und Attributen, die Sie sofort vergeben möchten. Diese Seite richtet sich an Administratoren: wer in der Organisation die Rechte eines Administrators oder Personenverwalters hat. Wie die eingeladene Person die Einladung annimmt, steht unter Eine Einladung annehmen.

Jemanden einladen¶

Wählen Sie die E-Mail-Adresse der Person.
Wählen Sie die Rollen, Gruppen und Attributwerte, die die Person bekommt. Sie können nur vergeben, was Sie selbst haben; sonst weist OS die Einladung ab (warum).
Senden Sie die Einladung. Die eingeladene Person erhält einen Link.

Die Mail sagt der eingeladenen Person, was als Nächstes kommt: ein Passwort wählen (für eine Adresse ohne Konto), sich anmelden oder sich mit dem Firmenkonto anmelden. Welcher Fall es ist, sehen Sie als Administrator nicht: Eine Einladung sieht für Sie immer gleich aus.

Der Link gilt, bis die Einladung abläuft (standardmäßig sieben Tage). Nur die eingeladene Person kann ihn nutzen, angemeldet mit genau dieser Adresse. Ein weitergeleiteter Link gibt anderen keinen Zugriff. Beim Annehmen prüft OS erneut, ob Sie die gewählten Rollen, Gruppen und Werte noch vergeben dürfen; verlieren Sie diese Rechte inzwischen, ist die Einladung ungültig und Sie laden erneut ein.

Viele Personen auf einmal einladen¶

Auf der Seite Mitglieder öffnet Mitglieder importieren zwei Wege, viele Personen auf einmal einzuladen. Alle bekommen eine eigene Einladung per E-Mail und tragen ihren Namen beim Annehmen selbst ein.

Liste einfügen. Fügen Sie eine E-Mail-Adresse pro Zeile ein, bloß oder mit einem Namen davor, wie ein Mailprogramm sie kopiert ("Henk de Vries" <henk@beispiel.de>); der Name wird nicht verwendet. Darüber wählen Sie die Gruppen, Rollen und den Bereich, die alle bekommen. Eine Zeile ohne gültige Adresse lehnt die ganze Liste ab.
CSV-Datei. Eine Datei mit einer Spalte E-Mail und nach Wahl Gruppen und Rollen mit den Namen, wie sie unter Gruppen und Rollen stehen (mehrere durch Komma getrennt), sodass jede Person eigene bekommt. Laden Sie die Beispieldatei herunter, um zu sehen, wie es geht; eine Excel-Datei speichern Sie zuerst als CSV. Die Datei bleibt in Ihrem Browser und geht nicht an OS. Bis zu 500 Personen pro Datei, höchstens 1 MB. Zeilen mit einem Problem (keine gültige Adresse, eine Adresse aus einer früheren Zeile, eine Gruppe oder Rolle, die es nicht gibt) werden übersprungen; Sie können sie mit dem Grund herunterladen, korrigieren und erneut importieren.

Die Seite sendet die Einladungen in Paketen von 25. Lassen Sie sie offen, bis sie fertig ist: Schließen Sie sie, stoppt das Senden, und wer schon eine Einladung hat, behält sie. Danach sehen Sie für jede Person, ob die Einladung gesendet wurde und wenn nicht, warum: dieselben Gründe wie bei einer Einladung, unten. Fehlgeschlagene versuchen Sie mit einem Knopf erneut, und das Ergebnis laden Sie als CSV herunter.

Offene Einladungen ansehen und zurückziehen¶

Sie sehen die Einladungen, die noch nicht angenommen wurden. Eine offene Einladung ziehen Sie zurück; der Link funktioniert dann nicht mehr. Eine angenommene Einladung ziehen Sie nicht zurück: Dann ist die Person Mitglied, und Sie deaktivieren oder entfernen das Mitglied.

Wer nach einer Entfernung erneut eingeladen wird, erhält eine neue Mitgliedschaft, die bei null beginnt.

Wenn OS ablehnt¶

403: Sie vergeben eine Rolle, Gruppe oder einen Wert, den Sie selbst nicht haben; die Meldung nennt, was.
409: Die Einladung würde Ihre Organisation oder eine darunter mehr als 32 Attribute und Labels nutzen lassen, oder eine Rolle mit Reichweite descendants würde einer Organisation darunter mehr als 500 Regeln in den KI-Funktionen geben. Das kann beim Senden und beim Annehmen geschehen. Vergeben Sie weniger, vergeben Sie die Rolle mit Reichweite organisation oder fragen Sie Ihren Betreiber.
422: Eine Rolle, Gruppe oder ein Attribut, die oder das nicht existiert, oder ein Wert, den das Attribut nicht zulässt.

Über die API¶

POST /api/v1/organisations/{id}/invitations mit email und nach Wahl roles (jeweils {"role": ..., "reach": ...}, siehe Rollen verwalten), groups (IDs von Gruppen) und attributes (jeweils {"attribute": ..., "value": ...}, siehe Attribute verwalten).
POST /api/v1/organisations/{id}/invitations/batch mit invitations, einer Liste von 1 bis 100 Einladungen derselben Form. Die Antwort gibt je Einladung, in derselben Reihenfolge, sent mit der Einladung oder refused mit dem Grund; eine abgelehnte hält die übrigen nicht auf. Eine Zeile in falscher Form (eine Adresse über 320 Zeichen, mehr als 32 Gruppen oder Rollen) lehnt die ganze Anfrage mit 422 ab, bevor etwas gesendet ist. Nach einer 500 können die Zeilen davor schon eingeladen sein; erneut gesendet antworten sie 409, schon eingeladen.
GET /api/v1/organisations/{id}/invitations zeigt die offenen Einladungen.
DELETE /api/v1/organisations/{id}/invitations/{invitation_id} zieht eine zurück.