Class RealmsRequestBuilder

Namespace

Keycloak.AuthServices.Sdk.Kiota.Admin.Admin.Realms

Assembly

Keycloak.AuthServices.Sdk.Kiota.dll

Builds and executes requests for operations under \admin\realms

public class RealmsRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

RealmsRequestBuilder

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

RealmsRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new RealmsRequestBuilder and sets the default values.

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

RealmsRequestBuilder(string, IRequestAdapter)

Instantiates a new RealmsRequestBuilder and sets the default values.

public RealmsRequestBuilder(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 collection

public WithRealmItemRequestBuilder this[string position] { get; }

Parameters

position string

realm name (not id!)

Property Value

WithRealmItemRequestBuilder

A WithRealmItemRequestBuilder

Methods

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

Get accessible realms Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view.

public Task<List<RealmRepresentation>?> GetAsync(Action<RequestConfiguration<RealmsRequestBuilder.RealmsRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<RealmsRequestBuilder.RealmsRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<List<RealmRepresentation>>

A List<RealmRepresentation>

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

Realm name must be unique.

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

Parameters

body string

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<RealmsRequestBuilderGetQueryParameters>>?)

Get accessible realms Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<RealmsRequestBuilder.RealmsRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<RealmsRequestBuilder.RealmsRequestBuilderGetQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

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

Realm name must be unique.

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

Parameters

body string

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

RealmsRequestBuilder

A RealmsRequestBuilder