AspireKeycloakExtensions.AddKeycloakOpenIdConnect Method

Definition

Namespace:

Microsoft.Extensions.DependencyInjection

Assembly:

Aspire.Keycloak.Authentication.dll

Package:

Aspire.Keycloak.Authentication v8.2.2-preview.1.24521.5

Overloads

AddKeycloakOpenIdConnect(AuthenticationBuilder, String, String)	Adds Keycloak OpenID Connect authentication to the application.
AddKeycloakOpenIdConnect(AuthenticationBuilder, String, String, Action<OpenIdConnectOptions>)	Adds Keycloak OpenID Connect authentication to the application.
AddKeycloakOpenIdConnect(AuthenticationBuilder, String, String, String)	Adds Keycloak OpenID Connect authentication to the application.
AddKeycloakOpenIdConnect(AuthenticationBuilder, String, String, String, Action<OpenIdConnectOptions>)	Adds Keycloak OpenID Connect authentication to the application.

AddKeycloakOpenIdConnect(AuthenticationBuilder, String, String)

Source:

AspireKeycloakExtensions.cs

Adds Keycloak OpenID Connect authentication to the application.

public static Microsoft.AspNetCore.Authentication.AuthenticationBuilder AddKeycloakOpenIdConnect (this Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder, string serviceName, string realm);

static member AddKeycloakOpenIdConnect : Microsoft.AspNetCore.Authentication.AuthenticationBuilder * string * string -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder

<Extension()>
Public Function AddKeycloakOpenIdConnect (builder As AuthenticationBuilder, serviceName As String, realm As String) As AuthenticationBuilder

Parameters

builder

AuthenticationBuilder

The AuthenticationBuilder to add services to.

serviceName

String

The name of the service used to resolve the Keycloak server URL.

realm

String

The realm of the Keycloak server to connect to.

Returns

AuthenticationBuilder

Remarks

The serviceName is used to resolve the Keycloak server URL and is combined with the realm to form the authority URL. For example, if serviceName is "keycloak" and realm is "myrealm", the authority URL will be "https+http://keycloak/realms/myrealm".

AddKeycloakOpenIdConnect(AuthenticationBuilder, String, String, Action<OpenIdConnectOptions>)

Source:

AspireKeycloakExtensions.cs

Adds Keycloak OpenID Connect authentication to the application.

public static Microsoft.AspNetCore.Authentication.AuthenticationBuilder AddKeycloakOpenIdConnect (this Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder, string serviceName, string realm, Action<Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions>? configureOptions);

static member AddKeycloakOpenIdConnect : Microsoft.AspNetCore.Authentication.AuthenticationBuilder * string * string * Action<Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions> -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder

<Extension()>
Public Function AddKeycloakOpenIdConnect (builder As AuthenticationBuilder, serviceName As String, realm As String, configureOptions As Action(Of OpenIdConnectOptions)) As AuthenticationBuilder

Parameters

builder

AuthenticationBuilder

The AuthenticationBuilder to add services to.

serviceName

String

The name of the service used to resolve the Keycloak server URL.

realm

String

The realm of the Keycloak server to connect to.

configureOptions

Action<OpenIdConnectOptions>

An action to configure the OpenIdConnectOptions.

Returns

AuthenticationBuilder

Remarks

The serviceName is used to resolve the Keycloak server URL and is combined with the realm to form the authority URL. For example, if serviceName is "keycloak" and realm is "myrealm", the authority URL will be "https+http://keycloak/realms/myrealm".

AddKeycloakOpenIdConnect(AuthenticationBuilder, String, String, String)

Source:

AspireKeycloakExtensions.cs

Adds Keycloak OpenID Connect authentication to the application.

public static Microsoft.AspNetCore.Authentication.AuthenticationBuilder AddKeycloakOpenIdConnect (this Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder, string serviceName, string realm, string authenticationScheme);

static member AddKeycloakOpenIdConnect : Microsoft.AspNetCore.Authentication.AuthenticationBuilder * string * string * string -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder

<Extension()>
Public Function AddKeycloakOpenIdConnect (builder As AuthenticationBuilder, serviceName As String, realm As String, authenticationScheme As String) As AuthenticationBuilder

Parameters

builder

AuthenticationBuilder

The AuthenticationBuilder to add services to.

serviceName

String

The name of the service used to resolve the Keycloak server URL.

realm

String

The realm of the Keycloak server to connect to.

authenticationScheme

String

The OpenID Connect authentication scheme name. Default is "OpenIdConnect".

Returns

AuthenticationBuilder

Remarks

The serviceName is used to resolve the Keycloak server URL and is combined with the realm to form the authority URL. For example, if serviceName is "keycloak" and realm is "myrealm", the authority URL will be "https+http://keycloak/realms/myrealm".

AddKeycloakOpenIdConnect(AuthenticationBuilder, String, String, String, Action<OpenIdConnectOptions>)

Source:

AspireKeycloakExtensions.cs

Adds Keycloak OpenID Connect authentication to the application.

public static Microsoft.AspNetCore.Authentication.AuthenticationBuilder AddKeycloakOpenIdConnect (this Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder, string serviceName, string realm, string authenticationScheme, Action<Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions>? configureOptions);

static member AddKeycloakOpenIdConnect : Microsoft.AspNetCore.Authentication.AuthenticationBuilder * string * string * string * Action<Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions> -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder

<Extension()>
Public Function AddKeycloakOpenIdConnect (builder As AuthenticationBuilder, serviceName As String, realm As String, authenticationScheme As String, configureOptions As Action(Of OpenIdConnectOptions)) As AuthenticationBuilder

Parameters

builder

AuthenticationBuilder

The AuthenticationBuilder to add services to.

serviceName

String

The name of the service used to resolve the Keycloak server URL.

realm

String

The realm of the Keycloak server to connect to.

authenticationScheme

String

The OpenID Connect authentication scheme name. Default is "OpenIdConnect".

configureOptions

Action<OpenIdConnectOptions>

An action to configure the OpenIdConnectOptions.

Returns

AuthenticationBuilder

Remarks

The serviceName is used to resolve the Keycloak server URL and is combined with the realm to form the authority URL. For example, if serviceName is "keycloak" and realm is "myrealm", the authority URL will be "https+http://keycloak/realms/myrealm".