Benutzer zuweisen
Erforderliche Berechtigungen: projects:write, users:read, roles:read
Weist einer E-Mail eine oder mehrere mandantenweite Rollen zu und vergibt optional Mitgliedschaften auf Projekten und/oder Projektregionen. Der API-Schlüssel muss ein reiner Kunden-Schlüssel sein.
Bestehender Benutzer (status: ASSIGNED): Die E-Mail gehört bereits zu einem Benutzer des Mandanten (Vergleich ohne Groß-/Kleinschreibung). Alle angegebenen Rollen werden mandantenweit hinzugefügt; bereits vorhandene Rollen bleiben bestehen. Jede Projektmitgliedschaft verwendet die erste Rolle als projektbezogene Rolle und ersetzt bei Wiederholung diese Rolle. Regionsmitgliedschaften werden angelegt; bestehende Regionszeilen bleiben unverändert. projects und regions dürfen entfallen.
Unbekannte E-Mail (status: INVITED): Es wird mindestens ein Projekt oder eine Region benötigt. Pro Projekt wird eine ausstehende Einladung mit der ersten Rolle gespeichert, pro Region eine Einladung ohne Rolle. Weitere Rollen werden geprüft und in role_ids zurückgegeben. Mandantenweit gespeichert werden sie, sobald die E-Mail zu einem Benutzer gehört. Wiederholen Sie die Anfrage danach, um alle mandantenweiten Rollen zu setzen.
Adressierung: Jeder Projekteintrag enthält genau eines von project_number oder external_id. project_number ist nur je Buchungskreis eindeutig; ist sie im Mandanten mehrfach vergeben, antwortet die API mit HTTP 409 — verwenden Sie dann external_id. Regionen werden über region_number adressiert.
Upsert: Eine Wiederholung aktualisiert die bestehenden Zeilen. Ausgelassene Projekte, Regionen und Rollen bleiben unverändert. Alle Schreibvorgänge einer Anfrage laufen in einer Mutation und werden gemeinsam übernommen oder gemeinsam verworfen.
Leerzeichen an email, Rollentiteln und Kennungen werden entfernt. Rollentitel müssen exakt einer bestehenden Rolle des Mandanten entsprechen.
Übersicht
Weist einer E-Mail mandantenweite Rollen und optional Projekt- und Regionsmitgliedschaften zu. Eine Wiederholung aktualisiert die bestehenden Zeilen. Ausgelassene Zuweisungen bleiben bestehen. Der API-Schlüssel muss ein Kunden-API-Schlüssel sein.Berechtigungen
| Scope | Beschreibung |
|---|---|
projects:write | Projekte erstellen und ändern |
users:read | Benutzerdaten lesen |
roles:read | Rollendaten lesen |
Verhalten
- Rollentitel müssen exakt einer Rolle des Mandanten entsprechen. Die erste Rolle ist die projektbezogene Rolle jeder Mitgliedschaft und jeder Projekteinladung.
- Gehört die E-Mail bereits zu einem Benutzer, werden alle Rollen mandantenweit hinzugefügt (
ASSIGNED). Nicht genannte Rollen, Projekte und Regionen bleiben unverändert. Eine erneute Anfrage ersetzt die projektbezogene Rolle durch die erste Rolle der neuen Anfrage. - Ist die E-Mail unbekannt, sind
projectsoderregionserforderlich (INVITED). Die Projekteinladung speichert die erste Rolle; Regionseinladungen enthalten keine Rolle. Weitere Rollen werden geprüft und inrole_idszurückgegeben. Senden Sie die Anfrage erneut, sobald der Benutzer existiert, um alle mandantenweiten Rollen zu setzen. project_numberist je Buchungskreis eindeutig. Ist sie im Mandanten mehrdeutig, antwortet die API mit 409; verwenden Sieexternal_id.- Jeder Projekteintrag enthält genau eines von
project_numberoderexternal_id. Dasselbe Projekt oder dieselbe Region darf nicht zweimal vorkommen, auch wenn zwei Kennungen dasselbe Ziel auflösen.
Response Codes
| Code | Beschreibung |
|---|---|
201 | Zuweisung oder Einladungen gespeichert |
400 | Ungültige Anfrage |
401 | Nicht autorisiert |
403 | Fehlende Berechtigung oder kein Kunden-API-Schlüssel |
404 | Projekt, Region oder Rolle nicht gefunden |
409 | project_number ist im Mandanten mehrdeutig |
500 | Zuweisung oder Einladungen konnten nicht gespeichert werden |
Autorisierungen
API-Schlüssel zur Authentifizierung. Kontaktieren Sie Ihren Customer Success Manager, um einen API-Schlüssel zu erhalten.
Jeder Endpunkt erfordert spezifische Berechtigungen (Scopes); die erforderlichen Scopes werden pro Endpunkt angezeigt.
Body
E-Mail-Adresse, der die Rollen und Mitgliedschaften zugewiesen werden.
"jane.doe@example.com"
Titel der mandantenweiten Rollen. Mindestens eine, ohne Duplikate. Jede Rolle muss im Mandanten existieren. Bei Projekten wird die erste Rolle als projektbezogene Rolle verwendet.
1["MANAGER", "CONTROLLER"]
Optionale Projekte. Jeder Eintrag enthält genau eines von project_number oder external_id.
Dasselbe Projekt darf nicht zweimal vorkommen. Für unbekannte E-Mails ist mindestens
ein Projekt oder eine Region erforderlich.
Show child attributes
Show child attributes
Optionale Projektregionen, adressiert über region_number. Duplikate werden abgelehnt.
Bestehende Benutzer erhalten die Mitgliedschaft sofort; unbekannte E-Mails eine ausstehende Einladung.
Show child attributes
Show child attributes
Antwort
Zuweisung oder Einladungen gespeichert
Ob die Zuweisung gespeichert wurde
true
ASSIGNED, wenn die E-Mail bereits zu einem Benutzer des Mandanten gehört.
INVITED, wenn stattdessen ausstehende Projekt- und/oder Regionseinladungen gespeichert wurden.
ASSIGNED, INVITED "ASSIGNED"
E-Mail, für die die Zuweisung gespeichert wurde
"jane.doe@example.com"
UUIDs der aufgelösten mandantenweiten Rollen, in der Reihenfolge der Anfrage
["44444444-4444-4444-8444-444444444444"]
UUIDs der aufgelösten Projekte. Leer, wenn nur Rollen und/oder Regionen zugewiesen wurden.
["33333333-3333-4333-8333-333333333333"]
UUIDs der aufgelösten Projektregionen. Leer, wenn keine Regionen angefragt wurden.
["55555555-5555-4555-8555-555555555555"]