com.okta.sdk.resource.inline.hook

Interface InlineHook

All Superinterfaces:

Deletable, ExtensibleResource, Map<String,Object>, PropertyRetriever, Resource

All Known Implementing Classes:

DefaultInlineHook

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00")
public interface InlineHook
extends ExtensibleResource, Deletable

InlineHook

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
InlineHook	activate() Activates the Inline Hook matching the provided id
InlineHook	deactivate() Deactivates the Inline Hook matching the provided id
void	delete() Deletes the Inline Hook matching the provided id.
InlineHookResponse	execute(InlineHookPayload payloadData) Executes the Inline Hook matching the provided inlineHookId using the request body as the input.
InlineHookChannel	getChannel()
Date	getCreated()
String	getId()
Date	getLastUpdated()
Map<String,Object>	getLinks()
String	getName()
InlineHookStatus	getStatus()
InlineHookType	getType()
String	getVersion()
InlineHook	setChannel(InlineHookChannel channel)
InlineHook	setName(String name)
InlineHook	setStatus(InlineHookStatus status)
InlineHook	setType(InlineHookType type)
InlineHook	setVersion(String version)
InlineHook	update() Updates an inline hook by ID

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getLinks

Map<String,Object> getLinks()

getChannel

InlineHookChannel getChannel()

setChannel

InlineHook setChannel(InlineHookChannel channel)

getCreated

Date getCreated()

getId

String getId()

getLastUpdated

Date getLastUpdated()

getName

String getName()

setName

InlineHook setName(String name)

getStatus

InlineHookStatus getStatus()

setStatus

InlineHook setStatus(InlineHookStatus status)

getType

InlineHookType getType()

setType

InlineHook setType(InlineHookType type)

getVersion

String getVersion()

setVersion

InlineHook setVersion(String version)

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="PUT - /api/v1/inlineHooks/{inlineHookId}")
InlineHook update()

Updates an inline hook by ID

Returns:

InlineHook

execute

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/inlineHooks/{inlineHookId}/execute")
InlineHookResponse execute(InlineHookPayload payloadData)

Executes the Inline Hook matching the provided inlineHookId using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes.

Parameters:

payloadData - (required)

Returns:

InlineHookResponse

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/inlineHooks/{inlineHookId}")
void delete()

Deletes the Inline Hook matching the provided id. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion.

Specified by:

delete in interface Deletable

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate")
InlineHook deactivate()

Deactivates the Inline Hook matching the provided id

Returns:

InlineHook

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/inlineHooks/{inlineHookId}/lifecycle/activate")
InlineHook activate()

Activates the Inline Hook matching the provided id

Returns:

InlineHook