Interface IInlineHooksClient

A client that works with Okta InlineHook resources.

Namespace: Okta.Sdk

Assembly: Okta.Sdk.dll

Syntax

public interface IInlineHooksClient

Methods

ActivateInlineHookAsync(String, CancellationToken)

Activates the Inline Hook matching the provided id

Declaration

Task<IInlineHook> ActivateInlineHookAsync(string inlineHookId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	inlineHookId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IInlineHook>	The IInlineHook response.

CreateInlineHookAsync(IInlineHook, CancellationToken)

Success

Declaration

Task<IInlineHook> CreateInlineHookAsync(IInlineHook inlineHook, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IInlineHook	inlineHook	The IInlineHook resource.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IInlineHook>	The IInlineHook response.

DeactivateInlineHookAsync(String, CancellationToken)

Deactivates the Inline Hook matching the provided id

Declaration

Task<IInlineHook> DeactivateInlineHookAsync(string inlineHookId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	inlineHookId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IInlineHook>	The IInlineHook response.

DeleteInlineHookAsync(String, CancellationToken)

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.

Declaration

Task DeleteInlineHookAsync(string inlineHookId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	inlineHookId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

ExecuteInlineHookAsync(IInlineHookPayload, String, CancellationToken)

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.

Declaration

Task<IInlineHookResponse> ExecuteInlineHookAsync(IInlineHookPayload payloadData, string inlineHookId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IInlineHookPayload	payloadData	The IInlineHookPayload resource.
System.String	inlineHookId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IInlineHookResponse>	The IInlineHookResponse response.

GetInlineHookAsync(String, CancellationToken)

Gets an inline hook by ID

Declaration

Task<IInlineHook> GetInlineHookAsync(string inlineHookId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	inlineHookId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IInlineHook>	The IInlineHook response.

ListInlineHooks(String)

Success

Declaration

ICollectionClient<IInlineHook> ListInlineHooks(string type = null)

Parameters

Type	Name	Description
System.String	type

Returns

Type	Description
ICollectionClient<IInlineHook>	A collection of IInlineHook that can be enumerated asynchronously.

UpdateInlineHookAsync(IInlineHook, String, CancellationToken)

Updates an inline hook by ID

Declaration

Task<IInlineHook> UpdateInlineHookAsync(IInlineHook inlineHook, string inlineHookId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IInlineHook	inlineHook	The IInlineHook resource.
System.String	inlineHookId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IInlineHook>	The IInlineHook response.