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-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.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 `?expand=publickey` query parameter optionally returns the full object including the details of the public key in the response body's `_embedded` property.
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 `?expand=publickey` query parameter optionally returns the full object including the details of the public key in the response body's `_embedded` property.
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
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.

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.

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

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()