Class ApplicationCredentialsApi

java.lang.Object
com.okta.sdk.resource.api.ApplicationCredentialsApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-29T16:47:02.065887-05:00[America/Chicago]", comments="Generator version: 7.4.0") public class ApplicationCredentialsApi extends Object
  • Constructor Details

    • ApplicationCredentialsApi

      public ApplicationCredentialsApi()
    • ApplicationCredentialsApi

      public ApplicationCredentialsApi(ApiClient apiClient)
  • Method Details

    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • cloneApplicationKey

      public JsonWebKey cloneApplicationKey(String appId, String keyId, String targetAid) throws ApiException
      Clone a Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.
      Parameters:
      appId - ID of the Application (required)
      keyId - ID of the Key Credential for the application (required)
      targetAid - Unique key of the target Application (required)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call
    • cloneApplicationKey

      public JsonWebKey cloneApplicationKey(String appId, String keyId, String targetAid, Map<String,String> additionalHeaders) throws ApiException
      Clone a Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.
      Parameters:
      appId - ID of the Application (required)
      keyId - ID of the Key Credential for the application (required)
      targetAid - Unique key of the target Application (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call
    • generateApplicationKey

      public JsonWebKey generateApplicationKey(String appId, Integer validityYears) throws ApiException
      Generate a Key Credential Generates a new X.509 certificate for an application key credential
      Parameters:
      appId - ID of the Application (required)
      validityYears - (optional)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call
    • generateApplicationKey

      public JsonWebKey generateApplicationKey(String appId, Integer validityYears, Map<String,String> additionalHeaders) throws ApiException
      Generate a Key Credential Generates a new X.509 certificate for an application key credential
      Parameters:
      appId - ID of the Application (required)
      validityYears - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call
    • generateCsrForApplication

      public Csr generateCsrForApplication(String appId, CsrMetadata metadata) throws ApiException
      Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request for it
      Parameters:
      appId - ID of the Application (required)
      metadata - (required)
      Returns:
      Csr
      Throws:
      ApiException - if fails to make API call
    • generateCsrForApplication

      public Csr generateCsrForApplication(String appId, CsrMetadata metadata, Map<String,String> additionalHeaders) throws ApiException
      Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request for it
      Parameters:
      appId - ID of the Application (required)
      metadata - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Csr
      Throws:
      ApiException - if fails to make API call
    • getApplicationKey

      public JsonWebKey getApplicationKey(String appId, String keyId) throws ApiException
      Retrieve a Key Credential Retrieves a specific application key credential by kid
      Parameters:
      appId - ID of the Application (required)
      keyId - ID of the Key Credential for the application (required)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call
    • getApplicationKey

      public JsonWebKey getApplicationKey(String appId, String keyId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a Key Credential Retrieves a specific application key credential by kid
      Parameters:
      appId - ID of the Application (required)
      keyId - ID of the Key Credential for the application (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call
    • getCsrForApplication

      public Csr getCsrForApplication(String appId, String csrId) throws ApiException
      Retrieve a Certificate Signing Request Retrieves a certificate signing request for the app by `id`
      Parameters:
      appId - ID of the Application (required)
      csrId - `id` of the CSR (required)
      Returns:
      Csr
      Throws:
      ApiException - if fails to make API call
    • getCsrForApplication

      public Csr getCsrForApplication(String appId, String csrId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a Certificate Signing Request Retrieves a certificate signing request for the app by `id`
      Parameters:
      appId - ID of the Application (required)
      csrId - `id` of the CSR (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Csr
      Throws:
      ApiException - if fails to make API call
    • listApplicationKeys

      public List<JsonWebKey> listApplicationKeys(String appId) throws ApiException
      List all Key Credentials Lists all key credentials for an application
      Parameters:
      appId - ID of the Application (required)
      Returns:
      List<JsonWebKey>
      Throws:
      ApiException - if fails to make API call
    • listApplicationKeys

      public List<JsonWebKey> listApplicationKeys(String appId, Map<String,String> additionalHeaders) throws ApiException
      List all Key Credentials Lists all key credentials for an application
      Parameters:
      appId - ID of the Application (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<JsonWebKey>
      Throws:
      ApiException - if fails to make API call
    • listCsrsForApplication

      public List<Csr> listCsrsForApplication(String appId) throws ApiException
      List all Certificate Signing Requests Lists all Certificate Signing Requests for an application
      Parameters:
      appId - ID of the Application (required)
      Returns:
      List<Csr>
      Throws:
      ApiException - if fails to make API call
    • listCsrsForApplication

      public List<Csr> listCsrsForApplication(String appId, Map<String,String> additionalHeaders) throws ApiException
      List all Certificate Signing Requests Lists all Certificate Signing Requests for an application
      Parameters:
      appId - ID of the Application (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<Csr>
      Throws:
      ApiException - if fails to make API call
    • publishCsrFromApplication

      public JsonWebKey publishCsrFromApplication(String appId, String csrId, File body) throws ApiException
      Publish a Certificate Signing Request Publishes a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentials
      Parameters:
      appId - ID of the Application (required)
      csrId - `id` of the CSR (required)
      body - (required)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call
    • publishCsrFromApplication

      public JsonWebKey publishCsrFromApplication(String appId, String csrId, File body, Map<String,String> additionalHeaders) throws ApiException
      Publish a Certificate Signing Request Publishes a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentials
      Parameters:
      appId - ID of the Application (required)
      csrId - `id` of the CSR (required)
      body - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call
    • revokeCsrFromApplication

      public void revokeCsrFromApplication(String appId, String csrId) throws ApiException
      Revoke a Certificate Signing Request Revokes a certificate signing request and deletes the key pair from the application
      Parameters:
      appId - ID of the Application (required)
      csrId - `id` of the CSR (required)
      Throws:
      ApiException - if fails to make API call
    • revokeCsrFromApplication

      public void revokeCsrFromApplication(String appId, String csrId, Map<String,String> additionalHeaders) throws ApiException
      Revoke a Certificate Signing Request Revokes a certificate signing request and deletes the key pair from the application
      Parameters:
      appId - ID of the Application (required)
      csrId - `id` of the CSR (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()