Jump to

• Request
• Response

Retrieve Encryption Profile

get

/services/{version}/encryption/profiles/{profile}

Required Role: Any

Retrieve details for an Encryption Profile.

Request

Path Parameters

• profile(required): string
  Minimum Length: 1

  Maximum Length: 64

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

  Name of the Encryption Profile.

• version(required): string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

A description of the profile is retrieved.

Body ()

Root Schema : Oracle GoldenGate Encryption Profile definition

Type: object

Title: Oracle GoldenGate Encryption Profile definition

This schema describes the configuration and properties of data encryption in OGG

Match One

Show Source

• object Oracle GoldenGate Encryption Profile definition-x-oneOf[0]
• object Oracle GoldenGate Encryption Profile definition-x-oneOf[1]
• object Oracle GoldenGate Encryption Profile definition-x-oneOf[2]

{
    "x-oneOf":[
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:encryptionProfile"
                    ]
                },
                "type":{
                    "description":"OGG local wallet",
                    "enum":[
                        "localWallet"
                    ]
                },
                "isDefault":{
                    "description":"Is default profile.",
                    "type":"boolean",
                    "default":false
                },
                "description":{
                    "description":"Description of the Encryption profile.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"256"
                }
            },
            "additionalProperties":false
        },
        {
            "type":"object",
            "properties":{
                "okvPath":{
                    "description":"Path where the Oracle Key Vault client software is installed.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"4096"
                },
                "keyNameAttribute":{
                    "description":"Custom attribute used in Oracle Key Vault server to specify the masterkey name.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "pattern":"^x[-][a-zA-Z0-9-]*$",
                    "default":"x-OGG-KeyName"
                },
                "okvVersion":{
                    "description":"Version of Oracle Key Vault",
                    "enum":[
                        "18.1",
                        "21.4"
                    ],
                    "default":"18.1"
                },
                "$schema":{
                    "enum":[
                        "ogg:encryptionProfile"
                    ]
                },
                "masterkey":{
                    "description":"Specify the masterkey options.",
                    "type":"object",
                    "properties":{
                        "name":{
                            "type":"string",
                            "minLength":"1",
                            "maxLength":"255"
                        },
                        "version":{
                            "type":"string",
                            "minLength":"1",
                            "maxLength":"255",
                            "default":"LATEST"
                        },
                        "ttl":{
                            "type":"integer",
                            "minimum":"0",
                            "maximum":"4294967295",
                            "default":"86400"
                        }
                    },
                    "required":[
                        "name"
                    ],
                    "additionalProperties":false
                },
                "type":{
                    "description":"Oracle Key Vault",
                    "enum":[
                        "okv"
                    ]
                },
                "keyVersionAttribute":{
                    "description":"Custom attribute used in Oracle Key Vault server to specify the masterkey version.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "pattern":"^x[-][a-zA-Z0-9-]*$",
                    "default":"x-OGG-KeyVersion"
                },
                "isDefault":{
                    "description":"Is default profile.",
                    "type":"boolean",
                    "default":false
                },
                "description":{
                    "description":"Description of the Encryption profile.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"256"
                }
            },
            "additionalProperties":false
        },
        {
            "type":"object",
            "properties":{
                "apiSigningKey":{
                    "description":"OCI API Signing Key",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"10240"
                },
                "tenancyID":{
                    "description":"Oracle Cloud ID",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
                },
                "userID":{
                    "description":"Oracle Cloud ID",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
                },
                "$schema":{
                    "enum":[
                        "ogg:encryptionProfile"
                    ]
                },
                "cryptoEndpoint":{
                    "description":"Crypto endpoint of the OCI Key Management Service API.",
                    "type":"string",
                    "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                    "minLength":"2",
                    "maxLength":"4095"
                },
                "keyFingerprint":{
                    "description":"Hash (MD5) of the signing key.",
                    "type":"string",
                    "minLength":"47",
                    "maxLength":"47"
                },
                "keyID":{
                    "description":"Oracle Cloud ID",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
                },
                "type":{
                    "description":"OCI Key Management Service",
                    "enum":[
                        "ocikms"
                    ]
                },
                "isDefault":{
                    "description":"Is default profile.",
                    "type":"boolean",
                    "default":false
                },
                "apiVersion":{
                    "description":"Version of OCI KMS",
                    "enum":[
                        "20180608"
                    ],
                    "default":"20180608"
                },
                "description":{
                    "description":"Description of the Encryption profile.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"256"
                }
            },
            "additionalProperties":false
        }
    ],
    "title":"Oracle GoldenGate Encryption Profile definition",
    "description":"This schema describes the configuration and properties of data encryption in OGG",
    "type":"object"
}

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

