Skip to main content

Benutzer anlegen

Um einen Benutzer anlegen zu können, reicht eine einzelne API abfrageAnfrage an den Endpunkt [POST] /clients aus. Das bewirkt,Über das derFeld id_hosting_plan bestimmen Sie, welche Ressourcen und Berechtigungen dieser Benutzer mitbesitzen darf.

Über den StandardEndpunkt Ressourcenund[GET] berechtigungen/hosting-plans angelegtkann wird.
Umermittelt jetztwerden, einen Benutzer direkt mit vorgegeben ressourcen-Limits und berechtigungen anlegen zu können, müssen wir zunächst die vorhanden Konto-vorlagen (= hosting plans) auslesen und dort diewelche ID deswelcher Konto-Vorlage zugeordnet ist. Die ID der gewünschten Konto-Vorlage auslesen.verwenden Sie dann als Wert für das id_hosting_plan Feld. Existieren noch keine Konto-Vorlagen, müssen diese zunächst erstellt werden.

MitIm dieserFolgenden IDsoll könnendas wirAnlegen daneines demBenutzers Benutzer die geünwschten Ressourcen /berechtigungen zuweisen.

In folgendem Beispiel wollen wir einen Neuen Benutzer "webhosting-001" anlegen001 und diedas Werteübertragen der Einstellungen einer Konto-Vorlage "HostingPlus"mit übertragen.dem Namen HostingPlus demonstriert werden.


 

Konto-Vorlagen auslesen

Über den API-Endpunkt [GET] /hosting-plans können alle im KeYHelpKeyHelp angelegten Konto-vorlagen abgefragt werden.

Es kann ü

Über den API-Endpunkt [GET] /hosting-plans/name/<NAME> auchkönnen gezielt die Daten einer Konto-Vorlage mit dem gewünschten Namen abgefragt werden, wie in dender folgenden Abfragen verdeutlicht.


Anfrage
PHP 
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://<HOSTNAME>/api/v2/hosting-plans/name/<NAME>'HostingPlus');
curl_setopt($curl, CURLOPT_HTTPHEADER, [
  'X-API-KEY: <API-KEY>',
  'Content-Type: application/json',
]);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);

Bash 
curl -X 'GET' \
  'https://<HOSTNAME>/api/v2/hosting-plans/name/<NAME>'HostingPlus' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <API-KEY>'


Antwort

HTTP Status-Code: 200

{
  "id": 8,3,
  "name": "Hosting Plus"HostingPlus",
  "resources": { ... },
  "permissions": { ... },
  "php": { ... },
  "php_fpm": { ... }
}

Benutzer anlegen

Zum Anlegen des Benutzers verwenden wir den Endpunkt [POST] /clients.
Aus der vorrangegangenvorangegangen Abfrage der Konto-Vorlage übernehmen wir dasden FeldWert des Feldes id der Konto-vorlage und übertragen geben diesesie IDals beimWert Anlegen eines Benutzers überfür das Feld id_hosting_plansid_hosting_plan an. 
Wir erhalten die ID des soeben angelegten Benutzers zurück, sowie dessen zufällig generiertes Passwort.


Anfrage
PHP 
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, 'https://<HOSTNAME>/api/v2/hosting-plans/name/<NAME>'clients');
    curl_setopt($curl, CURLOPT_HTTPHEADER, [
        'X-API-KEY: <API-KEY>',
        'Content-Type: application/json',
    ]);
    curl_setopt($curl, CURLOPT_POST, true);
    curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode([
        'username' => 'webhosting-001',
        'id_hosting_plan' => 3,
    ]));
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($curl);

Bash 
curl -X 'GET'POST' \
  'https://<HOSTNAME>/api/v2/hosting-plans/name/<NAME>'clients' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <API-KEY>' \
  -d '{ "username": "webhosting-001", "id_hosting_plan": 3 }'

 

Antwort

HTTP Status-Code: 200201

{
    "id": 8,23,
    "name"password": "Hosting Plus",
  "resources": { ... },
  "permissions": { ... },
  "php": { ... },
  "php_fpm": { ... }ry[Pm-^Hv+5E"
}

Back to top