Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve Encryption Key

get

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

Required Role: User

Retrieve details for an Encryption Key.

Request

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" ]

Response

Supported Media Types

application/json

200 Response

Encryption Key details retrieved.

Root Schema : Oracle GoldenGate Encryption Key

Title: Oracle GoldenGate Encryption Key

This schema describes an encryption key, used to encrypt data

Match One

Show Source

object Oracle GoldenGate Encryption Key-x-oneOf[0]

128-bit encryption key
object Oracle GoldenGate Encryption Key-x-oneOf[1]

192-bit encryption key
object Oracle GoldenGate Encryption Key-x-oneOf[2]

256-bit encryption key

{
    "x-oneOf":[
        {
            "description":"128-bit encryption key",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:encryptKey"
                    ]
                },
                "bitLength":{
                    "description":"Length of the encryption key, in bits",
                    "enum":[
                        "128"
                    ]
                },
                "keyValue":{
                    "description":"An optional encryption key value. If not provided, one will be generated.",
                    "type":"string",
                    "pattern":"0x[A-Fa-f0-9]{32}",
                    "minLength":"34",
                    "maxLength":"34"
                }
            },
            "required":[
                "bitLength"
            ],
            "additionalProperties":false
        },
        {
            "description":"192-bit encryption key",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:encryptKey"
                    ]
                },
                "bitLength":{
                    "description":"Length of the encryption key, in bits",
                    "enum":[
                        "192"
                    ]
                },
                "keyValue":{
                    "description":"An optional encryption key value. If not provided, one will be generated.",
                    "type":"string",
                    "pattern":"0x[A-Fa-f0-9]{48}",
                    "minLength":"50",
                    "maxLength":"50"
                }
            },
            "required":[
                "bitLength"
            ],
            "additionalProperties":false
        },
        {
            "description":"256-bit encryption key",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:encryptKey"
                    ]
                },
                "bitLength":{
                    "description":"Length of the encryption key, in bits",
                    "enum":[
                        "256"
                    ]
                },
                "keyValue":{
                    "description":"An optional encryption key value. If not provided, one will be generated.",
                    "type":"string",
                    "pattern":"0x[A-Fa-f0-9]{64}",
                    "minLength":"66",
                    "maxLength":"66"
                }
            },
            "required":[
                "bitLength"
            ],
            "additionalProperties":false
        }
    ],
    "title":"Oracle GoldenGate Encryption Key",
    "description":"This schema describes an encryption key, used to encrypt data"
}

Nested Schema : Oracle GoldenGate Encryption Key-x-oneOf[0]

Type: object

128-bit encryption key

Show Source

$schema:

Allowed Values: [ "ogg:encryptKey" ]
bitLength(required):

Allowed Values: [ "128" ]

Length of the encryption key, in bits
keyValue: string

Minimum Length: 34

Maximum Length: 34

Pattern: 0x[A-Fa-f0-9]{32}

An optional encryption key value. If not provided, one will be generated.

{
    "description":"128-bit encryption key",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:encryptKey"
            ]
        },
        "bitLength":{
            "description":"Length of the encryption key, in bits",
            "enum":[
                "128"
            ]
        },
        "keyValue":{
            "description":"An optional encryption key value. If not provided, one will be generated.",
            "type":"string",
            "pattern":"0x[A-Fa-f0-9]{32}",
            "minLength":"34",
            "maxLength":"34"
        }
    },
    "required":[
        "bitLength"
    ],
    "additionalProperties":false
}

Nested Schema : Oracle GoldenGate Encryption Key-x-oneOf[1]

Type: object

192-bit encryption key

Show Source

$schema:

Allowed Values: [ "ogg:encryptKey" ]
bitLength(required):

Allowed Values: [ "192" ]

Length of the encryption key, in bits
keyValue: string

Minimum Length: 50

Maximum Length: 50

Pattern: 0x[A-Fa-f0-9]{48}

An optional encryption key value. If not provided, one will be generated.

{
    "description":"192-bit encryption key",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:encryptKey"
            ]
        },
        "bitLength":{
            "description":"Length of the encryption key, in bits",
            "enum":[
                "192"
            ]
        },
        "keyValue":{
            "description":"An optional encryption key value. If not provided, one will be generated.",
            "type":"string",
            "pattern":"0x[A-Fa-f0-9]{48}",
            "minLength":"50",
            "maxLength":"50"
        }
    },
    "required":[
        "bitLength"
    ],
    "additionalProperties":false
}

Nested Schema : Oracle GoldenGate Encryption Key-x-oneOf[2]

Type: object

256-bit encryption key

Show Source

$schema:

Allowed Values: [ "ogg:encryptKey" ]
bitLength(required):

Allowed Values: [ "256" ]

Length of the encryption key, in bits
keyValue: string

Minimum Length: 66

Maximum Length: 66

Pattern: 0x[A-Fa-f0-9]{64}

An optional encryption key value. If not provided, one will be generated.

{
    "description":"256-bit encryption key",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:encryptKey"
            ]
        },
        "bitLength":{
            "description":"Length of the encryption key, in bits",
            "enum":[
                "256"
            ]
        },
        "keyValue":{
            "description":"An optional encryption key value. If not provided, one will be generated.",
            "type":"string",
            "pattern":"0x[A-Fa-f0-9]{64}",
            "minLength":"66",
            "maxLength":"66"
        }
    },
    "required":[
        "bitLength"
    ],
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/enckeys/superkey",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/enckeys/superkey",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/keyName",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:encryptKey",
        "bitLength":"128"
    }
}