Package com.okta.sdk.resource.api

Class HookKeyApi

java.lang.Object
com.okta.sdk.resource.api.HookKeyApi
@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 HookKeyApi extends Object

  • Constructor Details

    • HookKeyApi

      public HookKeyApi()

    • HookKeyApi

      public HookKeyApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createHookKey

      public HookKey createHookKey(KeyRequest keyRequest) throws ApiException
      Create a key Creates a key for use with other parts of the application, such as inline hooks Use the key name to access this key for inline hook operations. The total number of keys that you can create in an Okta org is limited to 50.
      Parameters:
      keyRequest - (required)
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • createHookKey

      public HookKey createHookKey(KeyRequest keyRequest, Map<String,String> additionalHeaders) throws ApiException
      Create a key Creates a key for use with other parts of the application, such as inline hooks Use the key name to access this key for inline hook operations. The total number of keys that you can create in an Okta org is limited to 50.
      Parameters:
      keyRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • deleteHookKey

      public void deleteHookKey(String hookKeyId) throws ApiException
      Delete a key Deletes a key by `hookKeyId`. After being deleted, the key is unrecoverable. As a safety precaution, only keys that aren't being used are eligible for deletion.
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      Throws:
      ApiException - if fails to make API call

    • deleteHookKey

      public void deleteHookKey(String hookKeyId, Map<String,String> additionalHeaders) throws ApiException
      Delete a key Deletes a key by `hookKeyId`. After being deleted, the key is unrecoverable. As a safety precaution, only keys that aren't being used are eligible for deletion.
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getHookKey

      public HookKey getHookKey(String hookKeyId) throws ApiException
      Retrieve a key Retrieves a key by `hookKeyId`
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • getHookKey

      public HookKey getHookKey(String hookKeyId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a key Retrieves a key by `hookKeyId`
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • getPublicKey

      public JsonWebKey getPublicKey(String publicKeyId) throws ApiException
      Retrieve a public key Retrieves a public key by `keyId`
      Parameters:
      publicKeyId - `id` of the Public Key (required)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • getPublicKey

      public JsonWebKey getPublicKey(String publicKeyId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a public key Retrieves a public key by `keyId`
      Parameters:
      publicKeyId - `id` of the Public Key (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • listHookKeys

      public List<HookKey> listHookKeys() throws ApiException
      List all keys Lists all keys
      Returns:
      List<HookKey>
      Throws:
      ApiException - if fails to make API call

    • listHookKeys

      public List<HookKey> listHookKeys(Map<String,String> additionalHeaders) throws ApiException
      List all keys Lists all keys
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<HookKey>
      Throws:
      ApiException - if fails to make API call

    • replaceHookKey

      public HookKey replaceHookKey(String hookKeyId, KeyRequest keyRequest) throws ApiException
      Replace a key Replaces a key by `hookKeyId` This request replaces existing properties after passing validation. Note: The only parameter that you can update is the name of the key, which must be unique at all times.
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      keyRequest - (required)
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • replaceHookKey

      public HookKey replaceHookKey(String hookKeyId, KeyRequest keyRequest, Map<String,String> additionalHeaders) throws ApiException
      Replace a key Replaces a key by `hookKeyId` This request replaces existing properties after passing validation. Note: The only parameter that you can update is the name of the key, which must be unique at all times.
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      keyRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

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