Create Encryption Profile
post
/services/{version}/encryption/profiles/{profile}
Create an Encryption Profile.
Request
Supported Media Types
- application/json
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" ]
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 Request (application/json)
{
"$schema":"ogg:encryptionProfile",
"type":"okv",
"okvVersion":"18.1",
"okvPath":"/tmp/okvSample",
"keyNameAttribute":"x-OGG-KeyName",
"keyVersionAttribute":"x-OGG-KeyVersion",
"masterkey":{
"name":"OGGMK2",
"version":"LATEST",
"ttl":86400
}
}
Response
Supported Media Types
- application/json
201 Response
Encryption Profile created successfully.
Root Schema : RESTful API Standard Response
Type:
object
Title:
RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema(optional):
Allowed Values:
[ "api:standardResponse" ]
-
links:
array links
Minimum Number of Items:
0
Maximum Number of Items:16
Oracle GoldenGate links for the request -
messages:
array messages
Minimum Number of Items:
0
Maximum Number of Items:65535
Oracle GoldenGate messages issued during the request -
response(optional):
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
16
Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
object
Oracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:link" ]
-
description(optional):
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this link. -
href:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI for the link -
mediaType(optional):
string
Minimum Length:
6
Maximum Length:255
Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$
Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel:
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]
Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:message" ]
-
code:
string
Minimum Length:
9
Maximum Length:9
Pattern:^OGG[-][0-9]{5}$
The Oracle GoldenGate message code -
issued:
string
Minimum Length:
20
Maximum Length:32
Pattern:^[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:
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]
The severity of the message -
title:
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[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: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"
}
],
"messages":[
]
}