Class ServiceCollectionExtensions

Namespace

Keycloak.AuthServices.Sdk

Assembly

Keycloak.AuthServices.Sdk.dll

Adds HTTP Client SDKs

public static class ServiceCollectionExtensions

Inheritance

object

ServiceCollectionExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddKeycloakAdminHttpClient(IServiceCollection, KeycloakAdminClientOptions, Action<HttpClient>?)

Adds IKeycloakClient, IKeycloakRealmClient, IKeycloakUserClient, IKeycloakGroupClient HTTP clients for Keycloak Admin API.

public static IHttpClientBuilder AddKeycloakAdminHttpClient(this IServiceCollection services, KeycloakAdminClientOptions keycloakOptions, Action<HttpClient>? configureClient = null)

Parameters

services IServiceCollection

The IServiceCollection to add the HttpClient to.

keycloakOptions KeycloakAdminClientOptions

The Keycloak client options.

configureClient Action<HttpClient>

An optional action to configure the HttpClient.

Returns

IHttpClientBuilder

The IHttpClientBuilder for further configuration.

AddKeycloakAdminHttpClient(IServiceCollection, IConfiguration, Action<HttpClient>?, string)

Adds IKeycloakClient, IKeycloakRealmClient, IKeycloakUserClient, IKeycloakGroupClient HTTP clients for Keycloak Admin API.

public static IHttpClientBuilder AddKeycloakAdminHttpClient(this IServiceCollection services, IConfiguration configuration, Action<HttpClient>? configureClient = null, string keycloakClientSectionName = "Keycloak")

Parameters

services IServiceCollection

The IServiceCollection to add the HttpClient to.

configuration IConfiguration

The IConfiguration instance to bind the Keycloak options from.

configureClient Action<HttpClient>

An optional action to configure the HttpClient.

keycloakClientSectionName string

The name of the configuration section containing the Keycloak client options.

Returns

IHttpClientBuilder

The IHttpClientBuilder for further configuration.

AddKeycloakAdminHttpClient(IServiceCollection, IConfigurationSection, Action<HttpClient>?)

Adds IKeycloakClient, IKeycloakRealmClient, IKeycloakUserClient, IKeycloakGroupClient HTTP clients for Keycloak Admin API.

public static IHttpClientBuilder AddKeycloakAdminHttpClient(this IServiceCollection services, IConfigurationSection configurationSection, Action<HttpClient>? configureClient = null)

Parameters

services IServiceCollection

The IServiceCollection to add the HttpClient to.

configurationSection IConfigurationSection

The IConfigurationSection to bind the Keycloak options from.

configureClient Action<HttpClient>

An optional action to configure the HttpClient.

Returns

IHttpClientBuilder

The IHttpClientBuilder for further configuration.

AddKeycloakAdminHttpClient(IServiceCollection, Action<KeycloakAdminClientOptions>, Action<HttpClient>?)

Adds IKeycloakClient, IKeycloakRealmClient, IKeycloakUserClient, IKeycloakGroupClient for Keycloak Admin API.

public static IHttpClientBuilder AddKeycloakAdminHttpClient(this IServiceCollection services, Action<KeycloakAdminClientOptions> configureKeycloakOptions, Action<HttpClient>? configureClient = null)

Parameters

services IServiceCollection

The IServiceCollection to add the HttpClient to.

configureKeycloakOptions Action<KeycloakAdminClientOptions>

An action to configure the Keycloak client options.

configureClient Action<HttpClient>

An optional action to configure the HttpClient.

Returns

IHttpClientBuilder

The IHttpClientBuilder for further configuration.

AddKeycloakProtectionHttpClient(IServiceCollection, KeycloakProtectionClientOptions, Action<HttpClient>?)

Adds IKeycloakProtectionClient, IKeycloakProtectedResourceClient, IKeycloakPolicyClient HTTP clients for Protection API.

public static IHttpClientBuilder AddKeycloakProtectionHttpClient(this IServiceCollection services, KeycloakProtectionClientOptions keycloakOptions, Action<HttpClient>? configureClient = null)

Parameters

services IServiceCollection

The IServiceCollection to add the HttpClient to.

keycloakOptions KeycloakProtectionClientOptions

The Keycloak client options.

configureClient Action<HttpClient>

An optional action to configure the HttpClient.

Returns

IHttpClientBuilder

The IHttpClientBuilder for further configuration.

AddKeycloakProtectionHttpClient(IServiceCollection, IConfiguration, Action<HttpClient>?, string)

Adds IKeycloakProtectionClient, IKeycloakProtectedResourceClient, IKeycloakPolicyClient HTTP clients for Protection API.

