>_ NicAPI Dokumentation

REST-API von LUMASERV: Domains, DNS, SSL, Cloud-Server, IP-Adressen, Abrechnung und mehr.

  1. Einführung
  2. Account
  3. Benutzer

Account / Benutzer

POST API-Token anlegen API v1

POST https://connect.nicapi.eu/api/v1/account/users/tokens/create

Erstellt einen neuen API-Token.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USER_TOKENS_CRUD

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
user Pflicht Identifikator: Benutzer Identifikator (username) des Objekts „User“.
valid_until Optional Datum (YYYY-MM-DD)
darf leer (null) sein
token Pflicht Text
mindestens 64 Zeichen
 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "user": "{user}",
         "token": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/account/users/tokens/create"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("account/users/tokens/create", [
    'user' => '{user}',
    'token' => 'text',
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET API-Tokens abrufen API v1

GET https://connect.nicapi.eu/api/v1/account/users/tokens/tokens

Gibt alle zugewiesenen API-Tokens zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USER_TOKENS_LIST

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/account/users/tokens/tokens"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("account/users/tokens/tokens");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Einzelnen API-Token abrufen API v1

GET https://connect.nicapi.eu/api/v1/account/users/tokens/{user_token}

Gibt Informationen über einen einzelnen API-Token zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USER_TOKENS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user_token Pflicht Identifikator: API-Token Identifikator (token) des Objekts „User Token“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/account/users/tokens/{user_token}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("account/users/tokens/{user_token}");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST API-Token deaktivieren API v1

POST https://connect.nicapi.eu/api/v1/account/users/tokens/{user_token}/deactivate

Deaktiviert den übergebenen API-Token mit sofortiger Wirkung.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USER_TOKENS_CRUD

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user_token Pflicht Identifikator: API-Token Identifikator (token) des Objekts „User Token“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/account/users/tokens/{user_token}/deactivate"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("account/users/tokens/{user_token}/deactivate");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Benutzer abrufen API v1

GET https://connect.nicapi.eu/api/v1/account/users/{user}

Gibt Informationen zum übergebenen Benutzer zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USERS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user Pflicht Identifikator: Benutzer Identifikator (username) des Objekts „User“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/account/users/{user}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("account/users/{user}");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST Users: Emergency Contacts API v1

POST https://connect.nicapi.eu/api/v1/account/users/{user}/emergency_contacts
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USERS_EMERGENCY_CONTACTS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user Pflicht Identifikator: Benutzer Identifikator (username) des Objekts „User“, Teil des Pfads.

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
phone Pflicht Text
Telefonnummer im internationalen Format, z. B. +49.1234567890
 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "phone": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/account/users/{user}/emergency_contacts"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("account/users/{user}/emergency_contacts", [
    'phone' => 'text',
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

PUT Benutzer sperren API v1

PUT https://connect.nicapi.eu/api/v1/account/users/{user}/lock

Sperrt den übergebenen Benutzer.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USERS_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user Pflicht Identifikator: Benutzer Identifikator (username) des Objekts „User“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X PUT \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/account/users/{user}/lock"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::put("account/users/{user}/lock");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Rechte abrufen API v1

GET https://connect.nicapi.eu/api/v1/account/users/{user}/permissions

Rechte des übergebenen Benutzers abrufen.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USERS_PERMISSIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user Pflicht Identifikator: Benutzer Identifikator (username) des Objekts „User“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/account/users/{user}/permissions"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("account/users/{user}/permissions");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

PUT Rechte aktualisieren API v1

PUT https://connect.nicapi.eu/api/v1/account/users/{user}/permissions/update

Aktualisiert die Rechte des übergebenen Benutzers.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USERS_PERMISSIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user Pflicht Identifikator: Benutzer Identifikator (username) des Objekts „User“, Teil des Pfads.

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
permissions[] Pflicht Text
muss ein vorhandener Wert sein (permissions.key)
 
curl \
  -X PUT \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "permissions": [
             "text"
         ]
     }' \
  "https://connect.nicapi.eu/api/v1/account/users/{user}/permissions/update"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::put("account/users/{user}/permissions/update", [
    'permissions' => [
        'text',
    ],
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Users: Two Factor Auth API v1

GET https://connect.nicapi.eu/api/v1/account/users/{user}/two-factor-auth
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USERS_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user Pflicht Identifikator: Benutzer Identifikator (username) des Objekts „User“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/account/users/{user}/two-factor-auth"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("account/users/{user}/two-factor-auth");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST Users: Two Factor Auth Activate API v1

POST https://connect.nicapi.eu/api/v1/account/users/{user}/two-factor-auth/activate
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USERS_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user Pflicht Identifikator: Benutzer Identifikator (username) des Objekts „User“, Teil des Pfads.

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
required Optional Text
Regel: secret
 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "required": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/account/users/{user}/two-factor-auth/activate"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("account/users/{user}/two-factor-auth/activate", [
    'required' => 'text',
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST Users: Two Factor Auth Deactivate API v1

POST https://connect.nicapi.eu/api/v1/account/users/{user}/two-factor-auth/deactivate
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USERS_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user Pflicht Identifikator: Benutzer Identifikator (username) des Objekts „User“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/account/users/{user}/two-factor-auth/deactivate"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("account/users/{user}/two-factor-auth/deactivate");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

PUT Benutzer freigeben API v1

PUT https://connect.nicapi.eu/api/v1/account/users/{user}/unlock

Gibt den übergebenen Benutzer wieder frei.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USERS_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user Pflicht Identifikator: Benutzer Identifikator (username) des Objekts „User“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X PUT \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/account/users/{user}/unlock"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::put("account/users/{user}/unlock");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

PUT Benutzer aktualisieren API v1

PUT https://connect.nicapi.eu/api/v1/account/users/{user}/update
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
USERS_CRUD

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
user Pflicht Identifikator: Benutzer Identifikator (username) des Objekts „User“, Teil des Pfads.

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
email Optional E-Mail-Adresse
muss eindeutig sein (noch nicht vergeben)
password Optional Text
mindestens 5 Zeichen
gender Optional Text
first_name Optional Text
last_name Optional Text
city Optional Text
position Optional Text
street Optional Text
number Optional Text
zip Optional Text
country_id Optional Text
email_abuse Optional E-Mail-Adresse
email_accounting Optional E-Mail-Adresse
email_newsletter Optional E-Mail-Adresse
email_tech Optional E-Mail-Adresse
email_contact Optional E-Mail-Adresse
phone Optional Text
Telefonnummer im internationalen Format, z. B. +49.1234567890
fax Optional Text
Telefonnummer im internationalen Format, z. B. +49.1234567890
 
curl \
  -X PUT \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "email": "max@example.com",
         "password": "text",
         "gender": "text",
         "first_name": "text",
         "last_name": "text",
         "city": "text",
         "position": "text",
         "street": "text",
         "number": "text",
         "zip": "text",
         "country_id": "text",
         "email_abuse": "max@example.com",
         "email_accounting": "max@example.com",
         "email_newsletter": "max@example.com",
         "email_tech": "max@example.com",
         "email_contact": "max@example.com",
         "phone": "text",
         "fax": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/account/users/{user}/update"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::put("account/users/{user}/update", [
    'email' => 'max@example.com',
    'password' => 'text',
    'gender' => 'text',
    'first_name' => 'text',
    'last_name' => 'text',
    'city' => 'text',
    'position' => 'text',
    'street' => 'text',
    'number' => 'text',
    'zip' => 'text',
    'country_id' => 'text',
    'email_abuse' => 'max@example.com',
    'email_accounting' => 'max@example.com',
    'email_newsletter' => 'max@example.com',
    'email_tech' => 'max@example.com',
    'email_contact' => 'max@example.com',
    'phone' => 'text',
    'fax' => 'text',
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}