Authorization token required | UNKNOWN |
Admin Authorization token required | UNKNOWN |
<SaveSmimeCertificateRequest [password="{smime-certificate-password}"] [replaceId="{smime-certificate-replaceId}"]> ## SaveSmimeCertificateRequest
<upload [id="..."] /> ## Id
</SaveSmimeCertificateRequest>
elements and attributes you can define within a
<SaveSmimeCertificateRequest>
element:
XPath | Required / Optional | Description |
@password | Optional (0 or 1) | Type: String password for smime certificate |
@replaceId | Optional (0 or 1) | Type: String Id of the certificate to be replaced |
/upload | Required (only 1) | Upload specification |
/upload@id | Optional (0 or 1) | Type: String ID |
<SaveSmimeCertificateResponse> ## SaveSmimeCertificateResponse
<certificate pubCertId="{pubCertId}" pvtKeyId="{pvtKeyId}" [default="{defaultCert} (0|1)"]> ## CertificateInfo
<errorCode>{errorCode} (String)</errorCode>
<emailAddress>{emailAddr} (String)</emailAddress>
<issuedTo> ## CertificateDN
<emailAddress>{email} (String)</emailAddress>
<c>{country} (String)</c>
<st>{state} (String)</st>
<l>{city} (String)</l>
<o>{org} (String)</o>
<ou>{orgunit} (String)</ou>
<cn>{commonName} (String)</cn>
</issuedTo>
<issuedBy> ... </issuedBy> ## See /certificate/issuedTo [ ## CertificateDN]
<validity> ## CertificateValidity
<startDate>{startDate} (long)</startDate>
<endDate>{endDate} (long)</endDate>
</validity>
<signature> ## CertificateSignature
<serialNo>{serialNumber} (String)</serialNo>
<algorithm>{algorithm} (String)</algorithm>
</signature>
<subjectAltName> ## CertificateAltNames
(<otherName>{otherName} (String)</otherName>)*
(<rfc822Name>{rfc822Name} (String)</rfc822Name>)*
(<dNSName>{dNSName} (String)</dNSName>)*
(<x400Address>{x400Address} (String)</x400Address>)*
(<directoryName>{directoryName} (String)</directoryName>)*
(<ediPartyName>{ediPartyName} (String)</ediPartyName>)*
(<uniformResourceIdentifier>{uniformResourceIdentifier} (String)</uniformResourceIdentifier>)*
(<iPAddress>{iPAddress} (String)</iPAddress>)*
(<registeredID>{registeredID} (String)</registeredID>)*
</subjectAltName>
<issuerAltName> ... </issuerAltName> ## See /certificate/subjectAltName [ ## CertificateAltNames]
</certificate>
</SaveSmimeCertificateResponse>
elements and attributes you can define within a
<SaveSmimeCertificateResponse>
element:
XPath | Required / Optional | Description |
/certificate | Optional (0 or 1) | details of certificate saved |
/certificate@pubCertId | Required (only 1) | Type: String Item Id associated with the public certificate |
/certificate@pvtKeyId | Required (only 1) | Type: String Item Id associated with the private key |
/certificate@default | Optional (0 or 1) | Type: 0|1 Is this certificate the default one, in case user has multiple certificates |
/certificate/errorCode | Optional (0 or 1) | Type: {errorCode} (String) error code |
/certificate/emailAddress | Required (only 1) | Type: {emailAddr} (String) email address of the subject (The person, or entity identified.) |
/certificate/issuedTo | Required (only 1) | details of the subject (The person, or entity identified.) |
/certificate/issuedTo/emailAddress | Optional (0 or 1) | Type: {email} (String) email address of subject or issuer. |
/certificate/issuedTo/c | Optional (0 or 1) | Type: {country} (String) country of subject or issuer. |
/certificate/issuedTo/st | Optional (0 or 1) | Type: {state} (String) state of subject or issuer. |
/certificate/issuedTo/l | Optional (0 or 1) | Type: {city} (String) city of subject or issuer. |
/certificate/issuedTo/o | Optional (0 or 1) | Type: {org} (String) organization of subject or issuer. |
/certificate/issuedTo/ou | Optional (0 or 1) | Type: {orgunit} (String) organizational unit of subject or issuer. |
/certificate/issuedTo/cn | Optional (0 or 1) | Type: {commonName} (String) common name of subject or issuer. |
/certificate/issuedBy | Optional (0 or 1) | details of the issuer (who has issued the certificate)
See /certificate/issuedTo for more details. |
/certificate/validity | Optional (0 or 1) | validity of the certificate |
/certificate/validity/startDate | Optional (0 or 1) | Type: {startDate} (long) The date from which certificate validity starts.Value is number of milliseconds since epoch. |
/certificate/validity/endDate | Optional (0 or 1) | Type: {endDate} (long) The expiration date.Value is number of milliseconds since epoch. |
/certificate/signature | Optional (0 or 1) | signature details of the certificate |
/certificate/signature/serialNo | Optional (0 or 1) | Type: {serialNumber} (String) serialNumber of the certificate, which is used to uniquely identify the certificate. |
/certificate/signature/algorithm | Optional (0 or 1) | Type: {algorithm} (String) algorithm used to create the signature. |
/certificate/subjectAltName | Optional (0 or 1) | subjectAltName details of the certificate |
/certificate/subjectAltName/otherName | Optional (0 or more) | Type: {otherName} (String) otherName of subject or issuer. |
/certificate/subjectAltName/rfc822Name | Optional (0 or more) | Type: {rfc822Name} (String) rfc822Name of subject or issuer. |
/certificate/subjectAltName/dNSName | Optional (0 or more) | Type: {dNSName} (String) dNSName of subject or issuer. |
/certificate/subjectAltName/x400Address | Optional (0 or more) | Type: {x400Address} (String) x400Address of subject or issuer. |
/certificate/subjectAltName/directoryName | Optional (0 or more) | Type: {directoryName} (String) directoryName of subject or issuer. |
/certificate/subjectAltName/ediPartyName | Optional (0 or more) | Type: {ediPartyName} (String) ediPartyName of subject or issuer. |
/certificate/subjectAltName/uniformResourceIdentifier | Optional (0 or more) | Type: {uniformResourceIdentifier} (String) uniformResourceIdentifier of subject or issuer. |
/certificate/subjectAltName/iPAddress | Optional (0 or more) | Type: {iPAddress} (String) iPAddress of subject or issuer. |
/certificate/subjectAltName/registeredID | Optional (0 or more) | Type: {registeredID} (String) registeredID of subject or issuer. |
/certificate/issuerAltName | Optional (0 or 1) | issuerAltName details of the certificate
See /certificate/subjectAltName for more details. |