Class ClientsRequestBuilder

Namespace

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

Assembly

Keycloak.AuthServices.Sdk.Kiota.dll

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

public class ClientsRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

ClientsRequestBuilder

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

ClientsRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new ClientsRequestBuilder and sets the default values.

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

ClientsRequestBuilder(string, IRequestAdapter)

Instantiates a new ClientsRequestBuilder and sets the default values.

public ClientsRequestBuilder(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.clients.item collection

public ClientUuItemRequestBuilder this[string position] { get; }

Parameters

position string

id of client (not client-id!)

Property Value

ClientUuItemRequestBuilder

A ClientUuItemRequestBuilder

Methods

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

If a client can’t be retrieved from the storage due to a problem with the underlying storage, it is silently removed from the returned list. This ensures that concurrent modifications to the list don’t prevent callers from retrieving this list.

public Task<List<ClientRepresentation>?> GetAsync(Action<RequestConfiguration<ClientsRequestBuilder.ClientsRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<ClientsRequestBuilder.ClientsRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<List<ClientRepresentation>>

A List<ClientRepresentation>

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

Create a new client Client’s client_id must be unique!

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

Parameters

body ClientRepresentation

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

ToGetRequestInformation(Action<RequestConfiguration<ClientsRequestBuilderGetQueryParameters>>?)

If a client can’t be retrieved from the storage due to a problem with the underlying storage, it is silently removed from the returned list. This ensures that concurrent modifications to the list don’t prevent callers from retrieving this list.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<ClientsRequestBuilder.ClientsRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<ClientsRequestBuilder.ClientsRequestBuilderGetQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

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

Create a new client Client’s client_id must be unique!

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

Parameters

body ClientRepresentation

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

ClientsRequestBuilder

A ClientsRequestBuilder