Replace Encryption Profile
patch
/services/{version}/encryption/profiles/{profile}
Required Role: Administrator
Modify an existing Encryption Profile.
Request
Supported Media Types
- application/json
Path Parameters
-
profile(required): string
Minimum Length:
1Maximum Length:64Pattern:^[A-Za-z0-9][A-Za-z0-9_:-]*$Name of the Encryption Profile.
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Oracle GoldenGate Encryption Profile definition
Title:
Oracle GoldenGate Encryption Profile definitionThis 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]
-
object Oracle GoldenGate Encryption Profile definition-x-oneOf[3]
Encryption profile using the Plugin Service
Nested Schema : Oracle GoldenGate Encryption Profile definition-x-oneOf[0]
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:encryptionProfile" ] -
description:
string
Minimum Length:
1Maximum Length:256Description of the Encryption profile. -
isDefault:
boolean
Default Value:
falseIs default profile. -
type:
Allowed Values:
[ "localWallet" ]OGG local wallet
Nested Schema : Oracle GoldenGate Encryption Profile definition-x-oneOf[1]
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:encryptionProfile" ] -
description:
string
Minimum Length:
1Maximum Length:256Description of the Encryption profile. -
isDefault:
boolean
Default Value:
falseIs default profile. -
keyNameAttribute:
string
Minimum Length:
1Maximum Length:255Default Value:x-OGG-KeyNamePattern:^x[-][a-zA-Z0-9-]*$Custom attribute used in Oracle Key Vault server to specify the masterkey name. -
keyVersionAttribute:
string
Minimum Length:
1Maximum Length:255Default Value:x-OGG-KeyVersionPattern:^x[-][a-zA-Z0-9-]*$Custom attribute used in Oracle Key Vault server to specify the masterkey version. -
masterkey:
object masterkey
Masterkey options.
-
okvPath:
string
Minimum Length:
1Maximum Length:4096Path where the Oracle Key Vault client software is installed. -
okvVersion:
Default Value:
18.1Allowed Values:[ "18.1", "21.4" ]Version of Oracle Key Vault -
type:
Allowed Values:
[ "okv" ]Oracle Key Vault
Nested Schema : Oracle GoldenGate Encryption Profile definition-x-oneOf[2]
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:encryptionProfile" ] -
apiSigningKey:
string
Minimum Length:
1Maximum Length:10240OCI API Signing Key -
apiVersion:
Default Value:
20180608Allowed Values:[ "20180608" ]Version of OCI KMS -
cryptoEndpoint:
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$Crypto endpoint of the OCI Key Management Service API. -
description:
string
Minimum Length:
1Maximum Length:256Description of the Encryption profile. -
isDefault:
boolean
Default Value:
falseIs default profile. -
keyFingerprint:
string
Minimum Length:
47Maximum Length:47Hash (MD5) of the signing key. -
keyID:
string
Minimum Length:
1Maximum Length:255Pattern:ocid1[.].*[.]oc[123]{1}[.].*[.].* -
tenancyID:
string
Minimum Length:
1Maximum Length:255Pattern:ocid1[.].*[.]oc[123]{1}[.].*[.].*Tenancy OCID -
type:
Allowed Values:
[ "ocikms" ]OCI Key Management Service -
userID:
string
Minimum Length:
1Maximum Length:255Pattern:ocid1[.].*[.]oc[123]{1}[.].*[.].*User OCID
Nested Schema : Oracle GoldenGate Encryption Profile definition-x-oneOf[3]
Type:
objectEncryption profile using the Plugin Service
Show Source
-
$schema:
Allowed Values:
[ "ogg:encryptionProfile" ] -
description:
string
Minimum Length:
1Maximum Length:256Description of the Encryption profile. -
isDefault:
boolean
Default Value:
falseIs default profile. -
metadata:
array metadata
Minimum Number of Items:
0Maximum Number of Items:255Metadata for the plugin API -
plugin:
string
Minimum Length:
1Maximum Length:255Oracle GoldenGate Plugin NameExample:libMinimal.so -
type:
Allowed Values:
[ "plugin" ]OGG Plugin
Nested Schema : masterkey
Type:
objectMasterkey options.
Show Source
-
name(required):
string
Minimum Length:
1Maximum Length:255 -
ttl:
integer
Minimum Value:
0Maximum Value:4294967295Default Value:86400 -
version:
string
Minimum Length:
1Maximum Length:255Default Value:LATEST
Nested Schema : metadata
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
255Metadata for the plugin API
Show Source
Nested Schema : items
Type:
Show Source
object-
name(required):
string
Minimum Length:
1Maximum Length:64Metadata name -
value(required):
string
Minimum Length:
1Maximum Length:4096Metadata value
Example Request (application/json)
{
"type":"okv",
"isDefault":true
}Response
Supported Media Types
- application/json
200 Response
Encryption Profile updated successfully.
Root Schema : RESTful API Standard Response
Type:
objectTitle:
RESTful API Standard ResponseStandard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema:
Allowed Values:
[ "api:standardResponse" ] -
links(required):
array links
Minimum Number of Items:
0Maximum Number of Items:16Oracle GoldenGate links for the request -
messages(required):
array messages
Minimum Number of Items:
0Maximum Number of Items:65535Oracle GoldenGate messages issued during the request -
response:
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
16Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
65535Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
objectOracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:link" ] -
description:
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType:
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel(required):
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:message" ] -
code(required):
string
Minimum Length:
9Maximum Length:9Pattern:^OGG[-][0-9]{5}$The Oracle GoldenGate message code -
issued(required):
string
Minimum Length:
20Maximum Length:32Pattern:^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$The date and time that the message was issued -
severity(required):
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]The severity of the message -
title(required):
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI [RFC3986] to a page that describes the info, warning or error type.
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:9012/services/v2/encryption/profiles/Default",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9012/services/v2/encryption/profiles/Default",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
]
}