Nutzer*in

/v1/users/{username}

Verwende diesen Endpunkt, um ein Nutzer*innenkonto abzurufen, zu löschen oder zu aktualisieren.

Lesen

Rufe Informationen über ein bestimmtes Nutzer*innenkonto ab.

Beispiel

Sende eine GET-Anfrage an den /users/{username}-Endpunkt, um ein Nutzer*innenkonto abzurufen:

GET /v1/users/username
Authorization: Bearer your-auth-token

Wenn die Anfrage erfolgreich war, enthält die Antwort den HTTP-Statuscode 200 OK und die folgende Payload:

{
   "users": [{
     "ROLES": "ROLE_ADMIN | ROLE_USER",
     "username": "username"
   }]
}

Aktualisieren

Nutzer*innen mit der Rolle ROLE_ADMIN können die Passwörter für Nutzer*innenkonten mit den Rollen ROLE_ADMIN und ROLE_USER aktualisieren. Normale Nutzer können das Passwort für ihr eigenes Konto ebenfalls aktualisieren. Wenn ein Kontopasswort geändert wird, werden die Zugriffsschlüssel für den*die jeweilige*n Nutzer*in nicht ungültig gemacht. Momentan hat nur der*die admin-Nutzer*in die Rolle ROLE_ADMIN, die anderen Nutzer*innen haben die Rolle ROLE_USER.

Beispiel

Um das Passwort für ein Konto zu aktualisieren, gib den Bearer-Schlüssel zusammen mit dem Benutzer*innennamen und dem neuen Passwort an.

PUT /v1/users/username
Authorization: Bearer your-auth-token
   
{
  "password": "new-password"
}

Wenn die Anfrage erfolgreich war, wird das Passwort für den angegebenen Benutzer*innennamen aktualisiert. Der HTTP-Statuscode 200 OK wird zusammen mit der folgenden Payload zurückgegeben:

{
   "users": [{
      "username": "username"
   }]
}

Löschen

Wenn ein Konto kompromittiert wurde oder aus einem anderen Grund entfernt werden soll, muss der*die admin-Nutzer*in das Konto löschen. Nach der erfolgreichen Löschung eines Kontos werden alle Schlüssel für das Konto aus dem System entfernt.

Beispiel

Mit der folgenden API-Anfrage kannst du ein Nutzer*innenkonto löschen, wobei username der Name des Nutzer*innenkontos ist, das gelöscht werden soll. Der Bearer-Schlüssel enthält den Schlüssel für das admin-Konto.

DELETE /v1/users/username
Authorization: Bearer your-auth-token

Wenn die Anfrage erfolgreich war, wird das Nutzer*innenkonto gelöscht. Die Antwort enthält den HTTP-Statuscode 200 OK und die folgende Payload:

{
   "users": [{
      "username": "username"
   }]
}

Fehlercodes