Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Encrypt Data

post

/services/{version}/enckeys/{keyName}/encrypt

Required Role: User

Encrypt data using the Encryption Key.

Request

Supported Media Types

application/json

Path Parameters

keyName(required): string

Minimum Length: 1

Maximum Length: 24

Pattern: ^[A-Za-z_$][A-Za-z0-9_$]*$

The name of the Encryption Key.
version(required): 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:

Allowed Values: [ "ogg:encryptRequest" ]
data(required): string

Minimum Length: 1

Maximum Length: 4096

Data to be encrypted
encoding:

Default Value: legacy

Allowed Values: [ "legacy" ]

Encoding to use for encrypted data in response

{
    "title":"Oracle GoldenGate Encryption Request",
    "description":"This schema describes data to be AES encrypted",
    "required":[
        "data"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:encryptRequest"
            ]
        },
        "encoding":{
            "description":"Encoding to use for encrypted data in response",
            "enum":[
                "legacy"
            ],
            "default":"legacy"
        },
        "data":{
            "description":"Data to be encrypted",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        }
    },
    "additionalProperties":false
}

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:

Allowed Values: [ "ogg:encryptResult" ]
encrypted(required): string

Minimum Length: 0

Maximum Length: 8192

Encrypted data

{
    "title":"Oracle GoldenGate Encryption Result",
    "description":"This schema describes encrypted data",
    "required":[
        "encrypted"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:encryptResult"
            ]
        },
        "encrypted":{
            "description":"Encrypted data",
            "type":"string",
            "minLength":"0",
            "maxLength":"8192"
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/enckeys/superkey/encrypt",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/enckeys/superkey/encrypt",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:encryptResult",
        "encrypted":"AADAAAAAAAAAAASAVITDVJPCCFXBWGZGEDDFDFFCGICBUJTITEZBEBRIUJFBRBEDDCQHIBJAEGBAAGNDAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
    }
}