check_permission()

Prüft, ob der aktuelle Benutzer die angeforderten Berechtigungen auf einem Objekt besitzt. Es geht genau ein DMS.CheckPermission hinaus, das alle angeforderten Berechtigungen in seiner Access-Zeichenkette trägt.

Um zu prüfen, ob ein Objekt an einem Ort eingefügt werden darf, dient check_insert_permission().

1. Signatur

  • Sync

  • Async

ecm.dms.check_permission(
    model: _ECMModelBase | int | str,
    object_type_id: int | str | None = None,
    *,
    read: bool = False,
    write: bool = False,
    execute: bool = False,
    delete: bool = False,
    update: bool = False,
    folder_id: int | str | ECMFolderModel | None = None,
    register_id: int | str | ECMRegisterModel | None = None,
    register_type: int | str | None = None,
) -> bool
await ecm.dms.check_permission(
    model: _ECMModelBase | int | str,
    object_type_id: int | str | None = None,
    *,
    read: bool = False,
    write: bool = False,
    execute: bool = False,
    delete: bool = False,
    update: bool = False,
    folder_id: int | str | ECMFolderModel | None = None,
    register_id: int | str | ECMRegisterModel | None = None,
    register_type: int | str | None = None,
) -> bool

2. Parameter

Parameter Typ Standard Beschreibung

model

_ECMModelBase | int | str

—

Entweder eine ECM-Modell-Instanz (deren id wird verwendet) oder eine numerische Objekt-ID.

object_type_id

int | str | None

None

Die numerische Objekttyp-ID. Wenn None, wird der Typ automatisch über get_object_type_by_id() ermittelt.

read

bool

False

Prüft die Berechtigung zum Lesen von Indexdaten (R).

write

bool

False

Prüft die Berechtigung zum Schreiben von Indexdaten (W).

execute

bool

False

Prüft die Berechtigung zum Öffnen/Ausführen (X).

delete

bool

False

Prüft die Löschberechtigung (D).

update

bool

False

Prüft die Berechtigung zum Aktualisieren des Objekts (U).

folder_id

int | str | ECMFolderModel | None

None

ID des Ordners oder eine ECMFolderModel-Instanz für standortbasierte Berechtigungsprüfungen.

register_id

int | str | ECMRegisterModel | None

None

ID des übergeordneten Registers oder eine ECMRegisterModel-Instanz für standortbasierte Berechtigungsprüfungen.

register_type

int | str | None

None

Typ des übergeordneten Registers. 0 bedeutet, das Objekt befindet sich direkt auf Ordnerebene, -1 bedeutet registerunabhängig.

Mindestens eines der Flags read, write, execute, delete oder update muss True sein.

3. Zugriffsflags

Flag Parameter Beschreibung

R

read

Indexdaten des Objekts lesen.

W

write

Indexdaten des Objekts schreiben.

X

execute

Objekt öffnen oder ausführen.

D

delete

Objekt löschen.

U

update

Objekt aktualisieren (Dateien ersetzen).

Alle angeforderten Flags reisen in einem einzigen DMS.CheckPermission. Der Stapeljob DMS.CheckPermissions wird nicht verwendet: er erwartet nummerierte ObjectType<n>- / ObjectList<n>-Parameter und beantwortet eine Anfrage für ein einzelnes Objekt mit Rückgabecode 0 und ganz ohne Ausgabe.

4. Wie der Server das Ergebnis meldet

DMS.CheckPermission antwortet mit Rückgabecode 0, unabhängig davon, ob die Berechtigungen bestehen oder nicht. Das Ergebnis steht im Ausgabeparameter Access: jede gewährte Berechtigung wird an ihrer Stelle wiederholt, jede verweigerte durch - ersetzt.

Gesendetes Access Zurückgegebenes Access Bedeutung

RWXDU

RWXDU

Alle fünf Berechtigungen gewährt.

RWXDU

R---U

Nur Lesen und Aktualisieren gewährt.

RWXDU

-----

Keine Berechtigung gewährt.

D

-

Löschen verweigert.

Ein Rückgabecode ungleich 0 ist damit nicht der Kanal für eine Verweigerung. Ein Serverfehler bleibt eine Exception und wird nie zu einem False verkürzt.
Mit explizitem object_type_id beantwortet der Server eine unbekannte Objekt-ID oder einen falschen Typ genauso wie eine Verweigerung: Rückgabecode 0 und - an jeder Stelle, das Ergebnis ist also False (gemessen auf enaio 12.0). Nur die automatische Typauflösung wirft bei unbekannter ID eine ECMNotFoundException. Wer ein fehlendes Objekt von einer Verweigerung unterscheiden muss, lässt object_type_id weg.

5. Rückgabewert

True, wenn der Benutzer alle angeforderten Berechtigungen besitzt, andernfalls False. Eine fehlende oder unplausible Access-Ausgabe gilt als verweigert, damit ein unlesbares Ergebnis den Zugriff nie ausweitet.

6. Ausnahmen

Ausnahme Bedingung

ValueError

model ist eine Modell-Instanz mit id gleich None, keines der Berechtigungsflags ist True, oder model ist 0 ohne object_type_id. Objekttyp 0 ist ein echter Ordnertyp und kein neutraler Platzhalter, die Einfügeprüfung braucht daher check_insert_permission().

ECMNotFoundException

object_type_id ist None und kein Objekt mit der angegebenen ID existiert auf dem Server. Mit explizitem Typ liefert derselbe Fall False, siehe oben.

7. Beispiele

7.1. Leseberechtigung auf einem Dokument prüfen

  • Sync

  • Async

doc = ecm.dms.get(InvoiceDocument, 12345)
if ecm.dms.check_permission(doc, read=True):
    print("Read access granted")
doc = await ecm.dms.get(InvoiceDocument, 12345)
if await ecm.dms.check_permission(doc, read=True):
    print("Read access granted")

7.2. Mehrere Berechtigungen gleichzeitig prüfen

  • Sync

  • Async

if ecm.dms.check_permission(12345, read=True, write=True, delete=True):
    print("Full access")
else:
    print("Restricted access")
if await ecm.dms.check_permission(12345, read=True, write=True, delete=True):
    print("Full access")
else:
    print("Restricted access")

8. Siehe auch