delete_user()

Löscht einen Benutzer aus der Datenbank-Tabelle benutzer. Mit gelöscht werden Gruppenzuordnungen (bgrel), Systemrollen (ossysroles), Abonnements (osabonnement) und persönliche Einstellungen (osconf). Mappen und Postfachinhalt können optional an einen anderen Benutzer weitergeleitet werden.

1. Signatur

  • Sync

  • Async

ecm.security.delete_user(
    user_guid: str,
    *,
    target_user_guid: str | None = None,
    forward_portfolios: bool = False,
    forward_mails: bool = False,
) -> None
await ecm.security.delete_user(...) -> None

2. Parameter

Parameter Standard Beschreibung

user_guid

—

GUID des zu löschenden Benutzers.

target_user_guid

None

GUID des Empfängers, der Mappen / Mails übernimmt. Serverseitig effektiv pflicht, auch wenn nichts weitergeleitet wird — leerer String wird abgelehnt (Fehler -1040906141). Der Wert muss auf einen anderen, existierenden Benutzer zeigen (z.B. den verbundenen Admin). Pflicht, wenn forward_portfolios oder forward_mails gesetzt ist (clientseitig erzwungen).

forward_portfolios

False

Mappen weiterleiten statt löschen.

forward_mails

False

Postfach weiterleiten statt löschen.

3. Rückgabewert

Keine.

4. Fehler

  • ValueError – wenn forward_* ohne target_user_guid aktiviert wird.

  • ECMException (oder Unterklasse) bei Server-Fehlern.

5. Beispiele

5.1. Konto vollständig löschen

target_user_guid ist auf v12 serverseitig pflicht. Pragmatisch: den verbundenen Admin als Ziel übergeben.

  • Sync

  • Async

admin = ecm.security.user("root")
ecm.security.delete_user(user.guid, target_user_guid=admin.guid)
admin = await ecm.security.user("root")
await ecm.security.delete_user(user.guid, target_user_guid=admin.guid)

5.2. Mappen und Postfach an einen Nachfolger übertragen

old = ecm.security.user("alice")
new = ecm.security.user("bob")
assert old and new

ecm.security.delete_user(
    old.guid,
    target_user_guid=new.guid,
    forward_portfolios=True,
    forward_mails=True,
)

6. Siehe auch