Class UsersRequestBuilder
- Assembly
- Keycloak.AuthServices.Sdk.Kiota.dll
Builds and executes requests for operations under \admin\realms{realm}\clients{client-uuid}\roles{role-name}\users
public class UsersRequestBuilder : BaseRequestBuilder
- Inheritance
-
BaseRequestBuilderUsersRequestBuilder
- Inherited Members
-
BaseRequestBuilder.PathParametersBaseRequestBuilder.RequestAdapterBaseRequestBuilder.UrlTemplate
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
IRequestAdapterThe 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
stringThe raw URL to use for the request builder.
requestAdapter
IRequestAdapterThe request adapter to use to execute the requests.
Methods
GetAsync(Action<RequestConfiguration<UsersRequestBuilderGetQueryParameters>>?, CancellationToken)
Returns a stream of users that have the specified role name.
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
CancellationTokenCancellation token to use when cancelling requests
Returns
- Task<List<UserRepresentation>>
A List<UserRepresentation>
ToGetRequestInformation(Action<RequestConfiguration<UsersRequestBuilderGetQueryParameters>>?)
Returns a stream of users that have the specified role name.
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
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
stringThe raw URL to use for the request builder.