oci-keymanagement 2.130.0 → 2.131.1

package/lib/client.d.ts

@@ -404,6 +404,16 @@ export declare class KmsHsmClusterClient {
      * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/CreateHsmCluster.ts.html |here} to see how to use CreateHsmCluster API.
      */
     createHsmCluster(createHsmClusterRequest: requests.CreateHsmClusterRequest): Promise<responses.CreateHsmClusterResponse>;
+    /**
+     * Disables management audit logging for the given HSM Cluster resource. This requires the Crypto Officer (CO) password. This operation is idempotent: if audit logging is already disabled, the call is a no-op and returns success.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DisableAuditMgmtLoggingRequest
+     * @return DisableAuditMgmtLoggingResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/DisableAuditMgmtLogging.ts.html |here} to see how to use DisableAuditMgmtLogging API.
+     */
+    disableAuditMgmtLogging(disableAuditMgmtLoggingRequest: requests.DisableAuditMgmtLoggingRequest): Promise<responses.DisableAuditMgmtLoggingResponse>;
     /**
      * Retrieves the certificate signing request for the designated HSM Cluster resource.
      *
@@ -414,6 +424,18 @@ export declare class KmsHsmClusterClient {
      * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/DownloadCertificateSigningRequest.ts.html |here} to see how to use DownloadCertificateSigningRequest API.
      */
     downloadCertificateSigningRequest(downloadCertificateSigningRequestRequest: requests.DownloadCertificateSigningRequestRequest): Promise<responses.DownloadCertificateSigningRequestResponse>;
+    /**
+     * Validates that the Dynamic Group and bucket policy supplied during EnableAuditLogging / CreateHsmCluster are now in place.
+     * If the cluster is in WAITING_FOR_CUSTOMER, and validation is successful, status is progressed and a work request is started.
+     * If the cluster has already progressed past that gate, the call is idempotent and returns 202 with the current cluster representation.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param EnableAuditMgmtLoggingRequest
+     * @return EnableAuditMgmtLoggingResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/EnableAuditMgmtLogging.ts.html |here} to see how to use EnableAuditMgmtLogging API.
+     */
+    enableAuditMgmtLogging(enableAuditMgmtLoggingRequest: requests.EnableAuditMgmtLoggingRequest): Promise<responses.EnableAuditMgmtLoggingResponse>;
     /**
        * Retrieves configuration details for the specified HSM Cluster resource.
   * <p>
@@ -449,6 +471,15 @@ export declare class KmsHsmClusterClient {
      * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/GetPreCoUserCredentials.ts.html |here} to see how to use GetPreCoUserCredentials API.
      */
     getPreCoUserCredentials(getPreCoUserCredentialsRequest: requests.GetPreCoUserCredentialsRequest): Promise<responses.GetPreCoUserCredentialsResponse>;
+    /**
+     * Initiates the process of enabling audit logs for a HSM cluster resource by taking in the required parameters.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param InitiateAuditLoggingRequest
+     * @return InitiateAuditLoggingResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/InitiateAuditLogging.ts.html |here} to see how to use InitiateAuditLogging API.
+     */
+    initiateAuditLogging(initiateAuditLoggingRequest: requests.InitiateAuditLoggingRequest): Promise<responses.InitiateAuditLoggingResponse>;
     /**
        * Lists all HSM cluster resources contained within the specified compartment.
   * <p>
@@ -485,6 +516,15 @@ export declare class KmsHsmClusterClient {
      * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/ScheduleHsmClusterDeletion.ts.html |here} to see how to use ScheduleHsmClusterDeletion API.
      */
     scheduleHsmClusterDeletion(scheduleHsmClusterDeletionRequest: requests.ScheduleHsmClusterDeletionRequest): Promise<responses.ScheduleHsmClusterDeletionResponse>;
+    /**
+     * update bucket details of management audit logs for a HSM cluster resource by hsmClusterId.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateAuditLoggingDestinationRequest
+     * @return UpdateAuditLoggingDestinationResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/UpdateAuditLoggingDestination.ts.html |here} to see how to use UpdateAuditLoggingDestination API.
+     */
+    updateAuditLoggingDestination(updateAuditLoggingDestinationRequest: requests.UpdateAuditLoggingDestinationRequest): Promise<responses.UpdateAuditLoggingDestinationResponse>;
     /**
        * Modifies properties of an HSM cluster resource, including `displayName`, `freeformTags` and `definedTags`.
   * <p>
@@ -1292,6 +1332,16 @@ export declare class KmsVaultClient {
        * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/ScheduleVaultDeletion.ts.html |here} to see how to use ScheduleVaultDeletion API.
        */
     scheduleVaultDeletion(scheduleVaultDeletionRequest: requests.ScheduleVaultDeletionRequest): Promise<responses.ScheduleVaultDeletionResponse>;
+    /**
+     * Update fleet ids for the registered mTLS vault.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateRegisteredVaultForMtlsRequest
+     * @return UpdateRegisteredVaultForMtlsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/UpdateRegisteredVaultForMtls.ts.html |here} to see how to use UpdateRegisteredVaultForMtls API.
+     */
+    updateRegisteredVaultForMtls(updateRegisteredVaultForMtlsRequest: requests.UpdateRegisteredVaultForMtlsRequest): Promise<responses.UpdateRegisteredVaultForMtlsResponse>;
     /**
        * Updates the properties of a vault. Specifically, you can update the
   * `displayName`, `freeformTags`, and `definedTags` properties. Furthermore,

package/lib/client.js

@@ -1387,6 +1387,68 @@ class KmsHsmClusterClient {
             }
         });
     }
+    /**
+     * Disables management audit logging for the given HSM Cluster resource. This requires the Crypto Officer (CO) password. This operation is idempotent: if audit logging is already disabled, the call is a no-op and returns success.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DisableAuditMgmtLoggingRequest
+     * @return DisableAuditMgmtLoggingResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/DisableAuditMgmtLogging.ts.html |here} to see how to use DisableAuditMgmtLogging API.
+     */
+    disableAuditMgmtLogging(disableAuditMgmtLoggingRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation KmsHsmClusterClient#disableAuditMgmtLogging.");
+            const operationName = "disableAuditMgmtLogging";
+            const apiReferenceLink = "https://docs.oracle.com/iaas/api/#/en/key/release/HsmCluster/DisableAuditMgmtLogging";
+            const pathParams = {
+                "{hsmClusterId}": disableAuditMgmtLoggingRequest.hsmClusterId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "if-match": disableAuditMgmtLoggingRequest.ifMatch,
+                "opc-request-id": disableAuditMgmtLoggingRequest.opcRequestId,
+                "opc-retry-token": disableAuditMgmtLoggingRequest.opcRetryToken
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, disableAuditMgmtLoggingRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/20180608/hsmClusters/{hsmClusterId}/actions/disableAuditMgmtLogging",
+                method: "POST",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_2.composeResponse({
+                    responseObject: {},
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
     /**
      * Retrieves the certificate signing request for the designated HSM Cluster resource.
      *
@@ -1453,6 +1515,79 @@ class KmsHsmClusterClient {
             }
         });
     }
+    /**
+     * Validates that the Dynamic Group and bucket policy supplied during EnableAuditLogging / CreateHsmCluster are now in place.
+     * If the cluster is in WAITING_FOR_CUSTOMER, and validation is successful, status is progressed and a work request is started.
+     * If the cluster has already progressed past that gate, the call is idempotent and returns 202 with the current cluster representation.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param EnableAuditMgmtLoggingRequest
+     * @return EnableAuditMgmtLoggingResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/EnableAuditMgmtLogging.ts.html |here} to see how to use EnableAuditMgmtLogging API.
+     */
+    enableAuditMgmtLogging(enableAuditMgmtLoggingRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation KmsHsmClusterClient#enableAuditMgmtLogging.");
+            const operationName = "enableAuditMgmtLogging";
+            const apiReferenceLink = "https://docs.oracle.com/iaas/api/#/en/key/release/HsmCluster/EnableAuditMgmtLogging";
+            const pathParams = {
+                "{hsmClusterId}": enableAuditMgmtLoggingRequest.hsmClusterId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "if-match": enableAuditMgmtLoggingRequest.ifMatch,
+                "opc-retry-token": enableAuditMgmtLoggingRequest.opcRetryToken,
+                "opc-request-id": enableAuditMgmtLoggingRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, enableAuditMgmtLoggingRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/20180608/hsmClusters/{hsmClusterId}/actions/enableAuditMgmtLogging",
+                method: "POST",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_2.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "enableAuditMgmtLogging",
+                    bodyModel: model.EnableAuditMgmtLogging,
+                    type: "model.EnableAuditMgmtLogging",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
     /**
        * Retrieves configuration details for the specified HSM Cluster resource.
   * <p>
@@ -1653,6 +1788,72 @@ class KmsHsmClusterClient {
             }
         });
     }
+    /**
+     * Initiates the process of enabling audit logs for a HSM cluster resource by taking in the required parameters.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param InitiateAuditLoggingRequest
+     * @return InitiateAuditLoggingResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/InitiateAuditLogging.ts.html |here} to see how to use InitiateAuditLogging API.
+     */
+    initiateAuditLogging(initiateAuditLoggingRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation KmsHsmClusterClient#initiateAuditLogging.");
+            const operationName = "initiateAuditLogging";
+            const apiReferenceLink = "https://docs.oracle.com/iaas/api/#/en/key/release/HsmCluster/InitiateAuditLogging";
+            const pathParams = {
+                "{hsmClusterId}": initiateAuditLoggingRequest.hsmClusterId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": initiateAuditLoggingRequest.opcRequestId,
+                "if-match": initiateAuditLoggingRequest.ifMatch,
+                "opc-retry-token": initiateAuditLoggingRequest.opcRetryToken
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, initiateAuditLoggingRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/20180608/hsmClusters/{hsmClusterId}/actions/initiateAuditLogging",
+                method: "POST",
+                bodyContent: common.ObjectSerializer.serialize(initiateAuditLoggingRequest.initiateAuditLoggingDetails, "InitiateAuditLoggingDetails", model.InitiateAuditLoggingDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_2.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "auditLogging",
+                    bodyModel: model.AuditLogging,
+                    type: "model.AuditLogging",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
     /**
        * Lists all HSM cluster resources contained within the specified compartment.
   * <p>
@@ -1864,6 +2065,77 @@ class KmsHsmClusterClient {
             }
         });
     }
+    /**
+     * update bucket details of management audit logs for a HSM cluster resource by hsmClusterId.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateAuditLoggingDestinationRequest
+     * @return UpdateAuditLoggingDestinationResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/UpdateAuditLoggingDestination.ts.html |here} to see how to use UpdateAuditLoggingDestination API.
+     */
+    updateAuditLoggingDestination(updateAuditLoggingDestinationRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation KmsHsmClusterClient#updateAuditLoggingDestination.");
+            const operationName = "updateAuditLoggingDestination";
+            const apiReferenceLink = "https://docs.oracle.com/iaas/api/#/en/key/release/HsmCluster/UpdateAuditLoggingDestination";
+            const pathParams = {
+                "{hsmClusterId}": updateAuditLoggingDestinationRequest.hsmClusterId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": updateAuditLoggingDestinationRequest.opcRequestId,
+                "opc-retry-token": updateAuditLoggingDestinationRequest.opcRetryToken,
+                "if-match": updateAuditLoggingDestinationRequest.ifMatch
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, updateAuditLoggingDestinationRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/20180608/hsmClusters/{hsmClusterId}/actions/updateAuditLoggingDestination",
+                method: "PUT",
+                bodyContent: common.ObjectSerializer.serialize(updateAuditLoggingDestinationRequest.updateAuditLoggingDestinationDetails, "UpdateAuditLoggingDestinationDetails", model.UpdateAuditLoggingDestinationDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_2.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "auditLogging",
+                    bodyModel: model.AuditLogging,
+                    type: "model.AuditLogging",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
     /**
        * Modifies properties of an HSM cluster resource, including `displayName`, `freeformTags` and `definedTags`.
   * <p>
@@ -4894,6 +5166,72 @@ class KmsVaultClient {
             }
         });
     }
+    /**
+     * Update fleet ids for the registered mTLS vault.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateRegisteredVaultForMtlsRequest
+     * @return UpdateRegisteredVaultForMtlsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/keymanagement/UpdateRegisteredVaultForMtls.ts.html |here} to see how to use UpdateRegisteredVaultForMtls API.
+     */
+    updateRegisteredVaultForMtls(updateRegisteredVaultForMtlsRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation KmsVaultClient#updateRegisteredVaultForMtls.");
+            const operationName = "updateRegisteredVaultForMtls";
+            const apiReferenceLink = "https://docs.oracle.com/iaas/api/#/en/key/release/UpdateRegisteredVaultForMtlsDetails/UpdateRegisteredVaultForMtls";
+            const pathParams = {
+                "{vaultId}": updateRegisteredVaultForMtlsRequest.vaultId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "if-match": updateRegisteredVaultForMtlsRequest.ifMatch,
+                "opc-request-id": updateRegisteredVaultForMtlsRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, updateRegisteredVaultForMtlsRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/20180608/vaults/{vaultId}/updateRegisteredVaultForMtls",
+                method: "PUT",
+                bodyContent: common.ObjectSerializer.serialize(updateRegisteredVaultForMtlsRequest.updateRegisteredVaultForMtlsDetails, "UpdateRegisteredVaultForMtlsDetails", model.UpdateRegisteredVaultForMtlsDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_2.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "vaultMtlsUpdateResponse",
+                    bodyModel: model.VaultMtlsUpdateResponse,
+                    type: "model.VaultMtlsUpdateResponse",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
     /**
        * Updates the properties of a vault. Specifically, you can update the
   * `displayName`, `freeformTags`, and `definedTags` properties. Furthermore,