Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
InstallCert SOAP Command

Ask server to install the certificates

Network edition only API TRUE
Authorization token required true
Admin Authorization token required true

InstallCertRequest

    <InstallCertRequest server="{server-id}" type="..." [skipCleanup="{skipCleanup} (0|1)"]> ## InstallCertRequest
        <comm_cert> ## CommCert
            <cert [aid="{attachment-id}"] [filename="{filename}"] /> ## AidAndFilename
            <rootCA [aid="{attachment-id}"] [filename="{filename}"] /> ## See /comm_cert/cert [ ## AidAndFilename]
            (<intermediateCA [aid="{attachment-id}"] [filename="{filename}"] /> ## See /comm_cert/cert [ ## AidAndFilename])*
         </comm_cert>
        <validation_days>{validationDays} (String)</validation_days>
        <digest>{digest} (String)</digest>
        <subject> ## CSRSubject
            <C>{c} (String)</C>
            <ST>{st} (String)</ST>
            <L>{l} (String)</L>
            <O>{o} (String)</O>
            <OU>{ou} (String)</OU>
            <CN>{cn} (String)</CN>
         </subject>
        (<SubjectAltName>{subjectAltNames} (String)</SubjectAltName>)*
        <keysize>{keySize} (String)</keysize>
    </InstallCertRequest>

The following table describes elements and attributes you can define within a <InstallCertRequest> element:

XPath Required / Optional Description
@server Required (only 1) Type:String
Server ID
@type Required (only 1) Type:String
Certificate type
Could be "self" (self-signed cert) or "comm" (commerical cert)
@skipCleanup Optional (0 or 1) Type:0|1
Flag whether or not to delete temporary files. This should be used only for testing and troubleshooting.
/comm_cert Optional (0 or 1) Commercial certificate
/comm_cert/cert Optional (0 or 1) Certificate information
/comm_cert/cert@aid Optional (0 or 1) Type:String
Attachment ID
/comm_cert/cert@filename Optional (0 or 1) Type:String
Filename
/comm_cert/rootCA Optional (0 or 1) rootCA information
See /comm_cert/cert for more details.
/comm_cert/intermediateCA Optional (0 or more) intermediateCA information
See /comm_cert/cert for more details.
/validation_days Optional (0 or 1) Type:{validationDays} (String)
Validation days: required. Number of the validation days of the self signed certificate
/digest Optional (0 or 1) Type:{digest} (String)
digest. Default value: "SHA256"
/subject Optional (0 or 1) Subject
/subject/C Optional (0 or 1) Type:{c} (String)
C
/subject/ST Optional (0 or 1) Type:{st} (String)
ST
/subject/L Optional (0 or 1) Type:{l} (String)
L
/subject/O Optional (0 or 1) Type:{o} (String)
O
/subject/OU Optional (0 or 1) Type:{ou} (String)
OU
/subject/CN Optional (0 or 1) Type:{cn} (String)
CN
/SubjectAltName Optional (0 or more) Type:{subjectAltNames} (String)
subjectAltNames
/keysize Optional (0 or 1) Type:{keySize} (String)
Key length of the self-signed certificate. Default value: 2048. Minimum allowed value: 2048

InstallCertResponse

    <InstallCertResponse server="{server-name}" /> ## InstallCertResponse

The following table describes elements and attributes you can define within a <InstallCertResponse> element:

XPath Required / Optional Description
@server Required (only 1) Type:String
Server name