Package com.okta.sdk.resource.api

Class InlineHookApi

java.lang.Object

com.okta.sdk.resource.api.InlineHookApi

@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 InlineHookApi
extends Object

Constructor Summary

Constructors

Constructor	Description
InlineHookApi()
InlineHookApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
InlineHook	activateInlineHook(String inlineHookId)	Activate an inline hook Activates the inline hook by `inlineHookId`
InlineHook	activateInlineHook(String inlineHookId, Map<String,String> additionalHeaders)	Activate an inline hook Activates the inline hook by `inlineHookId`
InlineHookCreateResponse	createInlineHook(InlineHookCreate inlineHookCreate)	Create an inline hook Creates an inline hook This endpoint creates an inline hook for your org in an `ACTIVE` status.
InlineHookCreateResponse	createInlineHook(InlineHookCreate inlineHookCreate, Map<String,String> additionalHeaders)	Create an inline hook Creates an inline hook This endpoint creates an inline hook for your org in an `ACTIVE` status.
InlineHook	deactivateInlineHook(String inlineHookId)	Deactivate an inline hook Deactivates the inline hook by `inlineHookId`
InlineHook	deactivateInlineHook(String inlineHookId, Map<String,String> additionalHeaders)	Deactivate an inline hook Deactivates the inline hook by `inlineHookId`
void	deleteInlineHook(String inlineHookId)	Delete an inline hook Deletes an inline hook by `inlineHookId`.
void	deleteInlineHook(String inlineHookId, Map<String,String> additionalHeaders)	Delete an inline hook Deletes an inline hook by `inlineHookId`.
ExecuteInlineHook200Response	executeInlineHook(String inlineHookId, ExecuteInlineHookRequest payloadData)	Execute an inline hook Executes the inline hook that matches the provided `inlineHookId` by using the request body as the input.
ExecuteInlineHook200Response	executeInlineHook(String inlineHookId, ExecuteInlineHookRequest payloadData, Map<String,String> additionalHeaders)	Execute an inline hook Executes the inline hook that matches the provided `inlineHookId` by using the request body as the input.
ApiClient	getApiClient()
InlineHook	getInlineHook(String inlineHookId)	Retrieve an inline hook Retrieves an inline hook by `inlineHookId`
InlineHook	getInlineHook(String inlineHookId, Map<String,String> additionalHeaders)	Retrieve an inline hook Retrieves an inline hook by `inlineHookId`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<InlineHook>	listInlineHooks(String type)	List all inline hooks Lists all inline hooks or all inline hooks of a specific type.
List<InlineHook>	listInlineHooks(String type, Map<String,String> additionalHeaders)	List all inline hooks Lists all inline hooks or all inline hooks of a specific type.
Iterable<InlineHook>	listInlineHooksPaged(String type)	List all inline hooks (Paginated) Lists all inline hooks or all inline hooks of a specific type.
Iterable<InlineHook>	listInlineHooksPaged(String type, Map<String,String> additionalHeaders)	List all inline hooks (Paginated with additional headers) Lists all inline hooks or all inline hooks of a specific type.
InlineHook	replaceInlineHook(String inlineHookId, InlineHookReplace inlineHook)	Replace an inline hook Replaces an inline hook by `inlineHookId`.
InlineHook	replaceInlineHook(String inlineHookId, InlineHookReplace inlineHook, Map<String,String> additionalHeaders)	Replace an inline hook Replaces an inline hook by `inlineHookId`.
void	setApiClient(ApiClient apiClient)
InlineHook	updateInlineHook(String inlineHookId, InlineHookReplace inlineHook)	Update an inline hook Updates an inline hook by `inlineHookId`
InlineHook	updateInlineHook(String inlineHookId, InlineHookReplace inlineHook, Map<String,String> additionalHeaders)	Update an inline hook Updates an inline hook by `inlineHookId`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InlineHookApi

public InlineHookApi()

InlineHookApi

public InlineHookApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateInlineHook

public InlineHook activateInlineHook(String inlineHookId)
                              throws ApiException