Type: object

Show Source

• $schema:
  Allowed Values: [ "ogg:encryptionProfile" ]
• description: string
  Minimum Length: 1

  Maximum Length: 256

  Description of the Encryption profile.
• isDefault: boolean
  Default Value: false

  Is default profile.
• type:
  Allowed Values: [ "localWallet" ]

  OGG local wallet

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:encryptionProfile"
            ]
        },
        "type":{
            "description":"OGG local wallet",
            "enum":[
                "localWallet"
            ]
        },
        "isDefault":{
            "description":"Is default profile.",
            "type":"boolean",
            "default":false
        },
        "description":{
            "description":"Description of the Encryption profile.",
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        }
    },
    "additionalProperties":false
}

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

Type: object

Show Source

• $schema:
  Allowed Values: [ "ogg:encryptionProfile" ]
• description: string
  Minimum Length: 1

  Maximum Length: 256

  Description of the Encryption profile.
• isDefault: boolean
  Default Value: false

  Is default profile.
• keyNameAttribute: string
  Minimum Length: 1

  Maximum Length: 255

  Default Value: x-OGG-KeyName

  Pattern: ^x[-][a-zA-Z0-9-]*$

  Custom attribute used in Oracle Key Vault server to specify the masterkey name.
• keyVersionAttribute: string
  Minimum Length: 1

  Maximum Length: 255

  Default Value: x-OGG-KeyVersion

  Pattern: ^x[-][a-zA-Z0-9-]*$

  Custom attribute used in Oracle Key Vault server to specify the masterkey version.
• masterkey: object masterkey
  Specify the masterkey options.
• okvPath: string
  Minimum Length: 1

  Maximum Length: 4096

  Path where the Oracle Key Vault client software is installed.
• okvVersion:
  Default Value: 18.1

  Allowed Values: [ "18.1", "21.4" ]

  Version of Oracle Key Vault
• type:
  Allowed Values: [ "okv" ]

  Oracle Key Vault

{
    "type":"object",
    "properties":{
        "okvPath":{
            "description":"Path where the Oracle Key Vault client software is installed.",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "keyNameAttribute":{
            "description":"Custom attribute used in Oracle Key Vault server to specify the masterkey name.",
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "pattern":"^x[-][a-zA-Z0-9-]*$",
            "default":"x-OGG-KeyName"
        },
        "okvVersion":{
            "description":"Version of Oracle Key Vault",
            "enum":[
                "18.1",
                "21.4"
            ],
            "default":"18.1"
        },
        "$schema":{
            "enum":[
                "ogg:encryptionProfile"
            ]
        },
        "masterkey":{
            "description":"Specify the masterkey options.",
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255"
                },
                "version":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "default":"LATEST"
                },
                "ttl":{
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"4294967295",
                    "default":"86400"
                }
            },
            "required":[
                "name"
            ],
            "additionalProperties":false
        },
        "type":{
            "description":"Oracle Key Vault",
            "enum":[
                "okv"
            ]
        },
        "keyVersionAttribute":{
            "description":"Custom attribute used in Oracle Key Vault server to specify the masterkey version.",
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "pattern":"^x[-][a-zA-Z0-9-]*$",
            "default":"x-OGG-KeyVersion"
        },
        "isDefault":{
            "description":"Is default profile.",
            "type":"boolean",
            "default":false
        },
        "description":{
            "description":"Description of the Encryption profile.",
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        }
    },
    "additionalProperties":false
}

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

