1. Oracle GoldenGate Microservices REST API
  2. Tasks
  3. Administrative Server
  4. Encryption Profiles

Retrieve Encryption Profile

get

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

Required Role: Any

Retrieve details for an Encryption Profile.

Request

Path Parameters
Back to Top

Response

Supported Media Types

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
Nested Schema : Oracle GoldenGate Encryption Profile definition-x-oneOf[0]
Type: object
Show Source
Nested Schema : Oracle GoldenGate Encryption Profile definition-x-oneOf[1]
Type: object
Show Source
  • Allowed Values: [ "ogg:encryptionProfile" ]
  • Minimum Length: 1
    Maximum Length: 256
    Description of the Encryption profile.
  • Default Value: false
    Is default profile.
  • 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.
  • 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
    Specify the masterkey options.
  • Minimum Length: 1
    Maximum Length: 4096
    Path where the Oracle Key Vault client software is installed.
  • Default Value: 18.1
    Allowed Values: [ "18.1", "21.4" ]
    Version of Oracle Key Vault
  • Allowed Values: [ "okv" ]
    Oracle Key Vault
Nested Schema : Oracle GoldenGate Encryption Profile definition-x-oneOf[2]
Type: object
Show Source
  • Allowed Values: [ "ogg:encryptionProfile" ]
  • Minimum Length: 1
    Maximum Length: 10240
    OCI API Signing Key
  • Default Value: 20180608
    Allowed Values: [ "20180608" ]
    Version of OCI KMS
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    Crypto endpoint of the OCI Key Management Service API.
  • Minimum Length: 1
    Maximum Length: 256
    Description of the Encryption profile.
  • Default Value: false
    Is default profile.
  • Minimum Length: 47
    Maximum Length: 47
    Hash (MD5) of the signing key.
  • Minimum Length: 1
    Maximum Length: 255
    Pattern: ocid1[.].*[.]oc[123]{1}[.].*[.].*
    Oracle Cloud ID
  • Minimum Length: 1
    Maximum Length: 255
    Pattern: ocid1[.].*[.]oc[123]{1}[.].*[.].*
    Oracle Cloud ID
  • Allowed Values: [ "ocikms" ]
    OCI Key Management Service
  • Minimum Length: 1
    Maximum Length: 255
    Pattern: ocid1[.].*[.]oc[123]{1}[.].*[.].*
    Oracle Cloud ID
Nested Schema : masterkey
Type: object
Specify the masterkey options.
Show Source
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