Retrieve Encryption Profile
get
/services/{version}/encryption/profiles/{profile}
Retrieve details for an Encryption Profile.
Request
Path Parameters
-
profile: string
Minimum Length:
1
Maximum Length:64
Pattern:^[A-Za-z0-9][A-Za-z0-9_:-]*$
Name of the Encryption Profile.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
A description of the profile is retrieved.
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:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:encryptionProfile" ]
-
description(optional):
string
Minimum Length:
1
Maximum Length:256
Description of the Encryption profile. -
isDefault(optional):
boolean
Default Value:
false
Is default profile. -
type(optional):
Allowed Values:
[ "localWallet" ]
OGG local wallet
Nested Schema : Oracle GoldenGate Encryption Profile definition-x-oneOf[1]
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:encryptionProfile" ]
-
description(optional):
string
Minimum Length:
1
Maximum Length:256
Description of the Encryption profile. -
isDefault(optional):
boolean
Default Value:
false
Is default profile. -
keyNameAttribute(optional):
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(optional):
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(optional):
object masterkey
Specify the masterkey options.
-
okvPath(optional):
string
Minimum Length:
1
Maximum Length:4096
Path where the Oracle Key Vault client software is installed. -
okvVersion(optional):
Default Value:
18.1
Allowed Values:[ "18.1", "21.4" ]
Version of Oracle Key Vault -
type(optional):
Allowed Values:
[ "okv" ]
Oracle Key Vault
Nested Schema : Oracle GoldenGate Encryption Profile definition-x-oneOf[2]
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:encryptionProfile" ]
-
apiSigningKey(optional):
string
Minimum Length:
1
Maximum Length:10240
OCI API Signing Key -
apiVersion(optional):
Default Value:
20180608
Allowed Values:[ "20180608" ]
Version of OCI KMS -
cryptoEndpoint(optional):
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(optional):
string
Minimum Length:
1
Maximum Length:256
Description of the Encryption profile. -
isDefault(optional):
boolean
Default Value:
false
Is default profile. -
keyFingerprint(optional):
string
Minimum Length:
47
Maximum Length:47
Hash (MD5) of the signing key. -
keyID(optional):
string
Minimum Length:
1
Maximum Length:255
Pattern:ocid1[.].*[.]oc[123]{1}[.].*[.].*
Oracle Cloud ID -
tenancyID(optional):
string
Minimum Length:
1
Maximum Length:255
Pattern:ocid1[.].*[.]oc[123]{1}[.].*[.].*
Oracle Cloud ID -
type(optional):
Allowed Values:
[ "ocikms" ]
OCI Key Management Service -
userID(optional):
string
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
-
name:
string
Minimum Length:
1
Maximum Length:255
-
ttl(optional):
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Default Value:86400
-
version(optional):
string
Minimum Length:
1
Maximum Length:255
Default Value:LATEST
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"
}
}