Type: object

Show Source

• $schema:
  Allowed Values: [ "ogg:encryptionProfile" ]
• apiSigningKey: string
  Minimum Length: 1

  Maximum Length: 10240

  OCI API Signing Key
• apiVersion:
  Default Value: 20180608

  Allowed Values: [ "20180608" ]

  Version of OCI KMS
• cryptoEndpoint: string
  Minimum Length: 2

  Maximum Length: 4095

  Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$

  Crypto endpoint of the OCI Key Management Service API.
• description: string
  Minimum Length: 1

  Maximum Length: 256

  Description of the Encryption profile.
• isDefault: boolean
  Default Value: false

  Is default profile.
• keyFingerprint: string
  Minimum Length: 47

  Maximum Length: 47

  Hash (MD5) of the signing key.
• keyID: string
  Minimum Length: 1

  Maximum Length: 255

  Pattern: ocid1[.].*[.]oc[123]{1}[.].*[.].*

  Oracle Cloud ID
• tenancyID: string
  Minimum Length: 1

  Maximum Length: 255

  Pattern: ocid1[.].*[.]oc[123]{1}[.].*[.].*

  Oracle Cloud ID
• type:
  Allowed Values: [ "ocikms" ]

  OCI Key Management Service
• userID: string
  Minimum Length: 1

  Maximum Length: 255

  Pattern: ocid1[.].*[.]oc[123]{1}[.].*[.].*

  Oracle Cloud ID

{
    "type":"object",
    "properties":{
        "apiSigningKey":{
            "description":"OCI API Signing Key",
            "type":"string",
            "minLength":"1",
            "maxLength":"10240"
        },
        "tenancyID":{
            "description":"Oracle Cloud ID",
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
        },
        "userID":{
            "description":"Oracle Cloud ID",
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
        },
        "$schema":{
            "enum":[
                "ogg:encryptionProfile"
            ]
        },
        "cryptoEndpoint":{
            "description":"Crypto endpoint of the OCI Key Management Service API.",
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
            "minLength":"2",
            "maxLength":"4095"
        },
        "keyFingerprint":{
            "description":"Hash (MD5) of the signing key.",
            "type":"string",
            "minLength":"47",
            "maxLength":"47"
        },
        "keyID":{
            "description":"Oracle Cloud ID",
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
        },
        "type":{
            "description":"OCI Key Management Service",
            "enum":[
                "ocikms"
            ]
        },
        "isDefault":{
            "description":"Is default profile.",
            "type":"boolean",
            "default":false
        },
        "apiVersion":{
            "description":"Version of OCI KMS",
            "enum":[
                "20180608"
            ],
            "default":"20180608"
        },
        "description":{
            "description":"Description of the Encryption profile.",
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        }
    },
    "additionalProperties":false
}

Nested Schema : masterkey

Type: object

Specify the masterkey options.

Show Source

• name(required): string
  Minimum Length: 1

  Maximum Length: 255
• ttl: integer
  Minimum Value: 0

  Maximum Value: 4294967295

  Default Value: 86400
• version: string
  Minimum Length: 1

  Maximum Length: 255

  Default Value: LATEST

{
    "description":"Specify the masterkey options.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        },
        "version":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "default":"LATEST"
        },
        "ttl":{
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295",
            "default":"86400"
        }
    },
    "required":[
        "name"
    ],
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/encryption/profiles/Default",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/encryption/profiles/Default",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/profile",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:encryptionProfile",
        "isDefault":true,
        "keyNameAttribute":"x-OGG-KeyName",
        "keyVersionAttribute":"x-OGG-KeyVersion",
        "masterkey":{
            "name":"OGGMK2",
            "ttl":"86400",
            "version":"LATEST"
        },
        "okvPath":"/tmp/okvSample",
        "okvVersion":"18.1",
        "type":"okv"
    }
}

Back to Top