com.okta.sdk.resource.api.HookKeyApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]", comments="Generator version: 7.15.0") public class HookKeyApi extends Object

Constructor Summary

Constructors

Constructor

Description

HookKeyApi()

HookKeyApi(ApiClient apiClient)
Method Summary

Modifier and Type

Method

Description

DetailedHookKeyInstance

createHookKey(KeyRequest keyRequest)

Create a key Creates a key for use with other parts of the application, such as inline hooks > **Note:** Use the key name to access this key for inline hook operations.

DetailedHookKeyInstance

createHookKey(KeyRequest keyRequest, Map<String,String> additionalHeaders)

Create a key Creates a key for use with other parts of the application, such as inline hooks > **Note:** Use the key name to access this key for inline hook operations.

void

deleteHookKey(String id)

Delete a key Deletes a key by `id`.

void

deleteHookKey(String id, Map<String,String> additionalHeaders)

Delete a key Deletes a key by `id`.

ApiClient

getApiClient()

HookKey

getHookKey(String id)

Retrieve a key by ID Retrieves the public portion of the Key object using the `id` parameter >**Note:** The `?

HookKey

getHookKey(String id, Map<String,String> additionalHeaders)

Retrieve a key by ID Retrieves the public portion of the Key object using the `id` parameter >**Note:** The `?

protected static com.fasterxml.jackson.databind.ObjectMapper

getObjectMapper()

Embedded

getPublicKey(String keyId)

Retrieve a public key Retrieves a public key by `keyId` >**Note:** keyId is the alias of the public key.

Embedded

getPublicKey(String keyId, Map<String,String> additionalHeaders)

Retrieve a public key Retrieves a public key by `keyId` >**Note:** keyId is the alias of the public key.

List<HookKey>

listHookKeys()

List all keys Lists all keys

List<HookKey>

listHookKeys(Map<String,String> additionalHeaders)

List all keys Lists all keys

Iterable<HookKey>

listHookKeysPaged()

List all keys (Paginated) Lists all keys This method returns a lazy, paginated iterable that automatically handles pagination.

Iterable<HookKey>

listHookKeysPaged(Map<String,String> additionalHeaders)

List all keys (Paginated with additional headers) Lists all keys This method returns a lazy, paginated iterable that automatically handles pagination.

DetailedHookKeyInstance

replaceHookKey(String id, KeyRequest keyRequest)

Replace a key Replaces a key by `id` This request replaces existing properties after passing validation.

DetailedHookKeyInstance

replaceHookKey(String id, KeyRequest keyRequest, Map<String,String> additionalHeaders)

Replace a key Replaces a key by `id` This request replaces existing properties after passing validation.

void

setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- HookKeyApi
  
  public HookKeyApi()
- HookKeyApi
  
  public HookKeyApi(ApiClient apiClient)
Method Details
- getApiClient
  
  public ApiClient getApiClient()
- setApiClient
  
  public void setApiClient(ApiClient apiClient)
