data | Document. Data that you want to sign. The data 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 sign. | ||
stream | java.io.InputStream. Optional. The stream data that you want to sign. | ||
bytes | byte[ ]. Optional. The byte array that you want to sign. | ||
file | String. Optional. The absolute or relative path of the file that you want to sign. 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. | ||
secretKey | Document. The secret key required to sign the data. Provide either secretKeyBytes or secretKeyRingFile and secretKeyAlias. If both secretKeyBytes and secretKeyRingFile are provided, the service throws an exception. | ||
Key | Description | ||
secretKeyBytes | byte[ ]. Optional. The secret key file in bytes. Note: Secret key files have a .asc extension. | ||
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. | ||
signingAlgorithm | String. The signing algorithm to use. Select one of the following: MD5 SHA256 SHA384 SHA512 The default value is SHA256. Note: If the FIPS (Federal Information Processing Standards) mode is enabled, this service does not support the MD5 signing algorithm. FIPS mode can be enabled or disabled using the watt.security.fips.mode parameter. Note: If the secret key for signing the data is of the DSA (Digital Signature Algorithm) key type, this service does not support the MD5 signing algorithm. |
stream | java.io.OutputStream. Conditional. Signed data in the form of an output stream, when the stream input parameter is provided. | |
bytes | byte[ ]. Conditional. Signed data in bytes, when the bytes input parameter is provided. | |
status | String. Indicates whether the data is successfully signed or not. If successful, status is success. Otherwise, status contains failure along with an error message. |