>_ NicAPI Dokumentation:

GET: get.account.users

/account/users 

$res = NicAPI::get("/account/users", [
]);

Rechte: ACCOUNTS_LIST • USERS_LIST

POST: Benutzer erstellen

/account/users/create 

$res = NicAPI::post("/account/users/create", [
    "username" => "value",
    "email" => "value",
    "password" => "value",
]);

Parameters:

Name Benötigt Typ Beschreibung
username string
email string
password string
Rechte: ACCOUNTS_CREATE • USERS_CREATE

POST: API-Token anlegen

/account/users/tokens/create 

$res = NicAPI::post("/account/users/tokens/create", [
    "user" => "value",
    "valid_until" => "value",
]);

Erstellt einen neuen API-Token.

Parameters:

Name Benötigt Typ Beschreibung
user string
valid_until date
Rechte: USER_TOKENS_CRUD

GET: API-Tokens abrufen

/account/users/tokens/tokens 

$res = NicAPI::get("/account/users/tokens/tokens", [
]);

Gibt alle zugewiesenen API-Tokens zurück.

Rechte: USER_TOKENS_LIST

GET: Einzelnen API-Token abrufen

/account/users/tokens/{user_token} 

$res = NicAPI::get("/account/users/tokens/{user_token}", [
]);

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

Parameters:

Name Benötigt Typ Beschreibung
user_token routeparameter
Rechte: USER_TOKENS_LIST

POST: API-Token deaktivieren

/account/users/tokens/{user_token}/deactivate 

$res = NicAPI::post("/account/users/tokens/{user_token}/deactivate", [
]);

Deaktiviert den übergebenen API-Token mit sofortiger Wirkung.

Parameters:

Name Benötigt Typ Beschreibung
user_token routeparameter
Rechte: USER_TOKENS_CRUD

GET: Benutzer abrufen

/account/users/{user} 

$res = NicAPI::get("/account/users/{user}", [
]);

Gibt Informationen zum übergebenen Benutzer zurück.

Parameters:

Name Benötigt Typ Beschreibung
user routeparameter
Rechte: USERS_LIST

PUT: Benutzer sperren

/account/users/{user}/lock 

$res = NicAPI::put("/account/users/{user}/lock", [
]);

Sperrt den übergebenen Benutzer.

Parameters:

Name Benötigt Typ Beschreibung
user routeparameter
Rechte: USERS_ACTIONS

GET: Rechte abrufen

/account/users/{user}/permissions 

$res = NicAPI::get("/account/users/{user}/permissions", [
]);

Rechte des übergebenen Benutzers abrufen.

Parameters:

Name Benötigt Typ Beschreibung
user routeparameter
Rechte: USERS_PERMISSIONS

PUT: Rechte aktualisieren

/account/users/{user}/permissions/update 

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

Aktualisiert die Rechte des übergebenen Benutzers.

Parameters:

Name Benötigt Typ Beschreibung
user routeparameter
Rechte: USERS_PERMISSIONS

PUT: Benutzer freigeben

/account/users/{user}/unlock 

$res = NicAPI::put("/account/users/{user}/unlock", [
]);

Gibt den übergebenen Benutzer wieder frei.

Parameters:

Name Benötigt Typ Beschreibung
user routeparameter
Rechte: USERS_ACTIONS

PUT: Benutzer aktualisieren

/account/users/{user}/update 

$res = NicAPI::put("/account/users/{user}/update", [
    "email" => "value",
    "password" => "value",
    "gender" => "value",
    "first_name" => "value",
    "last_name" => "value",
    "city" => "value",
    "position" => "value",
    "street" => "value",
    "number" => "value",
    "zip" => "value",
    "country_id" => "value",
    "email_abuse" => "value",
    "email_accounting" => "value",
    "email_newsletter" => "value",
    "email_tech" => "value",
    "email_contact" => "value",
]);

Parameters:

Name Benötigt Typ Beschreibung
email string
password string
gender string
first_name string
last_name string
city string
position string
street string
number string
zip string
country_id string
email_abuse string
email_accounting string
email_newsletter string
email_tech string
email_contact string
user routeparameter
Rechte: USERS_CRUD