Skip to main content
POST
Mit diesem Endpunkt änderst du die Workspace-Systemrolle eines aktiven menschlichen Mitglieds per E-Mail. Sende member, editor oder admin. Mit customRoleIds ersetzt du die benutzerdefinierten Rollen dieses Mitglieds. Der Aufruf ist über den USER_MANAGEMENT_API Scope des Workspace-API-Schlüssels autorisiert. Er läuft nicht als die Person, die den Schlüssel erstellt hat, und funktioniert weiter, wenn dieser Admin den Workspace verlässt.

​
Basis-URL

Dedicated DeploymentsErsetze api.langdock.com durch <your-deployment-url>/api/public in allen Anfragen.

​
Voraussetzungen

  • API-Schlüssel mit dem Scope USER_MANAGEMENT_API
  • Der API-Schlüssel muss von einem Workspace-Admin erstellt worden sein

​
Verhalten

  • customRoleIds weglassen? Bei member oder editor bleiben die aktuellen benutzerdefinierten Rollen.
  • customRoleIds senden? Die Liste ersetzt diese Rollen. [] entfernt alle. Sende höchstens 15 IDs. Die IDs kommen von Rollen auflisten. Doppelte IDs zählen zum Limit und werden einmal angewendet.
  • Eine ID in customRoleIds ist keine UUID, oder die Liste hat mehr als 15 IDs? Gibt 400 zurück und ändert nichts.
  • Unbekannte, gelöschte oder fremde benutzerdefinierte Rolle? Gibt 400 mit code: "BAD_REQUEST" und der Meldung Unknown custom role zurück. Es wird nichts geschrieben.
  • Auf admin setzen? Benutzerdefinierte Rollen und Extra-Berechtigungen entfallen, auch wenn du customRoleIds weglässt.
  • customRoleIds ist nicht leer und role ist admin? Gibt 400 mit code: "BAD_REQUEST" und der Meldung Admins already have every permission. Custom roles can only be assigned to members and editors. zurück. Es wird nichts geschrieben.
  • Extra-Berechtigungen bei member oder editor? Sie bleiben. Dieser Aufruf kann sie nicht setzen.
  • customRoleIds in der Antwort listet die benutzerdefinierten Rollen, die das Mitglied nach dem Aufruf hat, sortiert nach dem Zeitpunkt der Zuweisung.
  • Kein aktives menschliches Mitglied? Gibt 404 zurück (unbekannte E-Mail, eingeladen, deaktiviert, Service Account oder anderer Workspace).
  • Letzter verbleibender Admin? Gibt 400 mit code: "BAD_REQUEST" zurück.
  • Dieselbe Rolle erneut zu setzen, gibt 200 zurück.
  • Der E-Mail-Abgleich ist unabhängig von Groß- und Kleinschreibung. Rollenwerte sind kleingeschrieben: member, editor, admin. ADMIN gibt 400 zurück.
Langdock blockiert bewusst Browser-basierte Anfragen, um deinen API-Schlüssel zu schützen und die Sicherheit deiner Anwendungen zu gewährleisten. Weitere Informationen findest du in unserem Guide zu Best Practices für API-Schlüssel.

Autorisierungen

​
Authorization
string
header
erforderlich

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Body

application/json
​
email
string<email>
erforderlich

Email address of the active workspace member

Beispiel:

"user@example.com"

​
role
enum<string>
erforderlich

Workspace system role. Values are lowercase.

Verfügbare Optionen:
member,
editor,
admin
Beispiel:

"editor"

​
customRoleIds
string<uuid>[]

Custom role UUIDs from GET /user-management/v1/roles. Omit the field to keep the member's current custom roles, except when role is admin. Send a list, including an empty list, to replace them. At most 15 IDs. Duplicate IDs count toward that limit and are applied once. System role names are not accepted.

Maximum array length: 15

Antwort

Role updated successfully

​
status
enum<string>
erforderlich

Always "success" when the role is updated

Verfügbare Optionen:
success
Beispiel:

"success"

​
email
string<email>
erforderlich

Email address of the updated member

Beispiel:

"user@example.com"

​
role
enum<string>
erforderlich

System role after the update

Verfügbare Optionen:
member,
editor,
admin
Beispiel:

"editor"

​
customRoleIds
string<uuid>[]
erforderlich

Custom role IDs assigned to the member after this call, ordered by when each role was assigned. Empty after a promotion to admin.