data | Document. The data that you want to decrypt must be in one of the following formats. If multiple input parameters are supplied for data, the service throws an exception stating that only one parameter must be passed. | ||
Key | Description | ||
string | String. Optional. The string that you want to decrypt. | ||
stream | java.io.InputStream. Optional. The stream data that you want to decrypt. | ||
bytes | byte[ ]. Optional. The byte array that you want to decrypt. | ||
file | String. Optional. The absolute or relative path of the file that you want to decrypt. If the file is outside the Integration Server or Microservices Runtime installation directory, provide the absolute path. Otherwise, place the file in your Integration Server or Microservices Runtime working directory. The About page in Integration Server Administrator and Microservices Runtime Administrator displays the working directory. The watt.server.homeDir server configuration parameter also specifies the working directory. | ||
loadAs | String. Optional. The format in which the service returns the output. Set to: bytes to return the output as a byte array. This is the default. stream to return the output as a stream object. string to return the output as a string. | ||
secretKey | Document. The secret key to extract the private key required to decrypt the data. Provide secretKeyBytes, secretKeyString, or secretKeyRingFile. If you provide secretKeyRingFile, you must also provide secretKeyAlias. Otherwise, the service throws an exception. | ||
Key | Description | ||
secretKeyBytes | byte[ ]. Optional. The secret key file in bytes. Note: Secret key files have a .asc extension. | ||
secretKeyString | String. Optional. The secret key as a string. | ||
secretKeyRingFile | String. Optional. The absolute or relative path of the secret keyring file. The secret keyring file is a collection of secret keys with a unique key ID. If the file is outside the Integration Server or Microservices Runtime installation directory, provide the absolute path. Otherwise, place the file in your Integration Server or Microservices Runtime working directory. The About page in Integration Server Administrator and Microservices Runtime Administrator displays the working directory. The watt.server.homeDir server configuration parameter also specifies the working directory. Note: Secret keyring files have a .skr extension. | ||
secretKeyAlias | String. Optional. The 64 bit (16 characters) key identifier of the secret key. Note: This parameter is required only when you use secretKeyRingFile. | ||
secretKey Passphrase | String. Password required to extract the private key from the secret key. This is the password provided while generating the secret key. |
stream | java.io.OutputStream. Conditional. Decrypted data as an output stream. Returned when the loadAs input parameter is set to stream. | |
bytes | byte[ ]. Conditional. Decrypted data as bytes. Returned when the loadAs input parameter is set to bytes. | |
string | String. Conditional. Decrypted data as a string. Returned when the loadAs input parameter is set to string. | |
status | String. Indicates whether the data is successfully decrypted or not. If successful, status is success. Otherwise, status contains failure along with an error message. |