Class CompositesRequestBuilder

Namespace

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

Assembly

Keycloak.AuthServices.Sdk.Kiota.dll

Builds and executes requests for operations under \admin\realms{realm}\clients{client-uuid}\roles{role-name}\composites

public class CompositesRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

CompositesRequestBuilder

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

CompositesRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new CompositesRequestBuilder and sets the default values.

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

CompositesRequestBuilder(string, IRequestAdapter)

Instantiates a new CompositesRequestBuilder and sets the default values.

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

Clients

The clients property

public ClientsRequestBuilder Clients { get; }

Property Value

ClientsRequestBuilder

Realm

The realm property

public RealmRequestBuilder Realm { get; }

Property Value

RealmRequestBuilder

Methods

DeleteAsync(List<RoleRepresentation>, Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

Remove roles from the role's composite

public Task DeleteAsync(List<RoleRepresentation> body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

body List<RoleRepresentation>

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

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

Get composites of the role

public Task<List<RoleRepresentation>?> GetAsync(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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<List<RoleRepresentation>>

A List<RoleRepresentation>

PostAsync(List<RoleRepresentation>, Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

Add a composite to the role

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

Parameters

body List<RoleRepresentation>

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

ToDeleteRequestInformation(List<RoleRepresentation>, Action<RequestConfiguration<DefaultQueryParameters>>?)

Remove roles from the role's composite

public RequestInformation ToDeleteRequestInformation(List<RoleRepresentation> body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

body List<RoleRepresentation>

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

ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>?)

Get composites of the role

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

ToPostRequestInformation(List<RoleRepresentation>, Action<RequestConfiguration<DefaultQueryParameters>>?)

Add a composite to the role

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

Parameters

body List<RoleRepresentation>

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

CompositesRequestBuilder

A CompositesRequestBuilder