All Classes Files Functions Variables Pages
Public Member Functions | List of all members
webadmin::Authentication Interface Reference

Public Member Functions

void get (out AuthenticationConfig config)
 
void set (in AuthenticationConfig config)
 
void join (out kerio::web::LocalizableMessage message, out JoinStatus status, in string hostName, in string domainName, in CredentialsConfig credentials, in string server)
 
void isJoinServerNeeded (out boolean needServer, in string domainName)
 
void leave (out kerio::web::LocalizableMessage message, out JoinStatus status, in CredentialsConfig credentials)
 
void getJoinStatus (out JoinStatus status, out string domainName)
 
void getTotpConfig (out TotpConfig config)
 
void setTotpConfig (in TotpConfig config)
 

Member Function Documentation

void webadmin::Authentication::get ( out AuthenticationConfig  config)

Returns Authetication option settings

Parameters
config- configuration values
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::Authentication::getJoinStatus ( out JoinStatus  status,
out string  domainName 
)

tests if computer is joined to domain

Parameters
status- current status
domainName- a string representation of joined domain.
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::Authentication::getTotpConfig ( out TotpConfig  config)

Returns TotpConfig

Parameters
config- configuration values
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::Authentication::isJoinServerNeeded ( out boolean  needServer,
in string  domainName 
)

tests, if join's param server need to be filled

Parameters
needServer- true - join must have param server.enabled on true and server.value filled
domainName- domain name (e.g. example.com)
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::Authentication::join ( out kerio::web::LocalizableMessage  message,
out JoinStatus  status,
in string  hostName,
in string  domainName,
in CredentialsConfig  credentials,
in string  server 
)

joins computer to domain

Parameters
message- text related to join result
status- current status
hostName- name of the computer that will be set to computer and in domain controller
domainName- domain name (e.g. example.com)
credentials- domain account with rights to join the domain
server- server name (e.g. server.example.com) - filled only in case, that joinNeedServer returns true
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::Authentication::leave ( out kerio::web::LocalizableMessage  message,
out JoinStatus  status,
in CredentialsConfig  credentials 
)

disconnects computer from domain

Parameters
message- text related to leave result
status- current status
credentials- domain account with rights to leave from domain
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::Authentication::set ( in AuthenticationConfig  config)

Stores Authetication option settings

Parameters
config- configuration values
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::Authentication::setTotpConfig ( in TotpConfig  config)

Stores TotpConfig

Parameters
config- configuration values
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
The documentation for this interface was generated from the following file: