Skip to content
Aspire
Docs Try Aspire
Docs Try

Install Aspire CLI

macOS

curl -sSL https://aspire.dev/install.sh | bash

Linux

curl -sSL https://aspire.dev/install.sh | bash

Windows

irm https://aspire.dev/install.ps1 | iex
More installation options

AspireKeycloakExtensions Methods

Class Methods 8 members
Provides extension methods for registering Keycloak-related services in an Authentication.AuthenticationBuilder.
AddKeycloakJwtBearer(AuthenticationBuilder, string, string) Section titled AddKeycloakJwtBearer(AuthenticationBuilder, string, string) extension AuthenticationBuilder
Adds Keycloak JWT Bearer authentication to the application. 
public static class AspireKeycloakExtensions
{
    public static AuthenticationBuilder AddKeycloakJwtBearer(
        this AuthenticationBuilder builder,
        string serviceName,
        string realm)
    {
        // ...
    }
}
AspireKeycloakExtensions.cs#L30
Parameters
builder AuthenticationBuilder The Authentication.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.
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".
AddKeycloakJwtBearer(AuthenticationBuilder, string, string, string) Section titled AddKeycloakJwtBearer(AuthenticationBuilder, string, string, string) extension AuthenticationBuilder
Adds Keycloak JWT Bearer authentication to the application. 
public static class AspireKeycloakExtensions
{
    public static AuthenticationBuilder AddKeycloakJwtBearer(
        this AuthenticationBuilder builder,
        string serviceName,
        string realm,
        string authenticationScheme)
    {
        // ...
    }
}
AspireKeycloakExtensions.cs#L44
Parameters
builder AuthenticationBuilder The Authentication.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 authentication scheme name. Default is "Bearer".
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".
AddKeycloakJwtBearer(AuthenticationBuilder, string, string, Action<JwtBearerOptions>) Section titled AddKeycloakJwtBearer(AuthenticationBuilder, string, string, Action<JwtBearerOptions>) extension AuthenticationBuilder
Adds Keycloak JWT Bearer authentication to the application. 
public static class AspireKeycloakExtensions
{
    public static AuthenticationBuilder AddKeycloakJwtBearer(
        this AuthenticationBuilder builder,
        string serviceName,
        string realm,
        Action<JwtBearerOptions>? configureOptions)
    {
        // ...
    }
}
AspireKeycloakExtensions.cs#L58
Parameters
builder AuthenticationBuilder The Authentication.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<JwtBearerOptions> An optional action to configure the JwtBearer.JwtBearerOptions.
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".
AddKeycloakJwtBearer(AuthenticationBuilder, string, string, string, Action<JwtBearerOptions>) Section titled AddKeycloakJwtBearer(AuthenticationBuilder, string, string, string, Action<JwtBearerOptions>) extension AuthenticationBuilder
Adds Keycloak JWT Bearer authentication to the application. 
public static class AspireKeycloakExtensions
{
    public static AuthenticationBuilder AddKeycloakJwtBearer(
        this AuthenticationBuilder builder,
        string serviceName,
        string realm,
        string authenticationScheme,
        Action<JwtBearerOptions>? configureOptions)
    {
        // ...
    }
}
AspireKeycloakExtensions.cs#L79-L98
Parameters
builder AuthenticationBuilder The Authentication.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 authentication scheme name. Default is "Bearer".
configureOptions Action<JwtBearerOptions> An action to configure the JwtBearer.JwtBearerOptions.
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) Section titled AddKeycloakOpenIdConnect(AuthenticationBuilder, string, string) extension AuthenticationBuilder
Adds Keycloak OpenID Connect authentication to the application. 
public static class AspireKeycloakExtensions
{
    public static AuthenticationBuilder AddKeycloakOpenIdConnect(
        this AuthenticationBuilder builder,
        string serviceName,
        string realm)
    {
        // ...
    }
}
AspireKeycloakExtensions.cs#L112
Parameters
builder AuthenticationBuilder The Authentication.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.
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) Section titled AddKeycloakOpenIdConnect(AuthenticationBuilder, string, string, string) extension AuthenticationBuilder
Adds Keycloak OpenID Connect authentication to the application. 
public static class AspireKeycloakExtensions
{
    public static AuthenticationBuilder AddKeycloakOpenIdConnect(
        this AuthenticationBuilder builder,
        string serviceName,
        string realm,
        string authenticationScheme)
    {
        // ...
    }
}
AspireKeycloakExtensions.cs#L126
Parameters
builder AuthenticationBuilder The Authentication.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".
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>) Section titled AddKeycloakOpenIdConnect(AuthenticationBuilder, string, string, Action<OpenIdConnectOptions>) extension AuthenticationBuilder
Adds Keycloak OpenID Connect authentication to the application. 
public static class AspireKeycloakExtensions
{
    public static AuthenticationBuilder AddKeycloakOpenIdConnect(
        this AuthenticationBuilder builder,
        string serviceName,
        string realm,
        Action<OpenIdConnectOptions>? configureOptions)
    {
        // ...
    }
}
AspireKeycloakExtensions.cs#L140
Parameters
builder AuthenticationBuilder The Authentication.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 OpenIdConnect.OpenIdConnectOptions.
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>) Section titled AddKeycloakOpenIdConnect(AuthenticationBuilder, string, string, string, Action<OpenIdConnectOptions>) extension AuthenticationBuilder
Adds Keycloak OpenID Connect authentication to the application. 
public static class AspireKeycloakExtensions
{
    public static AuthenticationBuilder AddKeycloakOpenIdConnect(
        this AuthenticationBuilder builder,
        string serviceName,
        string realm,
        string authenticationScheme,
        Action<OpenIdConnectOptions>? configureOptions)
    {
        // ...
    }
}
AspireKeycloakExtensions.cs#L161-L180
Parameters
builder AuthenticationBuilder The Authentication.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 OpenIdConnect.OpenIdConnectOptions.
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".
Connect with us

Community

SHA — 037d613 © Microsoft