Zum Hauptinhalt springen
GET
curl

Überblick

Gibt eine paginierte Liste der Benutzer-Entitäten für die authentifizierte Anwendung zurück. Verwenden Sie diesen Endpoint, um Benutzer mit Ihrem Data Warehouse zu synchronisieren, Benutzer zu finden, die eine Prüfung durch Analysten benötigen, oder nach Anzeigenamen zu suchen.

Wann verwenden

  • Periodische Synchronisierung Ihrer Benutzertabelle mit einem externen BI-System oder Data Warehouse.
  • Analystenwarteschlangen: Filtern Sie nach status=FLAGGED oder veraltetem last_activity_at, um einen Posteingang für Prüfungen zu füllen.
  • Benutzer suchen nach display_name, full_name oder vendor_data.

Filter und Paginierung

Hinweise

  • Jedes Element der Antwort enthält didit_internal_id. vendor_data kann null sein, wenn die ursprüngliche Sitzung oder Transaktion keinen Wert übergeben hat.
  • Dieser Endpoint paginiert über einen Cursor. Speichern Sie den next-Cursor zwischen den Aufrufen und beenden Sie die Abfrage, sobald next leer ist.
  • Alle Felder einer Benutzerzeile finden Sie im Datenmodell für Benutzer.

Berechtigungen

Jeder aktive API-Schlüssel der Anwendung kann diesen Endpoint aufrufen. API-Schlüssel von Didit sind an die Anwendung gebunden, nicht an Rollen: Die Rollen und Berechtigungen der Console (list:users und weitere) bestimmen, was eine Person in der Console tun darf, und werden für Datenverkehr der Management API nicht ausgewertet. Steuern Sie, wer diesen Endpoint aufrufen darf, indem Sie steuern, wer den API-Schlüssel der Anwendung lesen darf.

Verwandte Themen

Autorisierungen

x-api-key
string
header
erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Abfrageparameter

limit
integer
Standard:50

Seitengröße. Standardmäßig 50, wenn nicht angegeben. Es gibt kein festes Maximum, aber halten Sie die Seiten klein, um die Latenz gering zu halten.

Erforderlicher Bereich: 1 <= x <= 1000000
offset
integer
Standard:0

Nullbasierter Offset des ersten zurückzugebenden Datensatzes. Folgen Sie vorzugsweise der next-URL der vorherigen Seite, statt diesen Wert manuell zu berechnen.

Erforderlicher Bereich: 0 <= x <= 1000000

Antwort

Paginierte Liste von Benutzern mit Verifizierungsstatus, Sitzungsanzahl und Aufschlüsselung der Funktionen.

count
integer

Anzahl der übereinstimmenden Zeilen – exakt bis 100, darüber hinaus aus Performancegründen auf 100 begrenzt. Verwenden Sie diesen Wert nicht, um die letzte Seite zu erkennen; verlassen Sie sich stattdessen darauf, dass next null ist.

next
string | null

Absolute URL der nächsten Seite oder null auf der letzten Seite.

previous
string | null

Absolute URL der vorherigen Seite oder null auf der ersten Seite.

results
object[]
Zuletzt geändert am 7. November 2026