Class FlowsClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

public class FlowsClient : BaseClient, IFlowsClient

Inheritance

object

BaseClient

FlowsClient

Implements

IFlowsClient

Inherited Members

BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.BuildUri(string, IList<Tuple<string, string>>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FlowsClient(IManagementConnection, Uri, IDictionary<string, string>)

Initializes a new instance of FlowsClient

public FlowsClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

IManagementConnection

baseUri Uri

Uri

defaultHeaders IDictionary<string, string>

Default headers

Methods

CreateAsync(FlowCreateRequest, CancellationToken)

Create a Flow.

public Task<Flow> CreateAsync(FlowCreateRequest request, CancellationToken cancellationToken = default)

Parameters

request FlowCreateRequest

FlowCreateRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<Flow>

A Flow

CreateVaultConnectionAsync(FlowVaultConnectionCreateRequest, CancellationToken)

Create a Flows Vault connection

public Task<FlowVaultConnection> CreateVaultConnectionAsync(FlowVaultConnectionCreateRequest request, CancellationToken cancellationToken = default)

Parameters

request FlowVaultConnectionCreateRequest

FlowVaultConnectionCreateRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<FlowVaultConnection>

A FlowVaultConnection

DeleteAsync(string, CancellationToken)

Delete a Flow

public Task DeleteAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

Identifier of the flow to delete

cancellationToken CancellationToken

CancellationToken

Returns

Task

DeleteFlowExecutionAsync(string, string, CancellationToken)

Delete a FlowExecution

public Task DeleteFlowExecutionAsync(string flowId, string executionId, CancellationToken cancellationToken = default)

Parameters

flowId string

Flow identifier for which we need to fetch the execution

executionId string

Flow execution ID

cancellationToken CancellationToken

CancellationToken

Returns

Task

DeleteFlowVaultConnectionAsync(string, CancellationToken)

Delete a FlowVaultConnection

public Task DeleteFlowVaultConnectionAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

Identifier of the flow to delete

cancellationToken CancellationToken

CancellationToken

Returns

Task

GetAllAsync(FlowGetRequest, CancellationToken)

Get Flows

public Task<IPagedList<Flow>> GetAllAsync(FlowGetRequest request, CancellationToken cancellationToken = default)

Parameters

request FlowGetRequest

FlowGetRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<IPagedList<Flow>>

IPagedList<T> of Flow

GetAllFlowExecutionsAsync(string, CheckpointPaginationInfo, CancellationToken)

Get Flow executions.

public Task<ICheckpointPagedList<FlowExecution>> GetAllFlowExecutionsAsync(string flowId, CheckpointPaginationInfo paginationInfo, CancellationToken cancellationToken = default)

Parameters

flowId string

Flow identifier for which we need to fetch the executions

paginationInfo CheckpointPaginationInfo

CheckpointPaginationInfo

cancellationToken CancellationToken

CancellationToken

Returns

Task<ICheckpointPagedList<FlowExecution>>

ICheckpointPagedList<T>"/> list of FlowExecution

GetAllFlowExecutionsAsync(string, PaginationInfo, CancellationToken)

Get Flow executions.

public Task<IPagedList<FlowExecution>> GetAllFlowExecutionsAsync(string flowId, PaginationInfo paginationInfo, CancellationToken cancellationToken = default)

Parameters

flowId string

Flow identifier for which we need to fetch the executions

paginationInfo PaginationInfo

PaginationInfo

cancellationToken CancellationToken

CancellationToken

Returns

Task<IPagedList<FlowExecution>>

IPagedList<T> list of FlowExecution

GetAllFlowVaultConnectionsAsync(FlowVaultConnectionGetRequest, CancellationToken)

Get FlowVaultConnection list

public Task<IPagedList<FlowVaultConnection>> GetAllFlowVaultConnectionsAsync(FlowVaultConnectionGetRequest request, CancellationToken cancellationToken = default)

Parameters

request FlowVaultConnectionGetRequest

FlowVaultConnectionGetRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<IPagedList<FlowVaultConnection>>

IPagedList<T> of FlowVaultConnection

GetAsync(FlowGetRequest, CancellationToken)

Get a Flow.

public Task<Flow> GetAsync(FlowGetRequest request, CancellationToken cancellationToken = default)

Parameters

request FlowGetRequest

FlowGetRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<Flow>

A Flow

GetFlowExecutionAsync(string, string, CancellationToken)

Get a FlowExecution.

public Task<FlowExecution> GetFlowExecutionAsync(string flowId, string executionId, CancellationToken cancellationToken = default)

Parameters

flowId string

Flow identifier for which we need to fetch the execution

executionId string

Flow execution ID

cancellationToken CancellationToken

CancellationToken

Returns

Task<FlowExecution>

FlowExecution

GetFlowVaultConnectionAsync(FlowVaultConnectionGetRequest, CancellationToken)

Get a FlowVaultConnection.

public Task<FlowVaultConnection> GetFlowVaultConnectionAsync(FlowVaultConnectionGetRequest request, CancellationToken cancellationToken = default)

Parameters

request FlowVaultConnectionGetRequest

FlowVaultConnectionGetRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<FlowVaultConnection>

A FlowVaultConnection

UpdateAsync(string, FlowUpdateRequest, CancellationToken)

Update a Flow

public Task<Flow> UpdateAsync(string id, FlowUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

Identifier of the flow to be updated

request FlowUpdateRequest

FlowUpdateRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<Flow>

Updated Flow

UpdateFlowVaultConnectionAsync(string, FlowVaultConnectionUpdateRequest, CancellationToken)

Update a Flow

public Task<FlowVaultConnection> UpdateFlowVaultConnectionAsync(string id, FlowVaultConnectionUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

Identifier of the flow to be updated

request FlowVaultConnectionUpdateRequest

FlowVaultConnectionUpdateRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<FlowVaultConnection>

Updated FlowVaultConnection