Die Kontoinformationen eines Benutzerkontos abrufen¶

Senden einer GET-Anfrage an den Endpunkt /users/{id}.

Beschreibung¶

Mit der Get-User-Information-Anfrage rufen Sie die Kontoinformationen eines Benutzerkontos der Organisation ab.

Voraussetzungen¶

Werte der Anfrage: User-ID {id}

Objekte: keine

Anfrage¶

Um die Kontoinformationen eines Benutzerkontos abzurufen, fügen Sie die User-ID {id} dem Pfad der Anfrage hinzu.

Als Ergebnis erhalten Sie ein Objekt UserVO mit den angefragten Informationen.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`email`	Die E-Mail-Adresse des Benutzerkontos.	`string`
`login`	Der Login-Name, der mit der E-Mail-Adresse übereinstimmt.	`string`
`firstname`	Der Vorname des Benutzers.	`string`
`lastname`	Der Name des Benutzers.	`string`
`organizationId`	Die ID der Organisation, der das Benutzerkonto zugeordnet ist.	`integer`
`organizationName`	Der Name der Organisation, der das Benutzerkonto zugeordnet ist.	`string`
`active`	Zeigt an, ob das Benutzerkonto aktiv oder inaktiv ist.	`active` `inactive`
`locked`	Zeigt an, ob das Benutzerkonto gesperrt ist.	`true` `false`
`agent`	Zeigt an, ob das Benutzerkonto Agent-Berechtigungen für die zugewiesene Organisation hat.	`true` `false`
`tfaEnabled`	Zeigt an, ob für das Benutzerkonto 2FA aktiviert ist.	`true` `false`
`tfaRequired`	Legt fest, ob das Benutzerkonto zur Aktivierung von 2FA verpflichtet ist.	`true` `false`
`roles`	Ein Array mit den Berechtigungsrollen des Benutzerkontos.	`ADMINISTRATOR` `USER`
`rootGroupRoles`	Ein Array mit Informationen zu den Gruppenberechtigungen des Benutzerkontos.	`ADMINISTRATOR` `USER`
`sessions`	Ein Array mit einem oder mehreren Objekten `UserSessionVO` mit Informationen zu den aktiven Sitzungen des Benutzerkontos.
`isIndirectCustomer`	Zeigt an, ob es sich um ein Benutzerkonto eines Partners oder eines Direktkunden von Myra handelt.	`true` `false`
`id`	Die ID des Eintrags.	`integer`
`modified`	Das Datum der letzten Änderung im ISO-8601-Format.	`string($date-time)`
`created`	Das Erstellungsdatum im ISO-8601-Format.	`string($date-time)`

Beispiel¶

Beispiel-Antwort:

{
  "email": "string",
  "login": "string",
  "firstname": "string",
  "lastname": "string",
  "organizationId": 0,
  "organizationName": "string",
  "active": "active",
  "locked": true,
  "agent": true,
  "tfaEnabled": true,
  "tfaRequired": true,
  "roles": "ADMINISTRATOR",
  "rootGroupRoles": "ADMINISTRATOR",
  "sessions": "string",
  "isIndirectCustomer": true,
  "id": 0,
  "modified": "2026-01-01T00:00:00+00:00",
  "created": "2026-01-01T00:00:00+00:00"
}

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
200	Das angefragte `UserVO`.
400	Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.