Package co.ankatech.keymanagement.client.keymanagement.api

Class CryptographicIdentityLifecycleMaterialVersionsApi

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.api.CryptographicIdentityLifecycleMaterialVersionsApi
public class CryptographicIdentityLifecycleMaterialVersionsApi extends Object

  • Constructor Details

    • CryptographicIdentityLifecycleMaterialVersionsApi

      public CryptographicIdentityLifecycleMaterialVersionsApi()

    • CryptographicIdentityLifecycleMaterialVersionsApi

      public CryptographicIdentityLifecycleMaterialVersionsApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • cancelKeyMaterialVersionDestructionCall

      public okhttp3.Call cancelKeyMaterialVersionDestructionCall(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, ApiCallback _callback) throws ApiException
      Build call for cancelKeyMaterialVersionDestruction
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • cancelKeyMaterialVersionDestruction

      public MaterialVersionResponse cancelKeyMaterialVersionDestruction(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version) throws ApiException
      Cancel a scheduled version destruction Cancels the scheduled destruction the version belongs to, before the platform runs it: the version's own destruction order, or the destruction of the whole key it was scheduled with, which is cancelled as a whole. Every version of the cancelled order returns to the status it had before the request was approved. A later destruction needs a new request and a new approval.
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      Returns:
      MaterialVersionResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • cancelKeyMaterialVersionDestructionWithHttpInfo

      public ApiResponse<MaterialVersionResponse> cancelKeyMaterialVersionDestructionWithHttpInfo(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version) throws ApiException
      Cancel a scheduled version destruction Cancels the scheduled destruction the version belongs to, before the platform runs it: the version's own destruction order, or the destruction of the whole key it was scheduled with, which is cancelled as a whole. Every version of the cancelled order returns to the status it had before the request was approved. A later destruction needs a new request and a new approval.
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      Returns:
      ApiResponse<MaterialVersionResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • cancelKeyMaterialVersionDestructionAsync

      public okhttp3.Call cancelKeyMaterialVersionDestructionAsync(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, ApiCallback<MaterialVersionResponse> _callback) throws ApiException
      Cancel a scheduled version destruction (asynchronously) Cancels the scheduled destruction the version belongs to, before the platform runs it: the version's own destruction order, or the destruction of the whole key it was scheduled with, which is cancelled as a whole. Every version of the cancelled order returns to the status it had before the request was approved. A later destruction needs a new request and a new approval.
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • getKeyMaterialVersionCall

      public okhttp3.Call getKeyMaterialVersionCall(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, ApiCallback _callback) throws ApiException
      Build call for getKeyMaterialVersion
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getKeyMaterialVersion

      public MaterialVersionResponse getKeyMaterialVersion(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version) throws ApiException
      Get a specific material version
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      Returns:
      MaterialVersionResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getKeyMaterialVersionWithHttpInfo

      public ApiResponse<MaterialVersionResponse> getKeyMaterialVersionWithHttpInfo(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version) throws ApiException
      Get a specific material version
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      Returns:
      ApiResponse<MaterialVersionResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getKeyMaterialVersionAsync

      public okhttp3.Call getKeyMaterialVersionAsync(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, ApiCallback<MaterialVersionResponse> _callback) throws ApiException
      Get a specific material version (asynchronously)
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • listKeyMaterialVersionsCall

      public okhttp3.Call listKeyMaterialVersionsCall(@Nonnull UUID tenantId, @Nonnull String stableKid, ApiCallback _callback) throws ApiException
      Build call for listKeyMaterialVersions
      Parameters:
      tenantId - (required)
      stableKid - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listKeyMaterialVersions

      public List<MaterialVersionResponse> listKeyMaterialVersions(@Nonnull UUID tenantId, @Nonnull String stableKid) throws ApiException
      List materials in the lineage (version descending)
      Parameters:
      tenantId - (required)
      stableKid - (required)
      Returns:
      List<MaterialVersionResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listKeyMaterialVersionsWithHttpInfo

      public ApiResponse<List<MaterialVersionResponse>> listKeyMaterialVersionsWithHttpInfo(@Nonnull UUID tenantId, @Nonnull String stableKid) throws ApiException
      List materials in the lineage (version descending)
      Parameters:
      tenantId - (required)
      stableKid - (required)
      Returns:
      ApiResponse<List<MaterialVersionResponse>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listKeyMaterialVersionsAsync

      public okhttp3.Call listKeyMaterialVersionsAsync(@Nonnull UUID tenantId, @Nonnull String stableKid, ApiCallback<List<MaterialVersionResponse>> _callback) throws ApiException
      List materials in the lineage (version descending) (asynchronously)
      Parameters:
      tenantId - (required)
      stableKid - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • markKeyMaterialVersionForDestructionCall

      public okhttp3.Call markKeyMaterialVersionForDestructionCall(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, @Nullable MaterialMarkForDestructionRequest materialMarkForDestructionRequest, ApiCallback _callback) throws ApiException
      Build call for markKeyMaterialVersionForDestruction
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      materialMarkForDestructionRequest - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • markKeyMaterialVersionForDestruction

      public QuorumRequestResponse markKeyMaterialVersionForDestruction(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, @Nullable MaterialMarkForDestructionRequest materialMarkForDestructionRequest) throws ApiException
      Request the destruction of a material version Requests the destruction of one RETIRED, REVOKED or PENDING_PRIMARY material version. The request always waits for the approval of a person other than the requester, whether or not the tenant has a quorum approval policy: the call answers **202 Accepted** with the quorum request, and nothing changes until it is approved. Approval and rejection are made in the Admin Console. On approval the version becomes PENDING_DESTRUCTION and a destruction order is scheduled for the approval instant plus the cooling-off period (`coolingOffDays`, 7 to 365 days; when omitted, the tenant lifecycle policy's `destruction.coolingOffDefaultDays`, else the deployment's, else 30). When the period ends the platform destroys the version on its own. The request is approved for the key's versions as they stood when it was made: a version of the key that changes before the approval ends the request FAILED (`quorum-target-changed`). A version whose destruction would leave the key no version outside a destruction is the destruction of the key: it is requested as the key's destruction request (`KEY_MARK_FOR_DESTRUCTION` on the Key ID), which needs `admin.keys.mark-for-destruction` and an ARCHIVED key.
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      materialMarkForDestructionRequest - (optional)
      Returns:
      QuorumRequestResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • markKeyMaterialVersionForDestructionWithHttpInfo

      public ApiResponse<QuorumRequestResponse> markKeyMaterialVersionForDestructionWithHttpInfo(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, @Nullable MaterialMarkForDestructionRequest materialMarkForDestructionRequest) throws ApiException
      Request the destruction of a material version Requests the destruction of one RETIRED, REVOKED or PENDING_PRIMARY material version. The request always waits for the approval of a person other than the requester, whether or not the tenant has a quorum approval policy: the call answers **202 Accepted** with the quorum request, and nothing changes until it is approved. Approval and rejection are made in the Admin Console. On approval the version becomes PENDING_DESTRUCTION and a destruction order is scheduled for the approval instant plus the cooling-off period (`coolingOffDays`, 7 to 365 days; when omitted, the tenant lifecycle policy's `destruction.coolingOffDefaultDays`, else the deployment's, else 30). When the period ends the platform destroys the version on its own. The request is approved for the key's versions as they stood when it was made: a version of the key that changes before the approval ends the request FAILED (`quorum-target-changed`). A version whose destruction would leave the key no version outside a destruction is the destruction of the key: it is requested as the key's destruction request (`KEY_MARK_FOR_DESTRUCTION` on the Key ID), which needs `admin.keys.mark-for-destruction` and an ARCHIVED key.
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      materialMarkForDestructionRequest - (optional)
      Returns:
      ApiResponse<QuorumRequestResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • markKeyMaterialVersionForDestructionAsync

      public okhttp3.Call markKeyMaterialVersionForDestructionAsync(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, @Nullable MaterialMarkForDestructionRequest materialMarkForDestructionRequest, ApiCallback<QuorumRequestResponse> _callback) throws ApiException
      Request the destruction of a material version (asynchronously) Requests the destruction of one RETIRED, REVOKED or PENDING_PRIMARY material version. The request always waits for the approval of a person other than the requester, whether or not the tenant has a quorum approval policy: the call answers **202 Accepted** with the quorum request, and nothing changes until it is approved. Approval and rejection are made in the Admin Console. On approval the version becomes PENDING_DESTRUCTION and a destruction order is scheduled for the approval instant plus the cooling-off period (`coolingOffDays`, 7 to 365 days; when omitted, the tenant lifecycle policy's `destruction.coolingOffDefaultDays`, else the deployment's, else 30). When the period ends the platform destroys the version on its own. The request is approved for the key's versions as they stood when it was made: a version of the key that changes before the approval ends the request FAILED (`quorum-target-changed`). A version whose destruction would leave the key no version outside a destruction is the destruction of the key: it is requested as the key's destruction request (`KEY_MARK_FOR_DESTRUCTION` on the Key ID), which needs `admin.keys.mark-for-destruction` and an ARCHIVED key.
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      materialMarkForDestructionRequest - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • revokeKeyMaterialVersionCall

      public okhttp3.Call revokeKeyMaterialVersionCall(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, @Nonnull MaterialRevokeRequest materialRevokeRequest, ApiCallback _callback) throws ApiException
      Build call for revokeKeyMaterialVersion
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      materialRevokeRequest - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • revokeKeyMaterialVersion

      public MaterialVersionResponse revokeKeyMaterialVersion(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, @Nonnull MaterialRevokeRequest materialRevokeRequest) throws ApiException
      Revoke a single material version Allowed only when material status is RETIRED or PENDING_PRIMARY. Revoking a PRIMARY material directly is blocked with 422 `material-status-invalid-transition`; rotate or revoke the Stable KID first.
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      materialRevokeRequest - (required)
      Returns:
      MaterialVersionResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • revokeKeyMaterialVersionWithHttpInfo

      public ApiResponse<MaterialVersionResponse> revokeKeyMaterialVersionWithHttpInfo(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, @Nonnull MaterialRevokeRequest materialRevokeRequest) throws ApiException
      Revoke a single material version Allowed only when material status is RETIRED or PENDING_PRIMARY. Revoking a PRIMARY material directly is blocked with 422 `material-status-invalid-transition`; rotate or revoke the Stable KID first.
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      materialRevokeRequest - (required)
      Returns:
      ApiResponse<MaterialVersionResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • revokeKeyMaterialVersionAsync

      public okhttp3.Call revokeKeyMaterialVersionAsync(@Nonnull UUID tenantId, @Nonnull String stableKid, @Nonnull Integer version, @Nonnull MaterialRevokeRequest materialRevokeRequest, ApiCallback<MaterialVersionResponse> _callback) throws ApiException
      Revoke a single material version (asynchronously) Allowed only when material status is RETIRED or PENDING_PRIMARY. Revoking a PRIMARY material directly is blocked with 422 `material-status-invalid-transition`; rotate or revoke the Stable KID first.
      Parameters:
      tenantId - (required)
      stableKid - (required)
      version - (required)
      materialRevokeRequest - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object