- createHookKey
  
  public DetailedHookKeyInstance createHookKey(KeyRequest keyRequest) throws ApiException
  
  Create a key Creates a key for use with other parts of the application, such as inline hooks > **Note:** 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. The response is a [Key object](https://developer.okta.com/docs/reference/api/hook-keys/#key-object) that represents the key that you create. The `id` property in the response serves as the unique ID for the key, which you can specify when invoking other CRUD operations. The `keyId` provided in the response is the alias of the public key that you can use to get details of the public key data in a separate call. > **Note:** The keyId is the alias of the public key that you can use to retrieve the public key.
  
  Parameters:
  
  keyRequest - (required)
  
  Returns:
  
  DetailedHookKeyInstance
  
  Throws:
  
  ApiException - if fails to make API call
- createHookKey
  
  public DetailedHookKeyInstance 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 > **Note:** 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. The response is a [Key object](https://developer.okta.com/docs/reference/api/hook-keys/#key-object) that represents the key that you create. The `id` property in the response serves as the unique ID for the key, which you can specify when invoking other CRUD operations. The `keyId` provided in the response is the alias of the public key that you can use to get details of the public key data in a separate call. > **Note:** The keyId is the alias of the public key that you can use to retrieve the public key.
  
  Parameters:
  
  keyRequest - (required)
  
  additionalHeaders - additionalHeaders for this call
  
  Returns:
  
  DetailedHookKeyInstance
  
  Throws:
  
  ApiException - if fails to make API call
- deleteHookKey
  
  public void deleteHookKey(String id) throws ApiException
  
  Delete a key Deletes a key by `id`. After being deleted, the key is unrecoverable. As a safety precaution, only keys that aren't being used are eligible for deletion.
  
  Parameters:
  
  id - ID of the Hook Key (required)
  
  Throws:
  
  ApiException - if fails to make API call
- deleteHookKey
  
  public void deleteHookKey(String id, Map<String,String> additionalHeaders) throws ApiException
  
  Delete a key Deletes a key by `id`. After being deleted, the key is unrecoverable. As a safety precaution, only keys that aren't being used are eligible for deletion.
  
  Parameters:
  
  id - ID of the Hook Key (required)
  
  additionalHeaders - additionalHeaders for this call
  
  Throws:
  
  ApiException - if fails to make API call
- getHookKey
  
  public HookKey getHookKey(String id) throws ApiException
  
  Retrieve a key by ID Retrieves the public portion of the Key object using the `id` parameter >**Note:** The `?expand=publickey` query parameter optionally returns the full object including the details of the public key in the response body's `_embedded` property.
  
  Parameters:
  
  id - ID of the Hook Key (required)
  
  Returns:
  
  HookKey
  
  Throws:
  
  ApiException - if fails to make API call
- getHookKey
  
  public HookKey getHookKey(String id, Map<String,String> additionalHeaders) throws ApiException
  
  Retrieve a key by ID Retrieves the public portion of the Key object using the `id` parameter >**Note:** The `?expand=publickey` query parameter optionally returns the full object including the details of the public key in the response body's `_embedded` property.
  
  Parameters:
  
  id - ID of the Hook Key (required)
  
  additionalHeaders - additionalHeaders for this call
  
  Returns:
  
  HookKey
  
  Throws:
  
  ApiException - if fails to make API call
- getPublicKey
  
  public Embedded getPublicKey(String keyId) throws ApiException
  
  Retrieve a public key Retrieves a public key by `keyId` >**Note:** keyId is the alias of the public key.
  
  Parameters:
  
  keyId - id\" of the Public Key (required)
  
  Returns:
  
  Embedded
  
  Throws:
  
  ApiException - if fails to make API call
- getPublicKey
  
  public Embedded getPublicKey(String keyId, Map<String,String> additionalHeaders) throws ApiException
  
  Retrieve a public key Retrieves a public key by `keyId` >**Note:** keyId is the alias of the public key.
  
  Parameters:
  
  keyId - id\" of the Public Key (required)
  
  additionalHeaders - additionalHeaders for this call
  
  Returns:
  
  Embedded
  
  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
- listHookKeysPaged
  
  public Iterable<HookKey> listHookKeysPaged()
  
  List all keys (Paginated) Lists all keys This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
  
  Returns:
  
  Iterable<HookKey> lazy iterable over all pages
- listHookKeysPaged
  
  public Iterable<HookKey> listHookKeysPaged(Map<String,String> additionalHeaders)
  
  List all keys (Paginated with additional headers) Lists all keys This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
  
  Parameters:
  
  additionalHeaders - additional headers for this call
  
  Returns:
  
  Iterable<HookKey> lazy iterable over all pages
- replaceHookKey
  
  public DetailedHookKeyInstance replaceHookKey(String id, KeyRequest keyRequest) throws ApiException
  
  Replace a key Replaces a key by `id` 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:
  
  id - ID of the Hook Key (required)
  
  keyRequest - (required)
  
  Returns:
  
  DetailedHookKeyInstance
  
  Throws:
  
  ApiException - if fails to make API call
- replaceHookKey
  
  public DetailedHookKeyInstance replaceHookKey(String id, KeyRequest keyRequest, Map<String,String> additionalHeaders) throws ApiException
  
  Replace a key Replaces a key by `id` 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:
  
  id - ID of the Hook Key (required)
  
  keyRequest - (required)
  
  additionalHeaders - additionalHeaders for this call
  
  Returns:
  
  DetailedHookKeyInstance
  
  Throws:
  
  ApiException - if fails to make API call
- getObjectMapper
  
  protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Class HookKeyApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

HookKeyApi

HookKeyApi

Method Details

getApiClient

setApiClient

createHookKey

createHookKey

deleteHookKey

deleteHookKey

getHookKey

getHookKey

getPublicKey

getPublicKey

listHookKeys

listHookKeys

listHookKeysPaged

listHookKeysPaged

replaceHookKey

replaceHookKey

getObjectMapper