API: Nutzer verwalten

Du kannst die Haiilo-API verwenden, um deine Nutzer zu verwalten. Wenn du die Nutzerverwaltung automatisieren möchtest, kannst du Skripte in deiner bevorzugten Programmiersprache schreiben und beispielsweise Nutzer erstellen, aktivieren, deaktivieren und löschen.

Um Anfragen an die Haiilo-API zu stellen, musst du dich zuerst authentifizieren. Detaillierte Informationen zur Authentifizierung und Verwendung der API findest du hier. Außerdem musst du dich als Superadmin anmelden, um die folgenden API-Schritte auszuführen.

Einen Nutzer erstellen

  1. Starte eine neue Anfrage
  2. Gib den Anfrage-Body ein, der die Informationen des Nutzers enthält, die du aktualisieren möchtest. Beispiel-Anfragetext:
    {
      "email": "email@example.com",
      "loginName": null,
      "loginNameAlt": null,
      "firstname": "Vorname",
      "lastname": "Nachname",
      "active": false,
      "superadmin": false,
      "groupIds": [ "89e32c67-e8ea-4f7a-b8ad-61d99fc051f9" ],
      "roleIds": [ "02e43ba4-e45b-4000-9a85-74d44e2ef2d1" ],
      "remoteLogonName": null,
      "persistedDisplayName": null,
      "password": "Passwort_123!",
      "welcomeMail": false,
      "generatePassword": false,
      "language": null,
      "temporaryPassword": true,
      "initialUser": false
    }
    
  3. Sende eine POST-Anfrage an den Endpunkt /api/users

Einen Nutzer aktivieren

  1. Sende eine PUT-Anfrage an den Endpunkt /api/users/<user_id>/activate, wobei <user_id> die ID des Nutzers ist, den du aktivieren möchtest

Einen Nutzer deaktivieren

  1. Sende eine PUT-Anfrage an den Endpunkt /api/users/<user_id>/deactivate, wobei <user_id> die ID des Nutzers ist, den du deaktivieren möchtest

Einen Nutzer löschen

  1. Sende eine DELETE-Anfrage an den Endpunkt /api/users/<user_id>, wobei <user_id> die ID des Nutzers ist, den du löschen möchtest

War dieser Beitrag hilfreich?