oci-keymanagement 2.76.1 → 2.77.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/client.d.ts +46 -46
- package/lib/client.js +46 -46
- package/lib/model/create-ekms-private-endpoint-details.d.ts +2 -2
- package/lib/model/create-key-details.d.ts +8 -8
- package/lib/model/create-vault-details.d.ts +2 -2
- package/lib/model/decrypt-data-details.d.ts +3 -3
- package/lib/model/decrypted-data.d.ts +3 -3
- package/lib/model/ekms-private-endpoint-summary.d.ts +2 -2
- package/lib/model/ekms-private-endpoint.d.ts +2 -2
- package/lib/model/encrypt-data-details.d.ts +3 -3
- package/lib/model/encrypted-data.d.ts +3 -3
- package/lib/model/export-key-details.d.ts +2 -2
- package/lib/model/generated-key.d.ts +2 -2
- package/lib/model/import-key-details.d.ts +6 -6
- package/lib/model/import-key-version-details.d.ts +2 -2
- package/lib/model/key-shape.d.ts +1 -1
- package/lib/model/key-summary.d.ts +10 -10
- package/lib/model/key-version-summary.d.ts +3 -3
- package/lib/model/key-version.d.ts +4 -4
- package/lib/model/key.d.ts +12 -12
- package/lib/model/sign-data-details.d.ts +1 -1
- package/lib/model/update-ekms-private-endpoint-details.d.ts +2 -2
- package/lib/model/update-key-details.d.ts +2 -2
- package/lib/model/update-vault-details.d.ts +2 -2
- package/lib/model/vault-summary.d.ts +4 -4
- package/lib/model/vault-usage.d.ts +4 -4
- package/lib/model/vault.d.ts +5 -5
- package/lib/model/verify-data-details.d.ts +1 -1
- package/lib/model/wrapped-import-key.d.ts +2 -2
- package/lib/model/wrapping-key.d.ts +2 -2
- package/lib/request/backup-key-request.d.ts +2 -2
- package/lib/request/backup-vault-request.d.ts +2 -2
- package/lib/request/cancel-key-deletion-request.d.ts +2 -2
- package/lib/request/cancel-key-version-deletion-request.d.ts +2 -2
- package/lib/request/cancel-vault-deletion-request.d.ts +2 -2
- package/lib/request/change-key-compartment-request.d.ts +2 -2
- package/lib/request/change-vault-compartment-request.d.ts +2 -2
- package/lib/request/create-ekms-private-endpoint-request.d.ts +1 -1
- package/lib/request/create-key-request.d.ts +1 -1
- package/lib/request/create-key-version-request.d.ts +1 -1
- package/lib/request/create-vault-replica-request.d.ts +2 -2
- package/lib/request/create-vault-request.d.ts +1 -1
- package/lib/request/decrypt-request.d.ts +1 -1
- package/lib/request/delete-ekms-private-endpoint-request.d.ts +2 -2
- package/lib/request/delete-vault-replica-request.d.ts +2 -2
- package/lib/request/disable-key-request.d.ts +2 -2
- package/lib/request/enable-key-request.d.ts +2 -2
- package/lib/request/encrypt-request.d.ts +1 -1
- package/lib/request/export-key-request.d.ts +1 -1
- package/lib/request/generate-data-encryption-key-request.d.ts +1 -1
- package/lib/request/get-ekms-private-endpoint-request.d.ts +1 -1
- package/lib/request/get-key-request.d.ts +1 -1
- package/lib/request/get-key-version-request.d.ts +1 -1
- package/lib/request/get-replication-status-request.d.ts +1 -1
- package/lib/request/get-vault-request.d.ts +1 -1
- package/lib/request/get-vault-usage-request.d.ts +1 -1
- package/lib/request/get-wrapping-key-request.d.ts +1 -1
- package/lib/request/import-key-request.d.ts +1 -1
- package/lib/request/import-key-version-request.d.ts +1 -1
- package/lib/request/list-ekms-private-endpoints-request.d.ts +4 -4
- package/lib/request/list-key-versions-request.d.ts +4 -4
- package/lib/request/list-keys-request.d.ts +9 -9
- package/lib/request/list-vault-replicas-request.d.ts +5 -5
- package/lib/request/list-vaults-request.d.ts +4 -4
- package/lib/request/restore-key-from-file-request.d.ts +2 -2
- package/lib/request/restore-key-from-object-store-request.d.ts +2 -2
- package/lib/request/restore-vault-from-file-request.d.ts +2 -2
- package/lib/request/restore-vault-from-object-store-request.d.ts +2 -2
- package/lib/request/schedule-key-deletion-request.d.ts +2 -2
- package/lib/request/schedule-key-version-deletion-request.d.ts +2 -2
- package/lib/request/schedule-vault-deletion-request.d.ts +2 -2
- package/lib/request/sign-request.d.ts +1 -1
- package/lib/request/update-ekms-private-endpoint-request.d.ts +2 -2
- package/lib/request/update-key-request.d.ts +2 -2
- package/lib/request/update-vault-request.d.ts +2 -2
- package/lib/request/verify-request.d.ts +1 -1
- package/lib/response/backup-key-response.d.ts +1 -1
- package/lib/response/backup-vault-response.d.ts +1 -1
- package/lib/response/cancel-key-deletion-response.d.ts +1 -1
- package/lib/response/cancel-key-version-deletion-response.d.ts +1 -1
- package/lib/response/cancel-vault-deletion-response.d.ts +1 -1
- package/lib/response/change-key-compartment-response.d.ts +1 -1
- package/lib/response/change-vault-compartment-response.d.ts +1 -1
- package/lib/response/create-ekms-private-endpoint-response.d.ts +1 -1
- package/lib/response/create-key-response.d.ts +1 -1
- package/lib/response/create-key-version-response.d.ts +1 -1
- package/lib/response/create-vault-response.d.ts +1 -1
- package/lib/response/disable-key-response.d.ts +1 -1
- package/lib/response/enable-key-response.d.ts +1 -1
- package/lib/response/get-ekms-private-endpoint-response.d.ts +1 -1
- package/lib/response/get-key-response.d.ts +1 -1
- package/lib/response/get-key-version-response.d.ts +1 -1
- package/lib/response/get-replication-status-response.d.ts +1 -1
- package/lib/response/get-vault-response.d.ts +1 -1
- package/lib/response/get-wrapping-key-response.d.ts +1 -1
- package/lib/response/import-key-response.d.ts +1 -1
- package/lib/response/import-key-version-response.d.ts +1 -1
- package/lib/response/list-ekms-private-endpoints-response.d.ts +1 -1
- package/lib/response/list-key-versions-response.d.ts +1 -1
- package/lib/response/list-keys-response.d.ts +1 -1
- package/lib/response/list-vault-replicas-response.d.ts +2 -2
- package/lib/response/list-vaults-response.d.ts +1 -1
- package/lib/response/restore-key-from-file-response.d.ts +1 -1
- package/lib/response/restore-key-from-object-store-response.d.ts +1 -1
- package/lib/response/restore-vault-from-file-response.d.ts +1 -1
- package/lib/response/restore-vault-from-object-store-response.d.ts +1 -1
- package/lib/response/schedule-key-deletion-response.d.ts +1 -1
- package/lib/response/schedule-key-version-deletion-response.d.ts +1 -1
- package/lib/response/schedule-vault-deletion-response.d.ts +1 -1
- package/lib/response/update-ekms-private-endpoint-response.d.ts +1 -1
- package/lib/response/update-key-response.d.ts +1 -1
- package/lib/response/update-vault-response.d.ts +1 -1
- package/package.json +3 -3
|
@@ -22,7 +22,7 @@ export interface ImportKeyDetails {
|
|
|
22
22
|
"compartmentId": string;
|
|
23
23
|
/**
|
|
24
24
|
* Usage of predefined tag keys. These predefined keys are scoped to namespaces.
|
|
25
|
-
* Example:
|
|
25
|
+
* Example: {@code {\"foo-namespace\": {\"bar-key\": \"foo-value\"}}}
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
"definedTags"?: {
|
|
@@ -39,7 +39,7 @@ export interface ImportKeyDetails {
|
|
|
39
39
|
/**
|
|
40
40
|
* Simple key-value pair that is applied without any predefined name, type, or scope.
|
|
41
41
|
* Exists for cross-compatibility only.
|
|
42
|
-
* Example:
|
|
42
|
+
* Example: {@code {\"bar-key\": \"value\"}}
|
|
43
43
|
*
|
|
44
44
|
*/
|
|
45
45
|
"freeformTags"?: {
|
|
@@ -49,10 +49,10 @@ export interface ImportKeyDetails {
|
|
|
49
49
|
"wrappedImportKey": model.WrappedImportKey;
|
|
50
50
|
/**
|
|
51
51
|
* The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
|
|
52
|
-
* A protection mode of
|
|
53
|
-
* the HSM. A protection mode of
|
|
54
|
-
* on the HSM. All cryptographic operations that use a key with a protection mode of
|
|
55
|
-
* a key's protection mode is set to
|
|
52
|
+
* A protection mode of {@code HSM} means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
|
|
53
|
+
* the HSM. A protection mode of {@code SOFTWARE} means that the key persists on the server, protected by the vault's RSA wrapping key which persists
|
|
54
|
+
* on the HSM. All cryptographic operations that use a key with a protection mode of {@code SOFTWARE} are performed on the server. By default,
|
|
55
|
+
* a key's protection mode is set to {@code HSM}. You can't change a key's protection mode after the key is created or imported.
|
|
56
56
|
*
|
|
57
57
|
*/
|
|
58
58
|
"protectionMode"?: ImportKeyDetails.ProtectionMode;
|
|
@@ -19,7 +19,7 @@ export interface ImportKeyVersionDetails {
|
|
|
19
19
|
/**
|
|
20
20
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
21
21
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
22
|
-
* Example:
|
|
22
|
+
* Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
23
23
|
*
|
|
24
24
|
*/
|
|
25
25
|
"definedTags"?: {
|
|
@@ -30,7 +30,7 @@ export interface ImportKeyVersionDetails {
|
|
|
30
30
|
/**
|
|
31
31
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
32
32
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
33
|
-
* Example:
|
|
33
|
+
* Example: {@code {\"Department\": \"Finance\"}}
|
|
34
34
|
*
|
|
35
35
|
*/
|
|
36
36
|
"freeformTags"?: {
|
package/lib/model/key-shape.d.ts
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface KeyShape {
|
|
18
18
|
/**
|
|
19
|
-
* The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for
|
|
19
|
+
* The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for {@code External} keys.
|
|
20
20
|
*/
|
|
21
21
|
"algorithm": KeyShape.Algorithm;
|
|
22
22
|
/**
|
|
@@ -23,7 +23,7 @@ export interface KeySummary {
|
|
|
23
23
|
/**
|
|
24
24
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
25
25
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
26
|
-
* Example:
|
|
26
|
+
* Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
29
29
|
"definedTags"?: {
|
|
@@ -40,7 +40,7 @@ export interface KeySummary {
|
|
|
40
40
|
/**
|
|
41
41
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
42
42
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
43
|
-
* Example:
|
|
43
|
+
* Example: {@code {\"Department\": \"Finance\"}}
|
|
44
44
|
*
|
|
45
45
|
*/
|
|
46
46
|
"freeformTags"?: {
|
|
@@ -53,14 +53,14 @@ export interface KeySummary {
|
|
|
53
53
|
/**
|
|
54
54
|
* The key's current lifecycle state.
|
|
55
55
|
* <p>
|
|
56
|
-
Example:
|
|
56
|
+
Example: {@code ENABLED}
|
|
57
57
|
*
|
|
58
58
|
*/
|
|
59
59
|
"lifecycleState": KeySummary.LifecycleState;
|
|
60
60
|
/**
|
|
61
61
|
* The date and time the key was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
|
|
62
62
|
* <p>
|
|
63
|
-
Example:
|
|
63
|
+
Example: {@code 2018-04-03T21:10:29.600Z}
|
|
64
64
|
*
|
|
65
65
|
*/
|
|
66
66
|
"timeCreated": Date;
|
|
@@ -70,13 +70,13 @@ export interface KeySummary {
|
|
|
70
70
|
"vaultId": string;
|
|
71
71
|
/**
|
|
72
72
|
* The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
|
|
73
|
-
* A protection mode of
|
|
74
|
-
* the HSM. A protection mode of
|
|
75
|
-
* on the HSM. All cryptographic operations that use a key with a protection mode of
|
|
76
|
-
* a key's protection mode is set to
|
|
77
|
-
* A protection mode of
|
|
73
|
+
* A protection mode of {@code HSM} means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
|
|
74
|
+
* the HSM. A protection mode of {@code SOFTWARE} means that the key persists on the server, protected by the vault's RSA wrapping key which persists
|
|
75
|
+
* on the HSM. All cryptographic operations that use a key with a protection mode of {@code SOFTWARE} are performed on the server. By default,
|
|
76
|
+
* a key's protection mode is set to {@code HSM}. You can't change a key's protection mode after the key is created or imported.
|
|
77
|
+
* A protection mode of {@code EXTERNAL} mean that the key persists on the customer's external key manager which is hosted externally outside of oracle.
|
|
78
78
|
* Oracle only hold a reference to that key.
|
|
79
|
-
* All cryptographic operations that use a key with a protection mode of
|
|
79
|
+
* All cryptographic operations that use a key with a protection mode of {@code EXTERNAL} are performed by external key manager.
|
|
80
80
|
*
|
|
81
81
|
*/
|
|
82
82
|
"protectionMode"?: KeySummary.ProtectionMode;
|
|
@@ -31,7 +31,7 @@ export interface KeyVersionSummary {
|
|
|
31
31
|
/**
|
|
32
32
|
* The key version's current lifecycle state.
|
|
33
33
|
* <p>
|
|
34
|
-
Example:
|
|
34
|
+
Example: {@code ENABLED}
|
|
35
35
|
*
|
|
36
36
|
*/
|
|
37
37
|
"lifecycleState"?: KeyVersionSummary.LifecycleState;
|
|
@@ -42,13 +42,13 @@ export interface KeyVersionSummary {
|
|
|
42
42
|
/**
|
|
43
43
|
* The date and time this key version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
|
|
44
44
|
* <p>
|
|
45
|
-
Example:
|
|
45
|
+
Example: {@code 2018-04-03T21:10:29.600Z}
|
|
46
46
|
*
|
|
47
47
|
*/
|
|
48
48
|
"timeCreated": Date;
|
|
49
49
|
/**
|
|
50
50
|
* An optional property to indicate when to delete the key version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
|
|
51
|
-
* Example:
|
|
51
|
+
* Example: {@code 2019-04-03T21:10:29.600Z}
|
|
52
52
|
*
|
|
53
53
|
*/
|
|
54
54
|
"timeOfDeletion"?: Date;
|
|
@@ -36,13 +36,13 @@ export interface KeyVersion {
|
|
|
36
36
|
/**
|
|
37
37
|
* The key version's current lifecycle state.
|
|
38
38
|
* <p>
|
|
39
|
-
Example:
|
|
39
|
+
Example: {@code ENABLED}
|
|
40
40
|
*
|
|
41
41
|
*/
|
|
42
42
|
"lifecycleState"?: KeyVersion.LifecycleState;
|
|
43
43
|
/**
|
|
44
|
-
* The source of the key material. When this value is
|
|
45
|
-
* created the key material. When this value is
|
|
44
|
+
* The source of the key material. When this value is {@code INTERNAL}, Key Management
|
|
45
|
+
* created the key material. When this value is {@code EXTERNAL}, the key material
|
|
46
46
|
* was imported from an external source.
|
|
47
47
|
*
|
|
48
48
|
*/
|
|
@@ -56,7 +56,7 @@ export interface KeyVersion {
|
|
|
56
56
|
"timeCreated": Date;
|
|
57
57
|
/**
|
|
58
58
|
* An optional property indicating when to delete the key version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
|
|
59
|
-
* Example:
|
|
59
|
+
* Example: {@code 2019-04-03T21:10:29.600Z}
|
|
60
60
|
*
|
|
61
61
|
*/
|
|
62
62
|
"timeOfDeletion"?: Date;
|
package/lib/model/key.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ export interface Key {
|
|
|
22
22
|
"compartmentId": string;
|
|
23
23
|
/**
|
|
24
24
|
* The OCID of the key version used in cryptographic operations. During key rotation, the service might be
|
|
25
|
-
* in a transitional state where this or a newer key version are used intermittently. The
|
|
25
|
+
* in a transitional state where this or a newer key version are used intermittently. The {@code currentKeyVersion}
|
|
26
26
|
* property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
@@ -30,7 +30,7 @@ export interface Key {
|
|
|
30
30
|
/**
|
|
31
31
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
32
32
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
33
|
-
* Example:
|
|
33
|
+
* Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
34
34
|
*
|
|
35
35
|
*/
|
|
36
36
|
"definedTags"?: {
|
|
@@ -47,7 +47,7 @@ export interface Key {
|
|
|
47
47
|
/**
|
|
48
48
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
49
49
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
50
|
-
* Example:
|
|
50
|
+
* Example: {@code {\"Department\": \"Finance\"}}
|
|
51
51
|
*
|
|
52
52
|
*/
|
|
53
53
|
"freeformTags"?: {
|
|
@@ -60,33 +60,33 @@ export interface Key {
|
|
|
60
60
|
"keyShape": model.KeyShape;
|
|
61
61
|
/**
|
|
62
62
|
* The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
|
|
63
|
-
* A protection mode of
|
|
64
|
-
* the HSM. A protection mode of
|
|
65
|
-
* on the HSM. All cryptographic operations that use a key with a protection mode of
|
|
66
|
-
* a key's protection mode is set to
|
|
67
|
-
* A protection mode of
|
|
63
|
+
* A protection mode of {@code HSM} means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
|
|
64
|
+
* the HSM. A protection mode of {@code SOFTWARE} means that the key persists on the server, protected by the vault's RSA wrapping key which persists
|
|
65
|
+
* on the HSM. All cryptographic operations that use a key with a protection mode of {@code SOFTWARE} are performed on the server. By default,
|
|
66
|
+
* a key's protection mode is set to {@code HSM}. You can't change a key's protection mode after the key is created or imported.
|
|
67
|
+
* A protection mode of {@code EXTERNAL} mean that the key persists on the customer's external key manager which is hosted externally outside of oracle.
|
|
68
68
|
* Oracle only hold a reference to that key.
|
|
69
|
-
* All cryptographic operations that use a key with a protection mode of
|
|
69
|
+
* All cryptographic operations that use a key with a protection mode of {@code EXTERNAL} are performed by external key manager.
|
|
70
70
|
*
|
|
71
71
|
*/
|
|
72
72
|
"protectionMode"?: Key.ProtectionMode;
|
|
73
73
|
/**
|
|
74
74
|
* The key's current lifecycle state.
|
|
75
75
|
* <p>
|
|
76
|
-
Example:
|
|
76
|
+
Example: {@code ENABLED}
|
|
77
77
|
*
|
|
78
78
|
*/
|
|
79
79
|
"lifecycleState": Key.LifecycleState;
|
|
80
80
|
/**
|
|
81
81
|
* The date and time the key was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
|
|
82
82
|
* <p>
|
|
83
|
-
Example:
|
|
83
|
+
Example: {@code 2018-04-03T21:10:29.600Z}
|
|
84
84
|
*
|
|
85
85
|
*/
|
|
86
86
|
"timeCreated": Date;
|
|
87
87
|
/**
|
|
88
88
|
* An optional property indicating when to delete the key, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
|
|
89
|
-
* Example:
|
|
89
|
+
* Example: {@code 2019-04-03T21:10:29.600Z}
|
|
90
90
|
*
|
|
91
91
|
*/
|
|
92
92
|
"timeOfDeletion"?: Date;
|
|
@@ -29,7 +29,7 @@ export interface SignDataDetails {
|
|
|
29
29
|
"keyVersionId"?: string;
|
|
30
30
|
/**
|
|
31
31
|
* Denotes whether the value of the message parameter is a raw message or a message digest.
|
|
32
|
-
* The default value,
|
|
32
|
+
* The default value, {@code RAW}, indicates a message. To indicate a message digest, use {@code DIGEST}.
|
|
33
33
|
*
|
|
34
34
|
*/
|
|
35
35
|
"messageType"?: SignDataDetails.MessageType;
|
|
@@ -21,7 +21,7 @@ export interface UpdateEkmsPrivateEndpointDetails {
|
|
|
21
21
|
"displayName"?: string;
|
|
22
22
|
/**
|
|
23
23
|
* Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
|
|
24
|
-
* Example:
|
|
24
|
+
* Example: {@code {\"bar-key\": \"value\"}}
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
"freeformTags"?: {
|
|
@@ -29,7 +29,7 @@ export interface UpdateEkmsPrivateEndpointDetails {
|
|
|
29
29
|
};
|
|
30
30
|
/**
|
|
31
31
|
* Usage of predefined tag keys. These predefined keys are scoped to namespaces.
|
|
32
|
-
* Example:
|
|
32
|
+
* Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
|
|
33
33
|
*
|
|
34
34
|
*/
|
|
35
35
|
"definedTags"?: {
|
|
@@ -18,7 +18,7 @@ export interface UpdateKeyDetails {
|
|
|
18
18
|
/**
|
|
19
19
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
20
20
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
21
|
-
* Example:
|
|
21
|
+
* Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
22
22
|
*
|
|
23
23
|
*/
|
|
24
24
|
"definedTags"?: {
|
|
@@ -35,7 +35,7 @@ export interface UpdateKeyDetails {
|
|
|
35
35
|
/**
|
|
36
36
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
37
37
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
38
|
-
* Example:
|
|
38
|
+
* Example: {@code {\"Department\": \"Finance\"}}
|
|
39
39
|
*
|
|
40
40
|
*/
|
|
41
41
|
"freeformTags"?: {
|
|
@@ -18,7 +18,7 @@ export interface UpdateVaultDetails {
|
|
|
18
18
|
/**
|
|
19
19
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
20
20
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
21
|
-
* Example:
|
|
21
|
+
* Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
22
22
|
*
|
|
23
23
|
*/
|
|
24
24
|
"definedTags"?: {
|
|
@@ -35,7 +35,7 @@ export interface UpdateVaultDetails {
|
|
|
35
35
|
/**
|
|
36
36
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
37
37
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
38
|
-
* Example:
|
|
38
|
+
* Example: {@code {\"Department\": \"Finance\"}}
|
|
39
39
|
*
|
|
40
40
|
*/
|
|
41
41
|
"freeformTags"?: {
|
|
@@ -30,7 +30,7 @@ export interface VaultSummary {
|
|
|
30
30
|
/**
|
|
31
31
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
32
32
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
33
|
-
* Example:
|
|
33
|
+
* Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
34
34
|
*
|
|
35
35
|
*/
|
|
36
36
|
"definedTags"?: {
|
|
@@ -47,7 +47,7 @@ export interface VaultSummary {
|
|
|
47
47
|
/**
|
|
48
48
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
49
49
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
50
|
-
* Example:
|
|
50
|
+
* Example: {@code {\"Department\": \"Finance\"}}
|
|
51
51
|
*
|
|
52
52
|
*/
|
|
53
53
|
"freeformTags"?: {
|
|
@@ -60,7 +60,7 @@ export interface VaultSummary {
|
|
|
60
60
|
/**
|
|
61
61
|
* A vault's current lifecycle state.
|
|
62
62
|
* <p>
|
|
63
|
-
Example:
|
|
63
|
+
Example: {@code ACTIVE}
|
|
64
64
|
*
|
|
65
65
|
*/
|
|
66
66
|
"lifecycleState": VaultSummary.LifecycleState;
|
|
@@ -72,7 +72,7 @@ export interface VaultSummary {
|
|
|
72
72
|
/**
|
|
73
73
|
* The date and time a vault was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
|
|
74
74
|
* <p>
|
|
75
|
-
Example:
|
|
75
|
+
Example: {@code 2018-04-03T21:10:29.600Z}
|
|
76
76
|
*
|
|
77
77
|
*/
|
|
78
78
|
"timeCreated": Date;
|
|
@@ -16,19 +16,19 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface VaultUsage {
|
|
18
18
|
/**
|
|
19
|
-
* The number of keys in this vault that persist on a hardware security module (HSM), across all compartments, excluding keys in a
|
|
19
|
+
* The number of keys in this vault that persist on a hardware security module (HSM), across all compartments, excluding keys in a {@code DELETED} state. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
20
20
|
*/
|
|
21
21
|
"keyCount": number;
|
|
22
22
|
/**
|
|
23
|
-
* The number of key versions in this vault that persist on a hardware security module (HSM), across all compartments, excluding key versions in a
|
|
23
|
+
* The number of key versions in this vault that persist on a hardware security module (HSM), across all compartments, excluding key versions in a {@code DELETED} state. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
24
24
|
*/
|
|
25
25
|
"keyVersionCount": number;
|
|
26
26
|
/**
|
|
27
|
-
* The number of keys in this vault that persist on the server, across all compartments, excluding keys in a
|
|
27
|
+
* The number of keys in this vault that persist on the server, across all compartments, excluding keys in a {@code DELETED} state. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
28
28
|
*/
|
|
29
29
|
"softwareKeyCount"?: number;
|
|
30
30
|
/**
|
|
31
|
-
* The number of key versions in this vault that persist on the server, across all compartments, excluding key versions in a
|
|
31
|
+
* The number of key versions in this vault that persist on the server, across all compartments, excluding key versions in a {@code DELETED} state. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
32
32
|
*/
|
|
33
33
|
"softwareKeyVersionCount"?: number;
|
|
34
34
|
}
|
package/lib/model/vault.d.ts
CHANGED
|
@@ -30,7 +30,7 @@ export interface Vault {
|
|
|
30
30
|
/**
|
|
31
31
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
32
32
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
33
|
-
* Example:
|
|
33
|
+
* Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
34
34
|
*
|
|
35
35
|
*/
|
|
36
36
|
"definedTags"?: {
|
|
@@ -47,7 +47,7 @@ export interface Vault {
|
|
|
47
47
|
/**
|
|
48
48
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
49
49
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
50
|
-
* Example:
|
|
50
|
+
* Example: {@code {\"Department\": \"Finance\"}}
|
|
51
51
|
*
|
|
52
52
|
*/
|
|
53
53
|
"freeformTags"?: {
|
|
@@ -60,7 +60,7 @@ export interface Vault {
|
|
|
60
60
|
/**
|
|
61
61
|
* The vault's current lifecycle state.
|
|
62
62
|
* <p>
|
|
63
|
-
Example:
|
|
63
|
+
Example: {@code DELETED}
|
|
64
64
|
*
|
|
65
65
|
*/
|
|
66
66
|
"lifecycleState": Vault.LifecycleState;
|
|
@@ -72,13 +72,13 @@ export interface Vault {
|
|
|
72
72
|
/**
|
|
73
73
|
* The date and time this vault was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
|
|
74
74
|
* <p>
|
|
75
|
-
Example:
|
|
75
|
+
Example: {@code 2018-04-03T21:10:29.600Z}
|
|
76
76
|
*
|
|
77
77
|
*/
|
|
78
78
|
"timeCreated": Date;
|
|
79
79
|
/**
|
|
80
80
|
* An optional property to indicate when to delete the vault, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
|
|
81
|
-
* Example:
|
|
81
|
+
* Example: {@code 2018-04-03T21:10:29.600Z}
|
|
82
82
|
*
|
|
83
83
|
*/
|
|
84
84
|
"timeOfDeletion"?: Date;
|
|
@@ -30,7 +30,7 @@ export interface VerifyDataDetails {
|
|
|
30
30
|
"signature": string;
|
|
31
31
|
/**
|
|
32
32
|
* Denotes whether the value of the message parameter is a raw message or a message digest.
|
|
33
|
-
* The default value,
|
|
33
|
+
* The default value, {@code RAW}, indicates a message. To indicate a message digest, use {@code DIGEST}.
|
|
34
34
|
*
|
|
35
35
|
*/
|
|
36
36
|
"messageType"?: VerifyDataDetails.MessageType;
|
|
@@ -21,10 +21,10 @@ export interface WrappedImportKey {
|
|
|
21
21
|
"keyMaterial": string;
|
|
22
22
|
/**
|
|
23
23
|
* The wrapping mechanism to use during key import.
|
|
24
|
-
*
|
|
24
|
+
* {@code RSA_OAEP_AES_SHA256} invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped
|
|
25
25
|
* by the vault's RSA public wrapping key, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the private key material.
|
|
26
26
|
* The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them.
|
|
27
|
-
*
|
|
27
|
+
* {@code RSA_OAEP_SHA256} means that the exportable key material is wrapped by the vault's RSA public wrapping key.
|
|
28
28
|
*
|
|
29
29
|
*/
|
|
30
30
|
"wrappingAlgorithm": WrappedImportKey.WrappingAlgorithm;
|
|
@@ -26,7 +26,7 @@ export interface WrappingKey {
|
|
|
26
26
|
/**
|
|
27
27
|
* The key's current lifecycle state.
|
|
28
28
|
* <p>
|
|
29
|
-
Example:
|
|
29
|
+
Example: {@code ENABLED}
|
|
30
30
|
*
|
|
31
31
|
*/
|
|
32
32
|
"lifecycleState": WrappingKey.LifecycleState;
|
|
@@ -38,7 +38,7 @@ export interface WrappingKey {
|
|
|
38
38
|
/**
|
|
39
39
|
* The date and time the key was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
|
|
40
40
|
* <p>
|
|
41
|
-
Example:
|
|
41
|
+
Example: {@code 2018-04-03T21:10:29.600Z}
|
|
42
42
|
*
|
|
43
43
|
*/
|
|
44
44
|
"timeCreated": Date;
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
import * as model from "../model";
|
|
14
14
|
import common = require("oci-common");
|
|
15
15
|
/**
|
|
16
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
16
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/BackupKey.ts.html |here} to see how to use BackupKeyRequest.
|
|
17
17
|
*/
|
|
18
18
|
export interface BackupKeyRequest extends common.BaseRequest {
|
|
19
19
|
/**
|
|
@@ -22,7 +22,7 @@ export interface BackupKeyRequest extends common.BaseRequest {
|
|
|
22
22
|
"keyId": string;
|
|
23
23
|
/**
|
|
24
24
|
* For optimistic concurrency control. In the PUT or DELETE call for a
|
|
25
|
-
* resource, set the
|
|
25
|
+
* resource, set the {@code if-match} parameter to the value of the etag from a
|
|
26
26
|
* previous GET or POST response for that resource. The resource will be
|
|
27
27
|
* updated or deleted only if the etag you provide matches the resource's
|
|
28
28
|
* current etag value.
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
import * as model from "../model";
|
|
14
14
|
import common = require("oci-common");
|
|
15
15
|
/**
|
|
16
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
16
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/BackupVault.ts.html |here} to see how to use BackupVaultRequest.
|
|
17
17
|
*/
|
|
18
18
|
export interface BackupVaultRequest extends common.BaseRequest {
|
|
19
19
|
/**
|
|
@@ -22,7 +22,7 @@ export interface BackupVaultRequest extends common.BaseRequest {
|
|
|
22
22
|
"vaultId": string;
|
|
23
23
|
/**
|
|
24
24
|
* For optimistic concurrency control. In the PUT or DELETE call for a
|
|
25
|
-
* resource, set the
|
|
25
|
+
* resource, set the {@code if-match} parameter to the value of the etag from a
|
|
26
26
|
* previous GET or POST response for that resource. The resource will be
|
|
27
27
|
* updated or deleted only if the etag you provide matches the resource's
|
|
28
28
|
* current etag value.
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
*/
|
|
13
13
|
import common = require("oci-common");
|
|
14
14
|
/**
|
|
15
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
15
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CancelKeyDeletion.ts.html |here} to see how to use CancelKeyDeletionRequest.
|
|
16
16
|
*/
|
|
17
17
|
export interface CancelKeyDeletionRequest extends common.BaseRequest {
|
|
18
18
|
/**
|
|
@@ -21,7 +21,7 @@ export interface CancelKeyDeletionRequest extends common.BaseRequest {
|
|
|
21
21
|
"keyId": string;
|
|
22
22
|
/**
|
|
23
23
|
* For optimistic concurrency control. In the PUT or DELETE call for a
|
|
24
|
-
* resource, set the
|
|
24
|
+
* resource, set the {@code if-match} parameter to the value of the etag from a
|
|
25
25
|
* previous GET or POST response for that resource. The resource will be
|
|
26
26
|
* updated or deleted only if the etag you provide matches the resource's
|
|
27
27
|
* current etag value.
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
*/
|
|
13
13
|
import common = require("oci-common");
|
|
14
14
|
/**
|
|
15
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
15
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CancelKeyVersionDeletion.ts.html |here} to see how to use CancelKeyVersionDeletionRequest.
|
|
16
16
|
*/
|
|
17
17
|
export interface CancelKeyVersionDeletionRequest extends common.BaseRequest {
|
|
18
18
|
/**
|
|
@@ -25,7 +25,7 @@ export interface CancelKeyVersionDeletionRequest extends common.BaseRequest {
|
|
|
25
25
|
"keyVersionId": string;
|
|
26
26
|
/**
|
|
27
27
|
* For optimistic concurrency control. In the PUT or DELETE call for a
|
|
28
|
-
* resource, set the
|
|
28
|
+
* resource, set the {@code if-match} parameter to the value of the etag from a
|
|
29
29
|
* previous GET or POST response for that resource. The resource will be
|
|
30
30
|
* updated or deleted only if the etag you provide matches the resource's
|
|
31
31
|
* current etag value.
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
*/
|
|
13
13
|
import common = require("oci-common");
|
|
14
14
|
/**
|
|
15
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
15
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CancelVaultDeletion.ts.html |here} to see how to use CancelVaultDeletionRequest.
|
|
16
16
|
*/
|
|
17
17
|
export interface CancelVaultDeletionRequest extends common.BaseRequest {
|
|
18
18
|
/**
|
|
@@ -21,7 +21,7 @@ export interface CancelVaultDeletionRequest extends common.BaseRequest {
|
|
|
21
21
|
"vaultId": string;
|
|
22
22
|
/**
|
|
23
23
|
* For optimistic concurrency control. In the PUT or DELETE call for a
|
|
24
|
-
* resource, set the
|
|
24
|
+
* resource, set the {@code if-match} parameter to the value of the etag from a
|
|
25
25
|
* previous GET or POST response for that resource. The resource will be
|
|
26
26
|
* updated or deleted only if the etag you provide matches the resource's
|
|
27
27
|
* current etag value.
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
import * as model from "../model";
|
|
14
14
|
import common = require("oci-common");
|
|
15
15
|
/**
|
|
16
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
16
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ChangeKeyCompartment.ts.html |here} to see how to use ChangeKeyCompartmentRequest.
|
|
17
17
|
*/
|
|
18
18
|
export interface ChangeKeyCompartmentRequest extends common.BaseRequest {
|
|
19
19
|
/**
|
|
@@ -26,7 +26,7 @@ export interface ChangeKeyCompartmentRequest extends common.BaseRequest {
|
|
|
26
26
|
"changeKeyCompartmentDetails": model.ChangeKeyCompartmentDetails;
|
|
27
27
|
/**
|
|
28
28
|
* For optimistic concurrency control. In the PUT or DELETE call for a
|
|
29
|
-
* resource, set the
|
|
29
|
+
* resource, set the {@code if-match} parameter to the value of the etag from a
|
|
30
30
|
* previous GET or POST response for that resource. The resource will be
|
|
31
31
|
* updated or deleted only if the etag you provide matches the resource's
|
|
32
32
|
* current etag value.
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
import * as model from "../model";
|
|
14
14
|
import common = require("oci-common");
|
|
15
15
|
/**
|
|
16
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
16
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ChangeVaultCompartment.ts.html |here} to see how to use ChangeVaultCompartmentRequest.
|
|
17
17
|
*/
|
|
18
18
|
export interface ChangeVaultCompartmentRequest extends common.BaseRequest {
|
|
19
19
|
/**
|
|
@@ -26,7 +26,7 @@ export interface ChangeVaultCompartmentRequest extends common.BaseRequest {
|
|
|
26
26
|
"changeVaultCompartmentDetails": model.ChangeVaultCompartmentDetails;
|
|
27
27
|
/**
|
|
28
28
|
* For optimistic concurrency control. In the PUT or DELETE call for a
|
|
29
|
-
* resource, set the
|
|
29
|
+
* resource, set the {@code if-match} parameter to the value of the etag from a
|
|
30
30
|
* previous GET or POST response for that resource. The resource will be
|
|
31
31
|
* updated or deleted only if the etag you provide matches the resource's
|
|
32
32
|
* current etag value.
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
import * as model from "../model";
|
|
14
14
|
import common = require("oci-common");
|
|
15
15
|
/**
|
|
16
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
16
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CreateEkmsPrivateEndpoint.ts.html |here} to see how to use CreateEkmsPrivateEndpointRequest.
|
|
17
17
|
*/
|
|
18
18
|
export interface CreateEkmsPrivateEndpointRequest extends common.BaseRequest {
|
|
19
19
|
/**
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
import * as model from "../model";
|
|
14
14
|
import common = require("oci-common");
|
|
15
15
|
/**
|
|
16
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
16
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CreateKey.ts.html |here} to see how to use CreateKeyRequest.
|
|
17
17
|
*/
|
|
18
18
|
export interface CreateKeyRequest extends common.BaseRequest {
|
|
19
19
|
/**
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
import * as model from "../model";
|
|
14
14
|
import common = require("oci-common");
|
|
15
15
|
/**
|
|
16
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
16
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CreateKeyVersion.ts.html |here} to see how to use CreateKeyVersionRequest.
|
|
17
17
|
*/
|
|
18
18
|
export interface CreateKeyVersionRequest extends common.BaseRequest {
|
|
19
19
|
/**
|