KAS API Dokumentation
Back to top  

Functions

Anlegen eines Verzeichnisschutz-Einstellungen

add_directoryprotection(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
  • directory_user: das Login
  • directory_path: der Pfad
  • directory_password: das Passwort
  • directory_authname: der Kommentar

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\directory_password_syntax_incorrect
\directory_path_syntax_incorrect
\directory_user_count_neq_passcount
\directory_user_syntax_incorrect
\duplicate_directory_user
\max_directory_user_reached
\directory_authname_syntax_incorrect

Löschen der Verzeichnisschutz-Einstellungen

delete_directoryprotection(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
  • directory_user: das Login
  • directory_path: der Pfad

Exceptions

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

Auslesen der gesetzen Verzeichnisschutz-Einstellungen

get_directoryprotection(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
  • directory_path: der Pfad (optional)

Exceptions

\array_return Array mit den vorhandenen Verzeichnisschutz-Einstellungen

Bearbeiten der Verzeichnisschutz-Einstellungen

update_directoryprotection(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
  • directory_user: das Login
  • directory_path: der Pfad
  • directory_password: das neue zu setzende Passwort
  • directory_authname: der Kommentar

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
\directory_password_syntax_incorrect
\directory_path_syntax_incorrect
\directory_user_syntax_incorrect
\directory_authname_syntax_incorrect