Class WithRealmItemRequestBuilder

Namespace

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

Assembly

Keycloak.AuthServices.Sdk.Kiota.dll

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

public class WithRealmItemRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

WithRealmItemRequestBuilder

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

WithRealmItemRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new WithRealmItemRequestBuilder and sets the default values.

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

WithRealmItemRequestBuilder(string, IRequestAdapter)

Instantiates a new WithRealmItemRequestBuilder and sets the default values.

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

AdminEvents

The adminEvents property

public AdminEventsRequestBuilder AdminEvents { get; }

Property Value

AdminEventsRequestBuilder

AttackDetection

The attackDetection property

public AttackDetectionRequestBuilder AttackDetection { get; }

Property Value

AttackDetectionRequestBuilder

Authentication

The authentication property

public AuthenticationRequestBuilder Authentication { get; }

Property Value

AuthenticationRequestBuilder

ClientDescriptionConverter

The clientDescriptionConverter property

public ClientDescriptionConverterRequestBuilder ClientDescriptionConverter { get; }

Property Value

ClientDescriptionConverterRequestBuilder

ClientPolicies

The clientPolicies property

public ClientPoliciesRequestBuilder ClientPolicies { get; }

Property Value

ClientPoliciesRequestBuilder

ClientRegistrationPolicy

The clientRegistrationPolicy property

public ClientRegistrationPolicyRequestBuilder ClientRegistrationPolicy { get; }

Property Value

ClientRegistrationPolicyRequestBuilder

ClientScopes

The clientScopes property

public ClientScopesRequestBuilder ClientScopes { get; }

Property Value

ClientScopesRequestBuilder

ClientSessionStats

The clientSessionStats property

public ClientSessionStatsRequestBuilder ClientSessionStats { get; }

Property Value

ClientSessionStatsRequestBuilder

ClientTemplates

The clientTemplates property

public ClientTemplatesRequestBuilder ClientTemplates { get; }

Property Value

ClientTemplatesRequestBuilder

Clients

The clients property

public ClientsRequestBuilder Clients { get; }

Property Value

ClientsRequestBuilder

ClientsInitialAccess

The clientsInitialAccess property

public ClientsInitialAccessRequestBuilder ClientsInitialAccess { get; }

Property Value

ClientsInitialAccessRequestBuilder

Components

The components property

public ComponentsRequestBuilder Components { get; }

Property Value

ComponentsRequestBuilder

CredentialRegistrators

The credentialRegistrators property

public CredentialRegistratorsRequestBuilder CredentialRegistrators { get; }

Property Value

CredentialRegistratorsRequestBuilder

DefaultDefaultClientScopes

The defaultDefaultClientScopes property

public DefaultDefaultClientScopesRequestBuilder DefaultDefaultClientScopes { get; }

Property Value

DefaultDefaultClientScopesRequestBuilder

DefaultGroups

The defaultGroups property

public DefaultGroupsRequestBuilder DefaultGroups { get; }

Property Value

DefaultGroupsRequestBuilder

DefaultOptionalClientScopes

The defaultOptionalClientScopes property

public DefaultOptionalClientScopesRequestBuilder DefaultOptionalClientScopes { get; }

Property Value

DefaultOptionalClientScopesRequestBuilder

Events

The events property

public EventsRequestBuilder Events { get; }

Property Value

EventsRequestBuilder

GroupByPath

The groupByPath property

public GroupByPathRequestBuilder GroupByPath { get; }

Property Value

GroupByPathRequestBuilder

Groups

The groups property

public GroupsRequestBuilder Groups { get; }

Property Value

GroupsRequestBuilder

IdentityProvider

The identityProvider property

public IdentityProviderRequestBuilder IdentityProvider { get; }

Property Value

IdentityProviderRequestBuilder

Keys

The keys property

public KeysRequestBuilder Keys { get; }

Property Value

KeysRequestBuilder

Localization

The localization property

public LocalizationRequestBuilder Localization { get; }

Property Value

LocalizationRequestBuilder

LogoutAll

The logoutAll property

public LogoutAllRequestBuilder LogoutAll { get; }

Property Value

LogoutAllRequestBuilder

PartialExport

The partialExport property

public PartialExportRequestBuilder PartialExport { get; }

Property Value

PartialExportRequestBuilder

PartialImport

The partialImport property

public PartialImportRequestBuilder PartialImport { get; }

Property Value

PartialImportRequestBuilder

PushRevocation

The pushRevocation property

public PushRevocationRequestBuilder PushRevocation { get; }

Property Value

PushRevocationRequestBuilder

Roles

The roles property

public RolesRequestBuilder Roles { get; }

Property Value

RolesRequestBuilder

RolesById

The rolesById property

public RolesByIdRequestBuilder RolesById { get; }

Property Value

RolesByIdRequestBuilder

Sessions

The sessions property

public SessionsRequestBuilder Sessions { get; }

Property Value

SessionsRequestBuilder

TestSMTPConnection

The testSMTPConnection property

public TestSMTPConnectionRequestBuilder TestSMTPConnection { get; }

Property Value

TestSMTPConnectionRequestBuilder

Users

The users property

public UsersRequestBuilder Users { get; }

Property Value

UsersRequestBuilder

UsersManagementPermissions

The usersManagementPermissions property

public UsersManagementPermissionsRequestBuilder UsersManagementPermissions { get; }

Property Value

UsersManagementPermissionsRequestBuilder

Methods

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

Delete the realm

public Task 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

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

Get the top-level representation of the realm It will not include nested information like User and Client representations.

public Task<RealmRepresentation?> 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<RealmRepresentation>

A RealmRepresentation

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

This will only update top-level attributes of the realm.

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

Parameters

body RealmRepresentation

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 realm

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

Get the top-level representation of the realm It will not include nested information like User and Client representations.

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

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

This will only update top-level attributes of the realm.

public RequestInformation ToPutRequestInformation(RealmRepresentation body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

body RealmRepresentation

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

WithRealmItemRequestBuilder

A WithRealmItemRequestBuilder