Class GroupsRequestBuilder
- Assembly
- Keycloak.AuthServices.Sdk.Kiota.dll
Builds and executes requests for operations under \admin\realms{realm}\roles{role-name}\groups
public class GroupsRequestBuilder : BaseRequestBuilder
- Inheritance
-
BaseRequestBuilderGroupsRequestBuilder
- Inherited Members
-
BaseRequestBuilder.PathParametersBaseRequestBuilder.RequestAdapterBaseRequestBuilder.UrlTemplate
Constructors
GroupsRequestBuilder(Dictionary<string, object>, IRequestAdapter)
Instantiates a new GroupsRequestBuilder and sets the default values.
public GroupsRequestBuilder(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.
GroupsRequestBuilder(string, IRequestAdapter)
Instantiates a new GroupsRequestBuilder and sets the default values.
public GroupsRequestBuilder(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<GroupsRequestBuilderGetQueryParameters>>?, CancellationToken)
Returns a stream of groups that have the specified role name
public Task<List<GroupRepresentation>?> GetAsync(Action<RequestConfiguration<GroupsRequestBuilder.GroupsRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
requestConfiguration
Action<RequestConfiguration<GroupsRequestBuilder.GroupsRequestBuilderGetQueryParameters>>Configuration for the request such as headers, query parameters, and middleware options.
cancellationToken
CancellationTokenCancellation token to use when cancelling requests
Returns
- Task<List<GroupRepresentation>>
A List<GroupRepresentation>
ToGetRequestInformation(Action<RequestConfiguration<GroupsRequestBuilderGetQueryParameters>>?)
Returns a stream of groups that have the specified role name
public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<GroupsRequestBuilder.GroupsRequestBuilderGetQueryParameters>>? requestConfiguration = null)
Parameters
requestConfiguration
Action<RequestConfiguration<GroupsRequestBuilder.GroupsRequestBuilderGetQueryParameters>>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 GroupsRequestBuilder WithUrl(string rawUrl)
Parameters
rawUrl
stringThe raw URL to use for the request builder.