Class UsersRequestBuilder

Namespace

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

Assembly

Keycloak.AuthServices.Sdk.Kiota.dll

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

public class UsersRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

UsersRequestBuilder

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

UsersRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new UsersRequestBuilder and sets the default values.

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

UsersRequestBuilder(string, IRequestAdapter)

Instantiates a new UsersRequestBuilder and sets the default values.

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

Count

The count property

public CountRequestBuilder Count { get; }

Property Value

CountRequestBuilder

this[string]

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

public UserItemRequestBuilder this[string position] { get; }

Parameters

position string

Unique identifier of the item

Property Value

UserItemRequestBuilder

A UserItemRequestBuilder

Profile

The profile property

public ProfileRequestBuilder Profile { get; }

Property Value

ProfileRequestBuilder

Methods

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

Get users Returns a stream of users, filtered according to query parameters.

public Task<List<UserRepresentation>?> GetAsync(Action<RequestConfiguration<UsersRequestBuilder.UsersRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<UsersRequestBuilder.UsersRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<List<UserRepresentation>>

A List<UserRepresentation>

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

Create a new user Username must be unique.

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

Parameters

body UserRepresentation

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

Get users Returns a stream of users, filtered according to query parameters.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<UsersRequestBuilder.UsersRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<UsersRequestBuilder.UsersRequestBuilderGetQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

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

Create a new user Username must be unique.

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

Parameters

body UserRepresentation

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

UsersRequestBuilder

A UsersRequestBuilder