B2B Integration 10.4 | Administering and Monitoring B2B Transactions | Trading Networks Built-In Services Reference | Security Folder | Summary of Elements in this Folder | wm.tn.security:updateCertificateData
 
wm.tn.security:updateCertificateData
Updates certificate data based on certificate ID or owner, partner, and usage combination.
Input Parameters
certID
String (optional) The internal ID that uniquely identifies the certificate data to be updated.
See the Usage Notes at the end of this service’s description for information about the relationship between the certID, ownerID, partnerID, and usage parameters.
ownerID
String (optional) The internal partner ID of the owner of the certificates.
See the Usage Notes at the end of this service’s description for information about the relationship between the certID, ownerID, partnerID, and usage parameters.
partnerID
String (optional) The internal partner ID of the partner with whom the certificate owner does business using the certificates for the specific usage. See the Usage Notes at the end of this service’s description for information about how the updated certificate data is used if partnerID is not specified.
See the Usage Notes at the end of this service’s description for information about the relationship between the certID, ownerID, partnerID, and usage parameters.
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.
See the Usage Notes at the end of this service’s description for information about the relationship between the certID, ownerID, partnerID, and usage parameters.
chainBytes
Object An array of byte arrays. Each byte array should represent a java.security.cert.X509Certificate. The certificate should be in node-to-root order. The first certificate in the array should be the sign/decrypt/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 updating certificate data for your Enterprise profile, specify the private key using keyAliasName, not keyBytes.
keyStoreAliasName
String (optional) Alias for the keystore containing the certificate to be updated.
Note: Keystores apply only to Enterprise profiles. If you are updating certificate data for your Enterprise profile, supply a value for this parameter. If you are updating certificate data for a partner profile, leave this parameter blank.
keyAliasName
String (optional) Alias for the private key used to access this certificate in the specified keystore.
Note: Key aliases apply only to Enterprise profiles. If you are updating 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 updated.
updateCount
String Whether to show how many rows were successfully updated in the Trading Networks database. The value 1 indicates to show the number of rows.
Usage Notes
*This service is only used for updating certificate data. If no certificate data exists for the specified ownerID/partnerID/usage, use wm.tn.security:addCertificateData.
*If certID is specified, ownerID, partnerID, and usage are ignored. If certID is not specified, you must specify ownerID, partnerID, and usage.
*If both ownerID and partnerID are specified, the updated 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 updated certificate data is used as a default certificate set for the owner and all of the owner’s partners.
Copyright © 2016- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release