Class IdentityProviderKeysApi

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-09-23T16:19:57.008753975Z[Etc/UTC]", comments="Generator version: 7.8.0") public class IdentityProviderKeysApi extends Object
  • Constructor Details

    • IdentityProviderKeysApi

      public IdentityProviderKeysApi()
    • IdentityProviderKeysApi

      public IdentityProviderKeysApi(ApiClient apiClient)
  • Method Details

    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • createIdentityProviderKey

      public IdPKeyCredential createIdentityProviderKey(IdPCertificateCredential jsonWebKey) throws ApiException
      Create an IdP Key Credential Creates a new X.509 certificate credential in the IdP key store > **Note:** RSA-based certificates are supported for all IdP types. Okta currently supports EC-based certificates only for the `X509` IdP type. For EC-based certificates we support only P-256, P-384, and P-521 curves.
      Parameters:
      jsonWebKey - (required)
      Returns:
      IdPKeyCredential
      Throws:
      ApiException - if fails to make API call
    • createIdentityProviderKey

      public IdPKeyCredential createIdentityProviderKey(IdPCertificateCredential jsonWebKey, Map<String,String> additionalHeaders) throws ApiException
      Create an IdP Key Credential Creates a new X.509 certificate credential in the IdP key store > **Note:** RSA-based certificates are supported for all IdP types. Okta currently supports EC-based certificates only for the `X509` IdP type. For EC-based certificates we support only P-256, P-384, and P-521 curves.
      Parameters:
      jsonWebKey - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdPKeyCredential
      Throws:
      ApiException - if fails to make API call
    • deleteIdentityProviderKey

      public void deleteIdentityProviderKey(String kid) throws ApiException
      Delete an IdP Key Credential Deletes a specific IdP Key Credential by `kid` if it isn't currently being used by an active or inactive IdP
      Parameters:
      kid - Unique `id` of the IdP Key Credential (required)
      Throws:
      ApiException - if fails to make API call
    • deleteIdentityProviderKey

      public void deleteIdentityProviderKey(String kid, Map<String,String> additionalHeaders) throws ApiException
      Delete an IdP Key Credential Deletes a specific IdP Key Credential by `kid` if it isn't currently being used by an active or inactive IdP
      Parameters:
      kid - Unique `id` of the IdP Key Credential (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • getIdentityProviderKey

      public IdPKeyCredential getIdentityProviderKey(String kid) throws ApiException
      Retrieve an IdP Key Credential Retrieves a specific IdP Key Credential by `kid`
      Parameters:
      kid - Unique `id` of the IdP Key Credential (required)
      Returns:
      IdPKeyCredential
      Throws:
      ApiException - if fails to make API call
    • getIdentityProviderKey

      public IdPKeyCredential getIdentityProviderKey(String kid, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an IdP Key Credential Retrieves a specific IdP Key Credential by `kid`
      Parameters:
      kid - Unique `id` of the IdP Key Credential (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdPKeyCredential
      Throws:
      ApiException - if fails to make API call
    • listIdentityProviderKeys

      public List<IdPKeyCredential> listIdentityProviderKeys(String after, Integer limit) throws ApiException
      List all IdP Key Credentials Lists all IdP Key Credentials
      Parameters:
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      Returns:
      List<IdPKeyCredential>
      Throws:
      ApiException - if fails to make API call
    • listIdentityProviderKeys

      public List<IdPKeyCredential> listIdentityProviderKeys(String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all IdP Key Credentials Lists all IdP Key Credentials
      Parameters:
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<IdPKeyCredential>
      Throws:
      ApiException - if fails to make API call
    • replaceIdentityProviderKey

      public IdPKeyCredential replaceIdentityProviderKey(String kid, IdPKeyCredential idPKeyCredential) throws ApiException
      Replace an IdP Key Credential Replaces an IdP Key Credential by `kid`
      Parameters:
      kid - Unique `id` of the IdP Key Credential (required)
      idPKeyCredential - Updated IdP Key Credential (required)
      Returns:
      IdPKeyCredential
      Throws:
      ApiException - if fails to make API call
    • replaceIdentityProviderKey

      public IdPKeyCredential replaceIdentityProviderKey(String kid, IdPKeyCredential idPKeyCredential, Map<String,String> additionalHeaders) throws ApiException
      Replace an IdP Key Credential Replaces an IdP Key Credential by `kid`
      Parameters:
      kid - Unique `id` of the IdP Key Credential (required)
      idPKeyCredential - Updated IdP Key Credential (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdPKeyCredential
      Throws:
      ApiException - if fails to make API call
    • getObjectMapper

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