users()

Gibt alle auf dem Server bekannten Benutzerkonten zurück. Mit extended_info=True werden zusätzliche Felder je Benutzer befüllt.

1. Signatur

  • Sync

  • Async

ecm.security.users(*, extended_info: bool = False) -> list[ECMUser]
await ecm.security.users(*, extended_info: bool = False) -> list[ECMUser]

2. Parameter

Parameter Standard Beschreibung

extended_info

False

Bei True werden zusätzlich groups, remark, valid_from und valid_to je Benutzer vom Server abgerufen und befüllt.

3. Rückgabewert

Liste von ECMUser-Instanzen, eine pro Benutzerkonto.

3.1. ECMUser-Felder

Feld Typ Beschreibung

id

int

Numerische Benutzer-ID.

username

str

Kurzer interner Benutzername.

login_name

str

Anmeldename für die Authentifizierung.

display_name

str

Vollständiger Anzeigename.

email

str

E-Mail-Adresse.

guid

str

Globally Unique Identifier des Benutzerkontos.

profile_id

int

Profil-ID: -1 = kein Profil, 0 = Benutzerprofil, >0 = zugewiesenes Profil.

locked

bool

True wenn das Konto gesperrt ist.

remark

str

Bemerkung aus der Benutzerkonfiguration. Nur mit extended_info=True befüllt.

valid_from

datetime | None

Gültig-ab-Datum. Nur mit extended_info=True befüllt.

valid_to

datetime | None

Gültig-bis-Datum. Nur mit extended_info=True befüllt.

groups

list[str]

Namen der Gruppen, denen der Benutzer angehört. Nur mit extended_info=True befüllt.

4. Beispiele

4.1. Alle Benutzer auflisten

  • Sync

  • Async

users = ecm.security.users()
for user in users:
    print(user.username, user.display_name, user.email)
    if user.locked:
        print(f"  → gesperrt")
users = await ecm.security.users()
for user in users:
    print(user.username, user.display_name, user.email)

4.2. Mit Gruppeninformationen

  • Sync

  • Async

users = ecm.security.users(extended_info=True)
for user in users:
    print(user.username, user.groups)
users = await ecm.security.users(extended_info=True)
for user in users:
    print(user.username, user.groups)

4.3. Gesperrte Konten finden

  • Sync

  • Async

locked = [u for u in ecm.security.users() if u.locked]
print(f"{len(locked)} gesperrte Konten")
locked = [u for u in await ecm.security.users() if u.locked]
print(f"{len(locked)} gesperrte Konten")

5. Siehe auch

  • user() — Detaillierte Attribute eines einzelnen Benutzers

  • user_groups() — Gruppen eines bestimmten Benutzers abrufen