Skip to main content
GET
Benutzerarchive auflisten

Authorizations

Authorization
string
header
required

Access-Token aus POST /auth/login (E-Mail und Passwort), gesendet als Authorization: Bearer <token>.

Das Token ist zeitlich begrenzt gültig. Mit dem refresh_token aus derselben Antwort holt POST /auth/token/refresh ein neues Token-Paar, ohne das Passwort erneut zu senden; POST /auth/token/invalidate macht den Refresh-Token beim Abmelden ungültig.

Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert der Login statt des Token-Paars mfaRequired: true bzw. mfaEnrollmentRequired: true und ein kurzlebiges preAuthToken. Mit diesem Token (ebenfalls als Bearer) wird der zweite Faktor über POST /auth/2fa/verify bestätigt; erst danach gibt es das volle Token-Paar.

Headers

X-Customer-Id
string

Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und Schreibzugriffe beziehen sich dann auf diesen Kunden.

Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden mit 403 Forbidden abgewiesen, eine unbekannte ID ebenfalls.

Die IDs der erreichbaren Kunden liefern GET /user/customers und GET /customers/{id}/children.

Example:

"01JD4Q8W3N6Y2K5T7R9V0B1C2D"

Path Parameters

instanceId
string
required

MailStoreInstance identifier

Query Parameters

page
integer
default:1

The collection page number

Response

200 - application/json

MailStoreUser collection

userName
string
default:""

Der userName ist innerhalb einer Instanz eindeutig und dient als Identifier.

Example:

"max.mustermann"

fullName
string | null
Example:

"Max Mustermann"

distinguishedName
string | null

Distinguished Name aus dem Verzeichnisdienst (leer, wenn der Nutzer lokal angelegt wurde).

Example:

"CN=Max Mustermann,OU=Users,DC=example,DC=com"

mfaStatus
string | null

MFA-Status des Benutzers auf der Instanz (SPE-Feld mfaStatus).

Example:

"disabled"