wm.tn.security:addCertificateData
Adds a signing, decryption, or SSL client certificate to the Trading Networks database.
Input Parameters
ownerID | String The internal partner ID of the owner of the certificate. |
partnerID | String (optional) The internal partner ID of the certificate owner’s partner. See the Usage Notes at the end of this service’s description for information about how the certificate data is used if partnerID is not specified. |
usage | String Specify one of the following values: sign - The certificate is used as a signing certificate for the owner to send digitally signed documents to the partner. decrypt - The certificate is used as an encrypt certificate for the owner to send encrypted documents to the partner. ssl - The certificate is used as a client SSL certificate for the owner to establish an SSL connection to the partner's secure server. |
chainBytes | Object (optional) An array of byte arrays. Each byte array should represent a java.security.cert.X509Certificate. The certificates should be in node-to-root order. The first certificate in the array should be the signing, decryption, or SSL client certificate. Each subsequent certificate should be the certificate that was used to sign the previous certificate in the array. |
keyBytes | Object (optional) A byte array that represents the private key that is used to generate the certificate. Note: | If you are adding certificate data for your Enterprise profile, specify the private key using keyAliasName, not keyBytes. |
|
keyStoreAliasName | String (optional) Alias for the keystore file associated with the certificate. Note: | Keystores apply only to Enterprise profiles. If you are adding certificate data for your Enterprise profile, supply a value for this parameter. If you are adding certificate data for a partner profile, leave this parameter blank. |
|
keyAliasName | String (optional) Configured private key alias in the specified keystore. Note: | Key aliases apply only to Enterprise profiles. If you are adding certificate data for a partner profile, specify the private key using keyBytes, not keyAliasName. |
|
Output Parameters
certID | String The internal ID that uniquely identifies the certificate data that is added. |
addCount | String Whether the certificate data is successfully inserted into the Trading Networks database. The value 1 indicates success. A null value indicates failure. |
Usage Notes
![*](bullet.gif)
If both
ownerID and
partnerID are specified, the certificate data is used for the purpose you specify in
usage. If
partnerID is not specified (or no specific alternative certificate data is defined by the owner and the specified partner for the purpose you specify in
usage), the certificate data is used as a default certificate set for the owner and all of the owner’s partners.