public static IHttpClientBuilder AddKeycloakProtectionHttpClient(this IServiceCollection services, IConfiguration configuration, Action<HttpClient>? configureClient = null, string keycloakClientSectionName = "Keycloak")

Parameters

services IServiceCollection

The IServiceCollection to add the HttpClient to.

configuration IConfiguration

The IConfiguration instance to bind the Keycloak options from.

configureClient Action<HttpClient>

An optional action to configure the HttpClient.

keycloakClientSectionName string

The name of the configuration section containing the Keycloak client options.

Returns

IHttpClientBuilder

The IHttpClientBuilder for further configuration.

AddKeycloakProtectionHttpClient(IServiceCollection, IConfigurationSection, Action<HttpClient>?)

Adds IKeycloakProtectionClient, IKeycloakProtectedResourceClient, IKeycloakPolicyClient HTTP clients for Protection API.

public static IHttpClientBuilder AddKeycloakProtectionHttpClient(this IServiceCollection services, IConfigurationSection configurationSection, Action<HttpClient>? configureClient = null)

Parameters

services IServiceCollection

The IServiceCollection to add the HttpClient to.

configurationSection IConfigurationSection

The IConfigurationSection to bind the Keycloak options from.

configureClient Action<HttpClient>

An optional action to configure the HttpClient.

Returns

IHttpClientBuilder

The IHttpClientBuilder for further configuration.

AddKeycloakProtectionHttpClient(IServiceCollection, Action<KeycloakProtectionClientOptions>, Action<HttpClient>?)

Adds IKeycloakProtectionClient, IKeycloakProtectedResourceClient, IKeycloakPolicyClient HTTP clients for Protection API.

public static IHttpClientBuilder AddKeycloakProtectionHttpClient(this IServiceCollection services, Action<KeycloakProtectionClientOptions> configureKeycloakOptions, Action<HttpClient>? configureClient = null)

Parameters

services IServiceCollection

The IServiceCollection to add the HttpClient to.

configureKeycloakOptions Action<KeycloakProtectionClientOptions>

An action to configure the Keycloak client options.

configureClient Action<HttpClient>

An optional action to configure the HttpClient.

Returns

IHttpClientBuilder

The IHttpClientBuilder for further configuration.

AddKeycloakUmaTicketExchangeHttpClient(IServiceCollection, IConfiguration, Action<HttpClient>?, string)

Adds IUmaTicketExchangeClient HTTP client for UMA ticket exchange at the Keycloak token endpoint.

public static IHttpClientBuilder AddKeycloakUmaTicketExchangeHttpClient(this IServiceCollection services, IConfiguration configuration, Action<HttpClient>? configureClient = null, string keycloakClientSectionName = "Keycloak")

Parameters

services IServiceCollection

The IServiceCollection to add the HttpClient to.

configuration IConfiguration

The IConfiguration instance to bind the Keycloak options from.

configureClient Action<HttpClient>

An optional action to configure the HttpClient.

keycloakClientSectionName string

The name of the configuration section containing the Keycloak client options.

Returns

IHttpClientBuilder

The IHttpClientBuilder for further configuration.

AddKeycloakUmaTicketExchangeHttpClient(IServiceCollection, IConfigurationSection, Action<HttpClient>?)

Adds IUmaTicketExchangeClient HTTP client for UMA ticket exchange at the Keycloak token endpoint.

public static IHttpClientBuilder AddKeycloakUmaTicketExchangeHttpClient(this IServiceCollection services, IConfigurationSection configurationSection, Action<HttpClient>? configureClient = null)

Parameters

services IServiceCollection

The IServiceCollection to add the HttpClient to.

configurationSection IConfigurationSection

The IConfigurationSection to bind the Keycloak options from.

configureClient Action<HttpClient>

An optional action to configure the HttpClient.

Returns

IHttpClientBuilder

The IHttpClientBuilder for further configuration.

AddKeycloakUmaTicketExchangeHttpClient(IServiceCollection, Action<KeycloakProtectionClientOptions>, Action<HttpClient>?)

Adds IUmaTicketExchangeClient HTTP client for UMA ticket exchange at the Keycloak token endpoint.

public static IHttpClientBuilder AddKeycloakUmaTicketExchangeHttpClient(this IServiceCollection services, Action<KeycloakProtectionClientOptions> configureKeycloakOptions, Action<HttpClient>? configureClient = null)

Parameters

services IServiceCollection

The IServiceCollection to add the HttpClient to.

configureKeycloakOptions Action<KeycloakProtectionClientOptions>

An action to configure the Keycloak client options.

configureClient Action<HttpClient>

An optional action to configure the HttpClient.

Returns

IHttpClientBuilder

The IHttpClientBuilder for further configuration.