REST - Tworzenie i listowanie kont użytkowników

Tworzenie nowego konta

Zapytanie

PUT /v2/accounts

Tworzenie nowego konta użytkownika.

Zawartość zapytania

{ 
    "email": "$email",
    "first_name": "$first_name", 
    "last_name": "$last_name", 
    "phone": "$phone",
    "password": "$password"
}

Opis parametrów

$email (string) - adres e-mail właściciela konta
$first_name (string) - imię właściciela konta
$last_name (string) - nazwisko właściciela konta
$phone (string) - numer telefonu właściciela konta
$password (string) - nowe hasło dla konta

Odpowiedź

{
   "success":true,
   "user":{
      "id":"$user_id",
      "state":"$user_state",
      "name":"$user_name",
      "active":$user_active,
      "email":"$user_email",
      "phone":"$user_phone",
      "e24files":
      {
         "s3":
         {
            "api_id":"$s3_api_key",
            "secret_key":"$s3_secret_key"
         }
      },
      "api":
      [
         {
            "api_key":"$api_key",
            "secret_key":"$api_secret_key"
         }
      ],
      "sshkeys":
      [
         {
            "id":$ssh_id,
            "name":"$ssh_name",
            "fingerprint":"$ssh_fingerprint"
         }
      ]
   }
}

Zwracane informacje

$user_id (string) - UUID właściciela konta
$user_state (string) - status tworzenia konta użytkownika, jeśli tworzenie konta zostanie zakończone, wartość tego pola przyjmie wartość created
$user_name (string) - nazwa właściciela konta
$user_email (string) - adres e-mail właściciela konta
$user_phone (string) - numer telefonu właściciela konta
$user_active (bool) - informacja czy konto jest aktywne
$s3_api_key (string) - klucz dla połączenia S3
$s3_secret_key (string) - hasło dla połączenia S3
$api_key (string) - klucz API
$api_secret_key (string) - hasło API
$ssh_id (int) - ID klucza SSH
$ssh_name (string) - nazwa klucza SSH
$ssh_fingerprint (string) - odcisk klucza SSH

Listowanie kont użytkowników

Zapytanie

GET /v2/accounts?limit=$limit&offset=$offset

Listowanie kont użytkowników z możliwym określeniem limitów.

Opis parametrów

$limit (int) - maksymalna ilość zwróconych rekordów
$offset (int) - numer rekordu, od którego zostanie rozpoczęte zwracanie informacji

Updated on 12 Dec 2024