Class FlowsRequestBuilder

Namespace

Keycloak.AuthServices.Sdk.Kiota.Admin.Admin.Realms.Item.Authentication.Flows

Assembly

Keycloak.AuthServices.Sdk.Kiota.dll

Builds and executes requests for operations under \admin\realms{realm}\authentication\flows

public class FlowsRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

FlowsRequestBuilder

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

FlowsRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new FlowsRequestBuilder and sets the default values.

public FlowsRequestBuilder(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.

FlowsRequestBuilder(string, IRequestAdapter)

Instantiates a new FlowsRequestBuilder and sets the default values.

public FlowsRequestBuilder(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

this[string]

Gets an item from the Keycloak.AuthServices.Sdk.Kiota.Admin.admin.realms.item.authentication.flows.item collection

public FlowAliasItemRequestBuilder this[string position] { get; }

Parameters

position string

Flow id

Property Value

FlowAliasItemRequestBuilder

A FlowAliasItemRequestBuilder

Methods

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

Get authentication flows Returns a stream of authentication flows.

public Task<List<AuthenticationFlowRepresentation>?> GetAsync(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<List<AuthenticationFlowRepresentation>>

A List<AuthenticationFlowRepresentation>

PostAsync(AuthenticationFlowRepresentation, Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

Create a new authentication flow

public Task<Stream?> PostAsync(AuthenticationFlowRepresentation body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

body AuthenticationFlowRepresentation

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<Stream>

A Stream

ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>?)

Get authentication flows Returns a stream of authentication flows.

public RequestInformation ToGetRequestInformation(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

ToPostRequestInformation(AuthenticationFlowRepresentation, Action<RequestConfiguration<DefaultQueryParameters>>?)

Create a new authentication flow

public RequestInformation ToPostRequestInformation(AuthenticationFlowRepresentation body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

body AuthenticationFlowRepresentation

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 FlowsRequestBuilder WithUrl(string rawUrl)

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

FlowsRequestBuilder

A FlowsRequestBuilder