Public Member Functions |
void | exportCertificate (out kerio::web::Download fileDownload, in kerio::web::KId id) |
void | exportPrivateKey (out kerio::web::Download fileDownload, in kerio::web::KId id) |
void | get (out CertificateList certificates) |
void | generate (out kerio::web::KId id, in kerio::web::NamedValueList subject, in long valid) |
void | generateRequest (out kerio::web::KId id, in kerio::web::NamedValueList subject) |
void | importCertificate (in kerio::web::KId id, in string fileId, in string password) |
void | importPrivateKey (out boolean needPassword, out kerio::web::KId id, in string fileId) |
void | remove (out kerio::web::ErrorList errors, in kerio::web::KIdList certificateIds) |
void | setActive (in kerio::web::KId id) |
void | toSource (out string source, in kerio::web::KId id) |
Member Function Documentation
void kerio::jsonapi::admin::ConnectCertificate::exportCertificate |
( |
out kerio::web::Download |
fileDownload, |
|
|
in kerio::web::KId |
id |
|
) |
| |
Export of certificate or certificate request Note: "export" is a keyword in C++, so name of the method must be changed: exportCertificate
- Parameters
-
id | - ID of the certificate or certificate request |
fileDownload | - description of the output file |
void kerio::jsonapi::admin::ConnectCertificate::exportPrivateKey |
( |
out kerio::web::Download |
fileDownload, |
|
|
in kerio::web::KId |
id |
|
) |
| |
Export of certificate or request privatekey Note: "export" is a keyword in C++, so the name of the method must be changed: exportPrivateKey
- Parameters
-
id | - ID of the certificate or certificate request |
fileDownload | - description of the output file |
void kerio::jsonapi::admin::ConnectCertificate::generate |
( |
out kerio::web::KId |
id, |
|
|
in kerio::web::NamedValueList |
subject, |
|
|
in long |
valid |
|
) |
| |
Generate a self-signed certificate
- Parameters
-
id | - ID of the new generated certificate |
subject | - information about subject |
valid | - length of the certificate's validity (in years, max value is 10) |
void kerio::jsonapi::admin::ConnectCertificate::generateRequest |
( |
out kerio::web::KId |
id, |
|
|
in kerio::web::NamedValueList |
subject |
|
) |
| |
Generate certificate request
- Parameters
-
id | - ID of the new generated certificate request |
subject | - information about subject |
void kerio::jsonapi::admin::ConnectCertificate::get |
( |
out CertificateList |
certificates | ) |
|
Obtain a list of certificates
- Parameters
-
certificates | - current list of certificates |
void kerio::jsonapi::admin::ConnectCertificate::importCertificate |
( |
in kerio::web::KId |
id, |
|
|
in string |
fileId, |
|
|
in string |
password |
|
) |
| |
Import private key for the new certificate.
- Parameters
-
needPassword | - true if private key is encrypted with password |
id | - ID of private key or certificate request which belongs to the certificate |
fileId | - ID of the uploaded file |
password | - certificate password, if it is set (use empty string if password is not set) |
void kerio::jsonapi::admin::ConnectCertificate::importPrivateKey |
( |
out boolean |
needPassword, |
|
|
out kerio::web::KId |
id, |
|
|
in string |
fileId |
|
) |
| |
Import private key for the new certificate.
- Parameters
-
needPassword | - true if private key is encrypted with password |
id | - temporary ID to assign certificate to private key |
fileId | - ID of the uploaded file |
void kerio::jsonapi::admin::ConnectCertificate::remove |
( |
out kerio::web::ErrorList |
errors, |
|
|
in kerio::web::KIdList |
certificateIds |
|
) |
| |
Remove list of certificate records
- Parameters
-
errors | - error message list |
ids | - list of identifiers of deleted user templates |
void kerio::jsonapi::admin::ConnectCertificate::setActive |
( |
in kerio::web::KId |
id | ) |
|
Set active certificate
- Parameters
-
id | - ID of the new active certificate |
void kerio::jsonapi::admin::ConnectCertificate::toSource |
( |
out string |
source, |
|
|
in kerio::web::KId |
id |
|
) |
| |
Obtain source (plain-text representation) of the certificate
- Parameters
-
source | - certificate in plain text |
id | - global identifier |
The documentation for this interface was generated from the following file: