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

Class TenantApplicationsApi

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

  • Constructor Details

    • TenantApplicationsApi

      public TenantApplicationsApi()

    • TenantApplicationsApi

      public TenantApplicationsApi(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)

    • createKeyCall

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

    • createKey

      public OrchestrationKeyResponse createKey(@Nonnull UUID tenantId, @Nonnull OrchestrationKeyRequest orchestrationKeyRequest) throws ApiException
      Create a cryptographic key Creates a cryptographic key in the tenant's keystore. Workflow: 1. Validates the caller's tenant boundary 2. Calls the cryptographic service to create the cryptographic key (S2S) 3. Returns the created key's identity, algorithm and lifecycle status Authorization is a SEPARATE concern and is not granted here: issue and read access to the key through the Capability Grant endpoints, or compose an Internal Crypto Use Case over the returned `kid`. The endpoint grants nothing and names no application. Available in every tenant type. A SIMPLE tenant creates keys through exactly this endpoint: its Internal Crypto Use Cases are an authorization overlay over keys that already exist, so key creation is the one key-plane operation a SIMPLE tenant must be able to perform for itself. Error handling: - If key creation fails, the entire operation is aborted (404, 409, 504 returned)
      Parameters:
      tenantId - (required)
      orchestrationKeyRequest - (required)
      Returns:
      OrchestrationKeyResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createKeyWithHttpInfo

      public ApiResponse<OrchestrationKeyResponse> createKeyWithHttpInfo(@Nonnull UUID tenantId, @Nonnull OrchestrationKeyRequest orchestrationKeyRequest) throws ApiException
      Create a cryptographic key Creates a cryptographic key in the tenant's keystore. Workflow: 1. Validates the caller's tenant boundary 2. Calls the cryptographic service to create the cryptographic key (S2S) 3. Returns the created key's identity, algorithm and lifecycle status Authorization is a SEPARATE concern and is not granted here: issue and read access to the key through the Capability Grant endpoints, or compose an Internal Crypto Use Case over the returned `kid`. The endpoint grants nothing and names no application. Available in every tenant type. A SIMPLE tenant creates keys through exactly this endpoint: its Internal Crypto Use Cases are an authorization overlay over keys that already exist, so key creation is the one key-plane operation a SIMPLE tenant must be able to perform for itself. Error handling: - If key creation fails, the entire operation is aborted (404, 409, 504 returned)
      Parameters:
      tenantId - (required)
      orchestrationKeyRequest - (required)
      Returns:
      ApiResponse<OrchestrationKeyResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createKeyAsync

      public okhttp3.Call createKeyAsync(@Nonnull UUID tenantId, @Nonnull OrchestrationKeyRequest orchestrationKeyRequest, ApiCallback<OrchestrationKeyResponse> _callback) throws ApiException
      Create a cryptographic key (asynchronously) Creates a cryptographic key in the tenant's keystore. Workflow: 1. Validates the caller's tenant boundary 2. Calls the cryptographic service to create the cryptographic key (S2S) 3. Returns the created key's identity, algorithm and lifecycle status Authorization is a SEPARATE concern and is not granted here: issue and read access to the key through the Capability Grant endpoints, or compose an Internal Crypto Use Case over the returned `kid`. The endpoint grants nothing and names no application. Available in every tenant type. A SIMPLE tenant creates keys through exactly this endpoint: its Internal Crypto Use Cases are an authorization overlay over keys that already exist, so key creation is the one key-plane operation a SIMPLE tenant must be able to perform for itself. Error handling: - If key creation fails, the entire operation is aborted (404, 409, 504 returned)
      Parameters:
      tenantId - (required)
      orchestrationKeyRequest - (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

    • getApplicationCall

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

    • getApplication

      public ApplicationResponse getApplication(@Nonnull UUID tenantId, @Nonnull UUID applicationId) throws ApiException
      Get application details Returns the stored record of one live application of the tenant: identity, lifecycle, business identity, ownership (including the owner's and the technical contact's e-mail addresses), risk classification and metadata. A value never entered is `null`; `environment`, `dataClassification` and `riskLevel` are never null. The record never carries `defaultActorId`. **Authorization**: requires scope `admin.tenant.application.read`, for the caller's own tenant.
      Parameters:
      tenantId - (required)
      applicationId - (required)
      Returns:
      ApplicationResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getApplicationWithHttpInfo

      public ApiResponse<ApplicationResponse> getApplicationWithHttpInfo(@Nonnull UUID tenantId, @Nonnull UUID applicationId) throws ApiException
      Get application details Returns the stored record of one live application of the tenant: identity, lifecycle, business identity, ownership (including the owner's and the technical contact's e-mail addresses), risk classification and metadata. A value never entered is `null`; `environment`, `dataClassification` and `riskLevel` are never null. The record never carries `defaultActorId`. **Authorization**: requires scope `admin.tenant.application.read`, for the caller's own tenant.
      Parameters:
      tenantId - (required)
      applicationId - (required)
      Returns:
      ApiResponse<ApplicationResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getApplicationAsync

      public okhttp3.Call getApplicationAsync(@Nonnull UUID tenantId, @Nonnull UUID applicationId, ApiCallback<ApplicationResponse> _callback) throws ApiException
      Get application details (asynchronously) Returns the stored record of one live application of the tenant: identity, lifecycle, business identity, ownership (including the owner's and the technical contact's e-mail addresses), risk classification and metadata. A value never entered is `null`; `environment`, `dataClassification` and `riskLevel` are never null. The record never carries `defaultActorId`. **Authorization**: requires scope `admin.tenant.application.read`, for the caller's own tenant.
      Parameters:
      tenantId - (required)
      applicationId - (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

    • listApplicationsCall

      public okhttp3.Call listApplicationsCall(@Nonnull UUID tenantId, @Nullable Integer page, @Nullable Integer size, @Nullable List<String> sort, ApiCallback _callback) throws ApiException
      Build call for listApplications
      Parameters:
      tenantId - (required)
      page - Zero-based page index (0..N) (optional, default to 0)
      size - The size of the page to be returned (optional, default to 25)
      sort - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listApplications

      public PageApplicationResponse listApplications(@Nonnull UUID tenantId, @Nullable Integer page, @Nullable Integer size, @Nullable List<String> sort) throws ApiException
      List applications (paginated) Returns a paginated view of machine-to-machine applications registered under the tenant. **Response shape**: a paged envelope of application records (`PageApplicationResponse`) with `content`, `totalElements`, `totalPages`, `number` (zero-based), `size`, and the standard pagination flags. Each row is the full record `getApplication` answers: identity, lifecycle, business identity, ownership, risk classification and metadata, a value never entered being `null`. A row never carries `defaultActorId`. **Pagination**: server-side. Default `size=25`, default sort `name,asc`. Max `size=200` (rejected with 400 above). Sort fields allow-list: `createdAt`, `name`, `status`. Any other sort field returns 400. **Authorization**: requires scope `admin.tenant.application.list`.
      Parameters:
      tenantId - (required)
      page - Zero-based page index (0..N) (optional, default to 0)
      size - The size of the page to be returned (optional, default to 25)
      sort - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)
      Returns:
      PageApplicationResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listApplicationsWithHttpInfo

      public ApiResponse<PageApplicationResponse> listApplicationsWithHttpInfo(@Nonnull UUID tenantId, @Nullable Integer page, @Nullable Integer size, @Nullable List<String> sort) throws ApiException
      List applications (paginated) Returns a paginated view of machine-to-machine applications registered under the tenant. **Response shape**: a paged envelope of application records (`PageApplicationResponse`) with `content`, `totalElements`, `totalPages`, `number` (zero-based), `size`, and the standard pagination flags. Each row is the full record `getApplication` answers: identity, lifecycle, business identity, ownership, risk classification and metadata, a value never entered being `null`. A row never carries `defaultActorId`. **Pagination**: server-side. Default `size=25`, default sort `name,asc`. Max `size=200` (rejected with 400 above). Sort fields allow-list: `createdAt`, `name`, `status`. Any other sort field returns 400. **Authorization**: requires scope `admin.tenant.application.list`.
      Parameters:
      tenantId - (required)
      page - Zero-based page index (0..N) (optional, default to 0)
      size - The size of the page to be returned (optional, default to 25)
      sort - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)
      Returns:
      ApiResponse<PageApplicationResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listApplicationsAsync

      public okhttp3.Call listApplicationsAsync(@Nonnull UUID tenantId, @Nullable Integer page, @Nullable Integer size, @Nullable List<String> sort, ApiCallback<PageApplicationResponse> _callback) throws ApiException
      List applications (paginated) (asynchronously) Returns a paginated view of machine-to-machine applications registered under the tenant. **Response shape**: a paged envelope of application records (`PageApplicationResponse`) with `content`, `totalElements`, `totalPages`, `number` (zero-based), `size`, and the standard pagination flags. Each row is the full record `getApplication` answers: identity, lifecycle, business identity, ownership, risk classification and metadata, a value never entered being `null`. A row never carries `defaultActorId`. **Pagination**: server-side. Default `size=25`, default sort `name,asc`. Max `size=200` (rejected with 400 above). Sort fields allow-list: `createdAt`, `name`, `status`. Any other sort field returns 400. **Authorization**: requires scope `admin.tenant.application.list`.
      Parameters:
      tenantId - (required)
      page - Zero-based page index (0..N) (optional, default to 0)
      size - The size of the page to be returned (optional, default to 25)
      sort - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (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