REST - Zarządzanie kontami użytkowników, kluczami API i SSH

Szczegóły konta

Zapytanie

GET /v2/account

Zwraca tablicę ze szczegółami konta użytkownika.

Odpowiedź

{
   "success":true,
   "account":{
      "id":"$user_id",
      "name":"$user_name",
      "email":"$user_email",
      "phone":"$user_phone",
      "notification": {
         "email": "$notification_email",
         "phone": "$notification_phone"            
      },
      "e24files":
      {
         "s3":
         {
            "api_id":"$s3_api_key",
            "secret_key":"$s3_secret_key"
         },
         "swift":
         {
            "api_id":"$swift_api_key",
            "secret_key":"$swift_secret_key"
         }
      },
      "api":
      [
         {
            "api_key":"$api_key",
            "secret_key":"$api_secret_key"
         },
         {...}
      ],
      "sshkeys":
      [
         {
            "id":$ssh_id,
            "name":"$ssh_name",
            "fingerprint":"$ssh_fingerprint"
         },
         {...}
      ],
      "groups": 
      [
         {
            "id":$group_id,
            "name":"$group_name",
         },
         {...}
      ]
   }
}

Zwracane informacje

$user_id (string) - UUID właściciela konta
$user_name (string) - nazwa właściciela konta
$user_email (string) - e-mail właściciela konta
$user_phone (string) - numer telefonu właściciela konta
$notification_email (string) - e-mail właściciela konta dla powiadomień
$notification_phone (string) - numer telefonu właściciela konta dla powiadomień
$s3_api_key (string) - klucz dla połączenia S3
$s3_secret_key (string) - hasło dla połączenia S3
$swift_api_key (string) - klucz dla połączenia Swift
$swift_secret_key (string) - hasło dla połączenia Swift
$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
$group_id (string) - ID grupy użytkownika
$group_name (string) - nazwa grupy użytkownika

Zmiana danych konta

Zapytanie

POST /v2/account/data

Zmienia dane na koncie.

Zawartość zapytania

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

Opis parametrów

$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 (pole opcjonalne)

Odpowiedź

{  
  "success":true
}

Dodanie klucza dla API EC2 i e24cloud

Zapytanie

PUT /v2/account/api

Tworzy i zwraca klucz oraz secret_key dla API EC2 i e24cloud.

Odpowiedź

{
   "success":true,
   "api":
   {
        "api_key":"$api_key",
        "secret_key":"$api_secret_key"
   }
}

Zwracane informacje

$api_key (string) - klucz API
$api_secret_key (string) - hasło API

Zmiana secret-key dla API EC2 i e24cloud

Zapytanie

POST /v2/account/api-new-secret-key

Generuje i zwraca nową wartość secret_key dla API EC2 i e24cloud.

Zawartość zapytania

{ 
   "api_key":"$api_key",
}

Opis parametrów

$api_key (string) - klucz API

Odpowiedź

{
   "success":true,
   "api":
   {
        "api_key":"$api_key",
        "secret_key":"$api_secret_key"
   }
}

Zwracane informacje

$api_key (string) - klucz API
$api_secret_key (string) - nowe hasło API

Usunięcie klucza dla API EC2 i e24cloud

Zapytanie

DELETE /v2/account/api

Usuwa klucz oraz hasło dla API EC2 i e24cloud.

Zawartość zapytania

{ 
   "api_key":"$api_key",
}

Opis parametrów

$api_key (string) - klucz API

Odpowiedź

{
   "success":true
}

Dodanie klucza SSH

Zapytanie

PUT /v2/account/sshkey

Dodaje lub generuje klucz SSH.

Zawartość zapytania

{
    "name": "$ssh_name",
    "method": "$ssh_method",
    "content": "$ssh_key",
}

Opis parametrów

$ssh_name (string) - klucz API
$ssh_method (string) - parametr przyjmuje jedną z dwóch wartości:
- generate - generuje klucz SSH
- upload - pozwala nam wgrać klucz SSH
$ssh_key (string) - jeśli $ssh_method został ustawiony na upload, wtedy API wymaga aby w tym polu podać klucz SSH, który chcemy wgrać

Odpowiedź

{
    "success":true,
    "sshkeys":
    {
        "id":$ssh_id,
        "name":"$ssh_name",
        "fingerprint":"$ssh_fingerprint"
    }
}

Zwracane informacje

$ssh_id (int) - ID klucza SSH
$api_key (string) - klucz API
$api_secret_key (string) - nowe hasło API

Usunięcie klucza SSH

Zapytanie

DELETE /v2/account/$SSH_ID/sshkey

Usuwa klucz SSH o podanym $SSH_ID.

Odpowiedź

{
   "success":true
}

Nowy secret-key dla API e24files

Zapytanie

POST /v2/account/files-new-secret-key

Generuje i zwraca nową wartość secret-key dla API e24flies - zarówno dla połączenia kompatybilnego z S3, jak i kompatybilnego ze Swiftem.

Zawartość zapytania

{ 
   "api_key":"$api_key",
}

Opis parametrów

$api_key (string) - klucz API

Odpowiedź

{
    "success":true,
    "e24files":
    {
        "s3":
        {
            "api_id":"$s3_api_key",
            "secret_key":"$s3_secret_key"
        },
        "swift":
        {
            "api_id":"$swift_api_key",
            "secret_key":"$swift_secret_key"
        }
    }
}

Zwracane informacje

$s3_api_key (string) - klucz dla połączenia S3
$s3_secret_key (string) - hasło dla połączenia S3
$swift_api_key (string) - klucz dla połączenia Swift
$swift_secret_key (string) - hasło dla połączenia Swift

Updated on 23 May 2024