Activate an inline hook Activates the inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the inline hook (required)

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

activateInlineHook

public InlineHook activateInlineHook(String inlineHookId,
 Map<String,String> additionalHeaders)
                              throws ApiException

Activate an inline hook Activates the inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the inline hook (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

createInlineHook

public InlineHookCreateResponse createInlineHook(InlineHookCreate inlineHookCreate)
                                          throws ApiException

Create an inline hook Creates an inline hook This endpoint creates an inline hook for your org in an `ACTIVE` status. You need to pass an inline hooks object in the JSON payload of your request. That object represents the set of required information about the inline hook that you're registering, including: * The URI of your external service endpoint * The type of inline hook you're registering * The type of authentication you're registering There are two authentication options that you can configure for your inline hook: HTTP headers and OAuth 2.0 tokens. HTTP headers let you specify a secret API key that you want Okta to pass to your external service endpoint (so that your external service can check for its presence as a security measure). >**Note:** The API key that you set here is unrelated to the Okta API token you must supply when making calls to Okta APIs. You can also optionally specify extra headers that you want Okta to pass to your external service with each call. To configure HTTP header authentication, see parameters for the `config` object. OAuth 2.0 tokens provide enhanced security between Okta and your external service. You can configure these tokens for the following types—client secret and private key. >**Note:** Your external service's endpoint needs to be a valid HTTPS endpoint. The URI you specify should always begin with `https://`. The total number of inline hooks that you can create in an Okta org is limited to 50, which is a combined total for any combination of inline hook types.

Parameters:

inlineHookCreate - (required)

Returns:

InlineHookCreateResponse

Throws:

ApiException - if fails to make API call

createInlineHook

public InlineHookCreateResponse createInlineHook(InlineHookCreate inlineHookCreate,
 Map<String,String> additionalHeaders)
                                          throws ApiException

Create an inline hook Creates an inline hook This endpoint creates an inline hook for your org in an `ACTIVE` status. You need to pass an inline hooks object in the JSON payload of your request. That object represents the set of required information about the inline hook that you're registering, including: * The URI of your external service endpoint * The type of inline hook you're registering * The type of authentication you're registering There are two authentication options that you can configure for your inline hook: HTTP headers and OAuth 2.0 tokens. HTTP headers let you specify a secret API key that you want Okta to pass to your external service endpoint (so that your external service can check for its presence as a security measure). >**Note:** The API key that you set here is unrelated to the Okta API token you must supply when making calls to Okta APIs. You can also optionally specify extra headers that you want Okta to pass to your external service with each call. To configure HTTP header authentication, see parameters for the `config` object. OAuth 2.0 tokens provide enhanced security between Okta and your external service. You can configure these tokens for the following types—client secret and private key. >**Note:** Your external service's endpoint needs to be a valid HTTPS endpoint. The URI you specify should always begin with `https://`. The total number of inline hooks that you can create in an Okta org is limited to 50, which is a combined total for any combination of inline hook types.

Parameters:

inlineHookCreate - (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHookCreateResponse

Throws:

ApiException - if fails to make API call

deactivateInlineHook

public InlineHook deactivateInlineHook(String inlineHookId)
                                throws ApiException

Deactivate an inline hook Deactivates the inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the inline hook (required)

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

deactivateInlineHook

public InlineHook deactivateInlineHook(String inlineHookId,
 Map<String,String> additionalHeaders)
                                throws ApiException

Deactivate an inline hook Deactivates the inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the inline hook (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

deleteInlineHook

public void deleteInlineHook(String inlineHookId)
                      throws ApiException

Delete an inline hook Deletes an inline hook by `inlineHookId`. After it's deleted, the inline hook is unrecoverable. As a safety precaution, only inline hooks with a status of `INACTIVE` are eligible for deletion.

Parameters:

inlineHookId - `id` of the inline hook (required)

Throws:

ApiException - if fails to make API call

deleteInlineHook

public void deleteInlineHook(String inlineHookId,
 Map<String,String> additionalHeaders)
                      throws ApiException

Delete an inline hook Deletes an inline hook by `inlineHookId`. After it's deleted, the inline hook is unrecoverable. As a safety precaution, only inline hooks with a status of `INACTIVE` are eligible for deletion.

Parameters:

inlineHookId - `id` of the inline hook (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

executeInlineHook

public ExecuteInlineHook200Response executeInlineHook(String inlineHookId,
 ExecuteInlineHookRequest payloadData)
                                               throws ApiException

Execute an inline hook Executes the inline hook that matches the provided `inlineHookId` by using the request body as the input. This inline hook sends the provided data through the `channel` object and returns a response if it matches the correct data contract. Otherwise it returns an error. You need to construct a JSON payload that matches the payloads that Okta would send to your external service for this inline hook type. A timeout of three seconds is enforced on all outbound requests, with one retry in the event of a timeout or an error response from the remote system. If a successful response isn't received after the request, a 400 error is returned with more information about what failed. >**Note:** This execution endpoint isn't tied to any other functionality in Okta, and you should only use it for testing purposes.

Parameters:

inlineHookId - `id` of the inline hook (required)

payloadData - (required)

Returns:

ExecuteInlineHook200Response

Throws:

ApiException - if fails to make API call

executeInlineHook

public ExecuteInlineHook200Response executeInlineHook(String inlineHookId,
 ExecuteInlineHookRequest payloadData,
 Map<String,String> additionalHeaders)
                                               throws ApiException

Execute an inline hook Executes the inline hook that matches the provided `inlineHookId` by using the request body as the input. This inline hook sends the provided data through the `channel` object and returns a response if it matches the correct data contract. Otherwise it returns an error. You need to construct a JSON payload that matches the payloads that Okta would send to your external service for this inline hook type. A timeout of three seconds is enforced on all outbound requests, with one retry in the event of a timeout or an error response from the remote system. If a successful response isn't received after the request, a 400 error is returned with more information about what failed. >**Note:** This execution endpoint isn't tied to any other functionality in Okta, and you should only use it for testing purposes.

Parameters:

inlineHookId - `id` of the inline hook (required)

payloadData - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ExecuteInlineHook200Response

Throws:

ApiException - if fails to make API call

getInlineHook

public InlineHook getInlineHook(String inlineHookId)
                         throws ApiException

Retrieve an inline hook Retrieves an inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the inline hook (required)

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

getInlineHook

public InlineHook getInlineHook(String inlineHookId,
 Map<String,String> additionalHeaders)
                         throws ApiException

Retrieve an inline hook Retrieves an inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the inline hook (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

listInlineHooks

public List<InlineHook> listInlineHooks(String type)
                                 throws ApiException

List all inline hooks Lists all inline hooks or all inline hooks of a specific type. When listing a specific inline hook, you need to specify its type. The following types are currently supported: | Type Value | Name | |------------------------------------|----------------------------------------------------------------| | `com.okta.import.transform` | [User import inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createUserImportInlineHook) | | `com.okta.oauth2.tokens.transform` | [Token inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createTokenInlineHook) | | `com.okta.saml.tokens.transform` | [SAML assertion inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createSAMLAssertionInlineHook) | | `com.okta.telephony.provider` | [Telephony inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createTelephonyInlineHook) | | `com.okta.user.credential.password.import` | [Password import inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createPasswordImportInlineHook)| | `com.okta.user.pre-registration` | [Registration inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/create-registration-hook) |

Parameters:

type - One of the supported inline hook types (optional)

Returns:

List<InlineHook>

Throws:

ApiException - if fails to make API call

listInlineHooks

public List<InlineHook> listInlineHooks(String type,
 Map<String,String> additionalHeaders)
                                 throws ApiException

List all inline hooks Lists all inline hooks or all inline hooks of a specific type. When listing a specific inline hook, you need to specify its type. The following types are currently supported: | Type Value | Name | |------------------------------------|----------------------------------------------------------------| | `com.okta.import.transform` | [User import inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createUserImportInlineHook) | | `com.okta.oauth2.tokens.transform` | [Token inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createTokenInlineHook) | | `com.okta.saml.tokens.transform` | [SAML assertion inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createSAMLAssertionInlineHook) | | `com.okta.telephony.provider` | [Telephony inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createTelephonyInlineHook) | | `com.okta.user.credential.password.import` | [Password import inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createPasswordImportInlineHook)| | `com.okta.user.pre-registration` | [Registration inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/create-registration-hook) |

Parameters:

type - One of the supported inline hook types (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<InlineHook>

Throws:

ApiException - if fails to make API call

listInlineHooksPaged

public Iterable<InlineHook> listInlineHooksPaged(String type)

List all inline hooks (Paginated) Lists all inline hooks or all inline hooks of a specific type. When listing a specific inline hook, you need to specify its type. The following types are currently supported: | Type Value | Name | |------------------------------------|----------------------------------------------------------------| | `com.okta.import.transform` | [User import inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createUserImportInlineHook) | | `com.okta.oauth2.tokens.transform` | [Token inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createTokenInlineHook) | | `com.okta.saml.tokens.transform` | [SAML assertion inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createSAMLAssertionInlineHook) | | `com.okta.telephony.provider` | [Telephony inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createTelephonyInlineHook) | | `com.okta.user.credential.password.import` | [Password import inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createPasswordImportInlineHook)| | `com.okta.user.pre-registration` | [Registration inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/create-registration-hook) | 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.

Parameters:

type - One of the supported inline hook types (optional)

Returns:

Iterable<InlineHook> lazy iterable over all pages

listInlineHooksPaged

public Iterable<InlineHook> listInlineHooksPaged(String type,
 Map<String,String> additionalHeaders)

List all inline hooks (Paginated with additional headers) Lists all inline hooks or all inline hooks of a specific type. When listing a specific inline hook, you need to specify its type. The following types are currently supported: | Type Value | Name | |------------------------------------|----------------------------------------------------------------| | `com.okta.import.transform` | [User import inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createUserImportInlineHook) | | `com.okta.oauth2.tokens.transform` | [Token inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createTokenInlineHook) | | `com.okta.saml.tokens.transform` | [SAML assertion inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createSAMLAssertionInlineHook) | | `com.okta.telephony.provider` | [Telephony inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createTelephonyInlineHook) | | `com.okta.user.credential.password.import` | [Password import inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/createPasswordImportInlineHook)| | `com.okta.user.pre-registration` | [Registration inline hook](/openapi/okta-management/management/tag/InlineHook/#tag/InlineHook/operation/create-registration-hook) | This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.

Parameters:

type - One of the supported inline hook types (optional)

additionalHeaders - additional headers for this call

Returns:

Iterable<InlineHook> lazy iterable over all pages

replaceInlineHook

public InlineHook replaceInlineHook(String inlineHookId,
 InlineHookReplace inlineHook)
                             throws ApiException

Replace an inline hook Replaces an inline hook by `inlineHookId`. The submitted inline hook properties replace the existing properties after passing validation. >**Note:** Some properties are immutable and can't be updated.

Parameters:

inlineHookId - `id` of the inline hook (required)

inlineHook - (required)

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

replaceInlineHook

public InlineHook replaceInlineHook(String inlineHookId,
 InlineHookReplace inlineHook,
 Map<String,String> additionalHeaders)
                             throws ApiException

Replace an inline hook Replaces an inline hook by `inlineHookId`. The submitted inline hook properties replace the existing properties after passing validation. >**Note:** Some properties are immutable and can't be updated.

Parameters:

inlineHookId - `id` of the inline hook (required)

inlineHook - (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

updateInlineHook

public InlineHook updateInlineHook(String inlineHookId,
 InlineHookReplace inlineHook)
                            throws ApiException

Update an inline hook Updates an inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the inline hook (required)

inlineHook - (required)

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

updateInlineHook

public InlineHook updateInlineHook(String inlineHookId,
 InlineHookReplace inlineHook,
 Map<String,String> additionalHeaders)
                            throws ApiException

Update an inline hook Updates an inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the inline hook (required)

inlineHook - (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

getObjectMapper

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