KAS API Dokumentation
Back to top  

Functions

Anlegen eines FTP Nutzers

add_ftpusers(array $parameter) 
link Beispiel

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • ftp_password: das FTP Passwort
  • ftp_comment: der Kommentar
  • ftp_path: der Pfad zum Login (optional, default /)
  • ftp_permission_read: der Nutzer darf lesen: Y|N (optional, default Y)
  • ftp_permission_write: der Nutzer darf lesen: Y|N (optional, default Y)
  • ftp_permission_list: der Nutzer darf lesen: Y|N (optional, default Y)
  • ftp_virus_clamav: der Nutzer hat einen Virenschutz: Y|N (optional, default Y)

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\couldnt_get_kas_ressources
\ftp_comment_syntax_incorrect
\ftp_permission_list_syntax_incorrect
\ftp_permission_read_syntax_incorrect
\ftp_permission_write_syntax_incorrect
\ftp_virus_clamav_syntax_incorrect
\max_ftpuser_reached
\missing_parameter
\password_syntax_incorrect
\path_syntax_incorrect

Löschen eines FTP Nutzers

delete_ftpuser(array $parameter) 
link Beispiel

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • ftp_login: das zu löschende Login

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\in_progress das KAS Objekt ist zZt noch in Bearbeitung
\ftp_login_belongs_to_account
\ftp_login_not_found
\ftp_login_syntax_incorrect

Auslesen der FTP Nutzer

get_ftpusers(array $parameter) 
link Beispiel

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • ftp_login: das gewünschte FTP Login (optional)

Exceptions

\array_return Array mit den vorhandenen FTP Nutzern im Account

Bearbeiten eines FTP Nutzers

update_ftpuser(array $parameter) 
link Beispiel

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • ftp_login: das zu bearbeitende Login
  • ftp_path: der Pfad zum Login (optional)
  • ftp_new_password: das neue FTP Passwort (optional)
  • ftp_comment: der Kommentar (optional)
  • ftp_permission_read: der Nutzer darf lesen: Y|N (optional)
  • ftp_permission_write: der Nutzer darf lesen: Y|N (optional)
  • ftp_permission_list: der Nutzer darf lesen: Y|N (optional)
  • ftp_virus_clamav: der Nutzer hat einen Virenschutz: Y|N (optional)

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\in_progress das KAS Objekt ist zZt noch in Bearbeitung
\nothing_to_do es wurde nichts geändert
\ftp_comment_syntax_incorrect
\ftp_login_not_found
\ftp_login_syntax_incorrect
\ftp_path_syntax_incorrect
\ftp_permission_list_syntax_incorrect
\ftp_permission_read_syntax_incorrect
\ftp_permission_write_syntax_incorrect
\ftp_virus_clamav_syntax_incorrect
\password_syntax_incorrect