Package com.okta.sdk.resource.api

Class ApplicationSsoCredentialKeyApi

java.lang.Object
com.okta.sdk.resource.api.ApplicationSsoCredentialKeyApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-09-23T08:35:59.300824-05:00[America/Chicago]", comments="Generator version: 7.8.0") public class ApplicationSsoCredentialKeyApi extends Object

  • Constructor Details

    • ApplicationSsoCredentialKeyApi

      public ApplicationSsoCredentialKeyApi()

    • ApplicationSsoCredentialKeyApi

      public ApplicationSsoCredentialKeyApi(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 an X.509 certificate for an Application Key Credential from a source app to a target app. For step-by-step instructions to clone a credential, see [Share application key credentials for IdPs across apps](https://developer.okta.com/docs/guides/sharing-cert/main/). > **Note:** Sharing certificates isn't a recommended security practice.
      Parameters:
      appId - Application ID (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 an X.509 certificate for an Application Key Credential from a source app to a target app. For step-by-step instructions to clone a credential, see [Share application key credentials for IdPs across apps](https://developer.okta.com/docs/guides/sharing-cert/main/). > **Note:** Sharing certificates isn't a recommended security practice.
      Parameters:
      appId - Application ID (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 app key credential > **Note:** To update an Application with the newly generated key credential, use the [Replace an Application](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication) request with the new [credentials.signing.kid](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication!path=4/credentials/signing/kid&t=request) value in the request body. You can provide just the [Signing Credential object](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication!path=4/credentials/signing&t=request) instead of the entire [Application Credential object](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication!path=4/credentials&t=request).
      Parameters:
      appId - Application ID (required)
      validityYears - Expiry years of the Application Key Credential (required)
      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 app key credential > **Note:** To update an Application with the newly generated key credential, use the [Replace an Application](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication) request with the new [credentials.signing.kid](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication!path=4/credentials/signing/kid&t=request) value in the request body. You can provide just the [Signing Credential object](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication!path=4/credentials/signing&t=request) instead of the entire [Application Credential object](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication!path=4/credentials&t=request).
      Parameters:
      appId - Application ID (required)
      validityYears - Expiry years of the Application Key Credential (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • generateCsrForApplication

      public String generateCsrForApplication(String appId, CsrMetadata metadata) throws ApiException
      Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request(CSR) for it. The information in a CSR is used by the Certificate Authority (CA) to verify and create your certificate. It also contains the public key that is included in your certificate. Returns CSR in `pkcs#10` format if the `Accept` media type is `application/pkcs10` or a CSR object if the `Accept` media type is `application/json`. > **Note:** The key pair isn't listed in the Key Credentials for the app until it's published.
      Parameters:
      appId - Application ID (required)
      metadata - (required)
      Returns:
      String
      Throws:
      ApiException - if fails to make API call

    • generateCsrForApplication

      public String 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(CSR) for it. The information in a CSR is used by the Certificate Authority (CA) to verify and create your certificate. It also contains the public key that is included in your certificate. Returns CSR in `pkcs#10` format if the `Accept` media type is `application/pkcs10` or a CSR object if the `Accept` media type is `application/json`. > **Note:** The key pair isn't listed in the Key Credentials for the app until it's published.
      Parameters:
      appId - Application ID (required)
      metadata - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      String
      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 - Application ID (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 - Application ID (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 (CSR) for the app by `csrId`. Returns a Base64-encoded CSR in DER format if the `Accept` media type is `application/pkcs10` or a CSR object if the `Accept` media type is `application/json`.
      Parameters:
      appId - Application ID (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 (CSR) for the app by `csrId`. Returns a Base64-encoded CSR in DER format if the `Accept` media type is `application/pkcs10` or a CSR object if the `Accept` media type is `application/json`.
      Parameters:
      appId - Application ID (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 app
      Parameters:
      appId - Application ID (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 app
      Parameters:
      appId - Application ID (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 - Application ID (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 - Application ID (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 (CSR) for the app with a signed X.509 certificate and adds it into the Application Key Credentials. > **Note:** Publishing a certificate completes the lifecycle of the CSR and it's no longer accessible.
      Parameters:
      appId - Application ID (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 (CSR) for the app with a signed X.509 certificate and adds it into the Application Key Credentials. > **Note:** Publishing a certificate completes the lifecycle of the CSR and it's no longer accessible.
      Parameters:
      appId - Application ID (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 app
      Parameters:
      appId - Application ID (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 app
      Parameters:
      appId - Application ID (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()