Table of Contents

Interface IActionsClient

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll
public interface IActionsClient
Extension Methods

Properties

Executions

IExecutionsClient Executions { get; }

Property Value

IExecutionsClient

Modules

IModulesClient Modules { get; }

Property Value

IModulesClient

Triggers

ITriggersClient Triggers { get; }

Property Value

ITriggersClient

Versions

IVersionsClient Versions { get; }

Property Value

IVersionsClient

Methods

CreateAsync(CreateActionRequestContent, RequestOptions?, CancellationToken)

Create an action. Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.

WithRawResponseTask<CreateActionResponseContent> CreateAsync(CreateActionRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateActionRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateActionResponseContent>

DeleteAsync(string, DeleteActionRequestParameters, RequestOptions?, CancellationToken)

Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.

Task DeleteAsync(string id, DeleteActionRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
request DeleteActionRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

Task

DeployAsync(string, RequestOptions?, CancellationToken)

Deploy an action. Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately. Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.

WithRawResponseTask<DeployActionResponseContent> DeployAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<DeployActionResponseContent>

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve an action by its ID.

WithRawResponseTask<GetActionResponseContent> GetAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetActionResponseContent>

ListAsync(ListActionsRequestParameters, RequestOptions?, CancellationToken)

Retrieve all actions.

Task<Pager<Action>> ListAsync(ListActionsRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListActionsRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

Task<Pager<Action>>

TestAsync(string, TestActionRequestContent, RequestOptions?, CancellationToken)

Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.

WithRawResponseTask<TestActionResponseContent> TestAsync(string id, TestActionRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
request TestActionRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<TestActionResponseContent>

UpdateAsync(string, UpdateActionRequestContent, RequestOptions?, CancellationToken)

Update an existing action. If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.

WithRawResponseTask<UpdateActionResponseContent> UpdateAsync(string id, UpdateActionRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
request UpdateActionRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateActionResponseContent>