Class InlineHooksClient

A client that communicates with the Okta management API.

Inheritance
System.Object
OktaClient
InlineHooksClient
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Okta.Sdk
Assembly: Okta.Sdk.dll
Syntax
public sealed class InlineHooksClient : OktaClient, IOktaClient, IInlineHooksClient

Methods

ActivateInlineHookAsync(String, CancellationToken)

Activates the Inline Hook matching the provided id

Declaration
public 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
public 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
public 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
public 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
public 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
public 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
public 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
public 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.

Implements