Encrypt Data
post
/services/{version}/enckeys/{keyName}/encrypt
Encrypt data using the Encryption Key.
Request
Supported Media Types
- application/json
Path Parameters
-
keyName: string
Minimum Length:
1
Maximum Length:24
Pattern:^[A-Za-z_$][A-Za-z0-9_$]*$
The name of the Encryption Key.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Oracle GoldenGate Encryption Request
Type:
object
Title:
Oracle GoldenGate Encryption Request
This schema describes data to be AES encrypted
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:encryptRequest" ]
-
data:
string
Minimum Length:
1
Maximum Length:4096
Data to be encrypted -
encoding(optional):
Default Value:
legacy
Allowed Values:[ "legacy" ]
Encoding to use for encrypted data in response
Example Request (application/json)
{
"data":"plaintext-password"
}
Response
Supported Media Types
- application/json
200 Response
Data encrypted successfully.
Root Schema : Oracle GoldenGate Encryption Result
Type:
object
Title:
Oracle GoldenGate Encryption Result
This schema describes encrypted data
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:encryptResult" ]
-
encrypted:
string
Minimum Length:
0
Maximum Length:8192
Encrypted data
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/enckeys/superkey/encrypt",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/enckeys/superkey/encrypt",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
],
"response":{
"$schema":"ogg:encryptResult",
"encrypted":"AADAAAAAAAAAAASAJGJBAHIAAIDIOCVHQDHJJDPAKHEFUFSIZCMFYCUBWBFBEGKGQIPGMFBJMDTABDXGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}
}