Class UserItemRequestBuilder

Namespace

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

Assembly

Keycloak.AuthServices.Sdk.Kiota.dll

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

public class UserItemRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

UserItemRequestBuilder

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

UserItemRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new UserItemRequestBuilder and sets the default values.

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

UserItemRequestBuilder(string, IRequestAdapter)

Instantiates a new UserItemRequestBuilder and sets the default values.

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

ConfiguredUserStorageCredentialTypes

The configuredUserStorageCredentialTypes property

public ConfiguredUserStorageCredentialTypesRequestBuilder ConfiguredUserStorageCredentialTypes { get; }

Property Value

ConfiguredUserStorageCredentialTypesRequestBuilder

Consents

The consents property

public ConsentsRequestBuilder Consents { get; }

Property Value

ConsentsRequestBuilder

Credentials

The credentials property

public CredentialsRequestBuilder Credentials { get; }

Property Value

CredentialsRequestBuilder

DisableCredentialTypes

The disableCredentialTypes property

public DisableCredentialTypesRequestBuilder DisableCredentialTypes { get; }

Property Value

DisableCredentialTypesRequestBuilder

ExecuteActionsEmail

The executeActionsEmail property

public ExecuteActionsEmailRequestBuilder ExecuteActionsEmail { get; }

Property Value

ExecuteActionsEmailRequestBuilder

FederatedIdentity

The federatedIdentity property

public FederatedIdentityRequestBuilder FederatedIdentity { get; }

Property Value

FederatedIdentityRequestBuilder

Groups

The groups property

public GroupsRequestBuilder Groups { get; }

Property Value

GroupsRequestBuilder

Impersonation

The impersonation property

public ImpersonationRequestBuilder Impersonation { get; }

Property Value

ImpersonationRequestBuilder

Logout

The logout property

public LogoutRequestBuilder Logout { get; }

Property Value

LogoutRequestBuilder

OfflineSessions

The offlineSessions property

public OfflineSessionsRequestBuilder OfflineSessions { get; }

Property Value

OfflineSessionsRequestBuilder

ResetPassword

The resetPassword property

public ResetPasswordRequestBuilder ResetPassword { get; }

Property Value

ResetPasswordRequestBuilder

ResetPasswordEmail

The resetPasswordEmail property

public ResetPasswordEmailRequestBuilder ResetPasswordEmail { get; }

Property Value

ResetPasswordEmailRequestBuilder

RoleMappings

The roleMappings property

public RoleMappingsRequestBuilder RoleMappings { get; }

Property Value

RoleMappingsRequestBuilder

SendVerifyEmail

The sendVerifyEmail property

public SendVerifyEmailRequestBuilder SendVerifyEmail { get; }

Property Value

SendVerifyEmailRequestBuilder

Sessions

The sessions property

public SessionsRequestBuilder Sessions { get; }

Property Value

SessionsRequestBuilder

Methods

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

Delete the user

public Task<Stream?> DeleteAsync(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<Stream>

A Stream

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

Get representation of the user

public Task<UserRepresentation?> GetAsync(Action<RequestConfiguration<UserItemRequestBuilder.UserItemRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<UserItemRequestBuilder.UserItemRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<UserRepresentation>

A UserRepresentation

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

Update the user

public Task<Stream?> PutAsync(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

ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>?)

Delete the user

public RequestInformation ToDeleteRequestInformation(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

ToGetRequestInformation(Action<RequestConfiguration<UserItemRequestBuilderGetQueryParameters>>?)

Get representation of the user

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<UserItemRequestBuilder.UserItemRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<UserItemRequestBuilder.UserItemRequestBuilderGetQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

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

Update the user

public RequestInformation ToPutRequestInformation(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 UserItemRequestBuilder WithUrl(string rawUrl)

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

UserItemRequestBuilder

A UserItemRequestBuilder