Attribute verwalten¶

Ein Attribut, etwa die Abteilung oder das Büro eines Mitglieds, ist eine Tatsache, die Regeln lesen können. Diese Seite zeigt, wie Sie ein Attribut festlegen, welche Werte es haben darf und wie Sie Mitgliedern und Gruppen einen Wert geben. Was Attribute sind, steht unter Rollen und Zugriff.

Attribute festlegen, ändern und löschen kann org-admin. Einen Wert geben kann, wer das Mitglied oder die Gruppe ändern darf, etwa people-admin, wenn er diesen Wert selbst hat; org-admin darf jeden Wert geben. Attribute haben in OS noch keinen Bildschirm: Sie verwalten sie über die API. Die Beispiele nutzen $OS, $TOKEN und $ORG wie unter Gruppen verwalten.

Ein Attribut festlegen¶

curl -s -X POST "$OS/api/v1/organisations/$ORG/attributes" \
    -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    -d '{"name": "department", "allowed_values": ["sales", "finance"], "multiple": true}'

OS antwortet 201:

{"id": "atd_...", "name": "department", "allowed_values": ["sales", "finance"],
 "multiple": true, "version": 1, "allowed_actions": ["see", "use", "write", "delete"]}

• name: Buchstaben, Ziffern und _ . : -, höchstens 64 Zeichen. role, group, subject, os_toolbox, os_offered, os_element, os_audience, os_assistant, os_element_editor, os_project, os_project_chats, os_project_files, os_visitor, os_desk, os_consultant, os_editor_scope und os_kb liest OS selbst ab, und Sie können sie nicht festlegen.
• allowed_values: die Werte, die das Attribut haben darf. Lassen Sie es weg, ist jeder Wert zulässig. Bei einer festen Liste lehnt OS auch eine Regel ab, die einen anderen Wert nennt, damit ein Tippfehler nicht stillschweigend nichts bewirkt.
• multiple: ob ein Mitglied oder eine Gruppe mehr als einen Wert haben darf. Standardmäßig einen.

Eine Organisation legt höchstens 16 Attribute fest: die 32, die ein Mitglied tragen kann, minus role, group, os_toolbox, os_offered, os_element, os_audience, os_assistant, os_element_editor, os_project, os_project_chats, os_project_files, os_visitor, os_desk, os_consultant, os_editor_scope und os_kb, die OS selbst setzt. Außerdem zählt OS zusammen, wie viele Attribute und Labels die Regeln Ihrer Organisation und jeder Organisation darunter nutzen: höchstens 32. Ein neues Attribut, das eine Organisation darüber hinausbrächte, lehnt OS mit 409 ab.

Die erlaubten Werte ändern¶

PUT .../attributes/department ersetzt allowed_values und multiple als Ganzes, mit der Version, die Sie gelesen haben, in If-Match. OS lehnt mit 409 ab, wenn die Änderung etwas zerstören würde:

• ein Mitglied oder eine Gruppe hat einen Wert, der nicht mehr in der Liste steht: nehmen Sie ihn zuerst zurück;
• eine Regel nennt einen Wert, der nicht mehr in der Liste steht, in Ihrer eigenen Organisation oder in einer Organisation darunter: ändern Sie diese Regel zuerst;
• Sie schalten multiple aus, während jemand mehr als einen Wert hat: nehmen Sie diese zuerst zurück.

Einen Wert geben¶

curl -s -X POST "$OS/api/v1/organisations/$ORG/attribute-values" \
    -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    -d '{"attribute": "department", "value": "sales", "member_id": "mem_..."}'

Geben Sie member_id für ein Mitglied oder group_id für eine Gruppe an; einen Wert einer Gruppe hat jedes Mitglied der Gruppe. Die Antwort hat eine ID wie mat_... (bei einem Mitglied) oder gat_... (bei einer Gruppe).

• GET .../attribute-values?member_id=mem_... oder ?group_id=grp_... zeigt die Werte, die ein Mitglied oder eine Gruppe selbst hat, nicht die über Gruppen.
• DELETE .../attribute-values/mat_... nimmt einen Wert zurück.

Ein Mitglied hat höchstens 32 Werte pro Attribut, jeder höchstens 256 Zeichen.

Ein Attribut löschen¶

DELETE .../attributes/department löscht das Attribut und jeden seiner Werte, bei Mitgliedern, bei Gruppen und in offenen Einladungen. Liest eine Regel das Attribut noch, in Ihrer eigenen Organisation oder in einer Organisation darunter, die es nicht selbst festlegt, lehnt OS mit 409 ab; ändern Sie diese Regel zuerst.

Wenn OS ablehnt¶