Class WorkflowsItemRequestBuilder

Namespace

Keycloak.AuthServices.Sdk.Kiota.Admin.Admin.Realms.Item.Workflows.Item

Assembly

Keycloak.AuthServices.Sdk.Kiota.dll

Builds and executes requests for operations under \admin\realms{realm}\workflows{id}

public class WorkflowsItemRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

WorkflowsItemRequestBuilder

Inherited Members

BaseRequestBuilder.PathParameters

BaseRequestBuilder.RequestAdapter

BaseRequestBuilder.UrlTemplate

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WorkflowsItemRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new WorkflowsItemRequestBuilder and sets the default values.

public WorkflowsItemRequestBuilder(Dictionary<string, object> pathParameters, IRequestAdapter requestAdapter)

Parameters

pathParameters Dictionary<string, object>

Path parameters for the request

requestAdapter IRequestAdapter

The request adapter to use to execute the requests.

WorkflowsItemRequestBuilder(string, IRequestAdapter)

Instantiates a new WorkflowsItemRequestBuilder and sets the default values.

public WorkflowsItemRequestBuilder(string rawUrl, IRequestAdapter requestAdapter)

Parameters

rawUrl string

The raw URL to use for the request builder.

requestAdapter IRequestAdapter

The request adapter to use to execute the requests.

Properties

Activate

The activate property

public ActivateRequestBuilder Activate { get; }

Property Value

ActivateRequestBuilder

Deactivate

The deactivate property

public DeactivateRequestBuilder Deactivate { get; }

Property Value

DeactivateRequestBuilder

Methods

DeleteAsync(Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

Delete the workflow and its configuration.

public Task DeleteAsync(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task

GetAsync(Action<RequestConfiguration<WorkflowsItemRequestBuilderGetQueryParameters>>?, CancellationToken)

Get the workflow representation. Optionally exclude the workflow id from the response.

public Task<WorkflowRepresentation?> GetAsync(Action<RequestConfiguration<WorkflowsItemRequestBuilder.WorkflowsItemRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<WorkflowsItemRequestBuilder.WorkflowsItemRequestBuilderGetQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<WorkflowRepresentation>

A WorkflowRepresentation

PutAsync(WorkflowRepresentation, Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

Update the workflow configuration. This method does not update the workflow steps.

public Task PutAsync(WorkflowRepresentation body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

body WorkflowRepresentation

The request body

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task

ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>?)

Delete the workflow and its configuration.

public RequestInformation ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

ToGetRequestInformation(Action<RequestConfiguration<WorkflowsItemRequestBuilderGetQueryParameters>>?)

Get the workflow representation. Optionally exclude the workflow id from the response.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<WorkflowsItemRequestBuilder.WorkflowsItemRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<WorkflowsItemRequestBuilder.WorkflowsItemRequestBuilderGetQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

ToPutRequestInformation(WorkflowRepresentation, Action<RequestConfiguration<DefaultQueryParameters>>?)

Update the workflow configuration. This method does not update the workflow steps.

public RequestInformation ToPutRequestInformation(WorkflowRepresentation body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

body WorkflowRepresentation

The request body

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

WithUrl(string)

Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.

public WorkflowsItemRequestBuilder WithUrl(string rawUrl)

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

WorkflowsItemRequestBuilder

A WorkflowsItemRequestBuilder