Zum Hauptinhalt gehen

Haiilo API: Nutzer anlegen oder löschen

  • Aktualisiert
Hinweis: Der folgende Artikel ist aufgrund der technischen Natur des Themas auf Englisch.
 

Mit unserer REST-API könnt ihr eure Nutzer verwalten. Wenn ihr dies automatisieren möchtet, könnt ihr Skripte in eurer bevorzugten Sprache schreiben.
Ein paar Beispiele, die automatisiert werden könnten sind: Anlegen, Deaktivieren, Aktivieren und Löschen von Nutzern.

Die vollständige Benutzerdokumentation für unsere Cloud findet ihr hier.

 

Wenn ihr On-Premises verwendet, findet ihr die Dokumentation in eurer Installation. Bitte passt die folgende URL an:

https://<Ihre Coyo-Domain>/docs/restdoc/guide/users

Im Folgenden erklären wir euch das Anlegen und Löschen eines Nutzers.

 

Voraussetzungen

Zuerst müsst ihr euch mit eurem Haiilo-Nutzer über unsere OAuth2-Schnittstelle authentifizieren, um euren Zugangs-Token zu erhalten. Dieser Zugangs-Token wird zur Authentifizierung eurer späteren Anfragen verwendet. 

Hinweis:
Bitte beachtet, dass ihr in der API die gleichen Rechte habt wie bei der Anmeldung über das Web. Es macht also einen Unterschied, ob ihr den Moderatorenmodus aktiviert oder euch als Superadmin anmeldet.  

curl -x POST https://<your-coyo-domain>/api/oauth/token?grant_type=password&username=<loginName>&password=<password>

Autorisierung: api-CLIENT-ID:CLIENT-SECRET

Ersetzt die folgenden Daten durch eure:
<your-coyo-domain>
<loginName>
<password>

Beispielantwort:
{
    "access_token": "d3cd7b86-234b-4037-9f9f-6083b4df355e",
    "token_type": "bearer",
    "refresh_token": "aa2c35f7-4448-46af-94d5-6427d777ada7",
    "expires_in": 3599,
    "scope": "read write"
}
 
Nachdem ihr euren Zugangs-Token habt, könnt ihr mit der API arbeiten. Beachtet, dass bei jedem Aufruf der API der Zugangs-Token verwendet werden muss.
Wenn ihr ein Tool wie Postman verwendet, könnt ihr die Authentifizierungsmethode Bearer Token wählen und den Token dort einfügen.
 
Wenn ihr eine curl für den Zugriff auf die API verwendet, könnt ihr den Zugangs-Token am Ende der URL hinzufügen.
 
Beispiel:
curl -x POST https://<your-coyo-domain>/api/users?access_token=197801e3-08b8-4007-a3df-3b64152972d3

 

Nutzer anlegen

Führt einen POST auf /api/users durch und fügt die Benutzerinformationen als json body (application/json) hinzu.

Beispiel für eine Anfrage:
curl -x POST https://<your-coyo-domain>/api/users?access_token=197801e3-08b8-4007-a3df-3b64152972d3


Beispiel Anforderungstext:
{
  "email" : "email@coyo4.com",
  "loginName" : null,
  "loginNameAlt" : null,
  "firstname" : "First Name",
  "lastname" : "Last Name",
  "active" : true,
  "superadmin" : true,
  "groupIds" : [ "c7ea28be-4e2e-4571-945b-d0b3be84af35" ],
  "roleIds" : [ "ac368349-6874-4cd2-843c-e9f309ab3f99" ],
  "remoteLogonName" : null,
  "password" : "SomePassword_123!",
  "welcomeMail" : false,
  "generatePassword" : false,
  "initialUser" : false
}

 

Nutzer löschen

Führt den Befehl DELETE auf /api/users/{id} aus

Ersetze die {id} durch die user_ID des zu löschenden Nutzers.
Beispiel für eine Anfrage:
curl -x DELETE https://<your-coyo-domain>/api/users/172fed3f-52c9-40e4-8ccf-c785934c5630?access_token=197801e3-08b8-4007-a3df-3b64152972d3

Verwandte Beiträge