Class KeycloakInstallationOptions

Namespace

Keycloak.AuthServices.Common

Assembly

Keycloak.AuthServices.Common.dll

Installation options provided by Keycloak

public class KeycloakInstallationOptions

Inheritance

object

KeycloakInstallationOptions

Derived

KeycloakAuthenticationOptions

KeycloakAuthorizationServerOptions

KeycloakAuthorizationOptions

KeycloakAdminClientOptions

KeycloakProtectionClientOptions

KeycloakAdminClientOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

See "/.well-known/openid-configuration"

Properties

AuthServerUrl

Authorization server URL

[ConfigurationKeyName("AuthServerUrl")]
public string? AuthServerUrl { get; set; }

Property Value

string

Examples

"auth-server-url": "http://localhost:8088/auth/"

Remarks

The value is normalized, the trailing '/' is ensured.

Credentials

Credentials, defined for private client

public KeycloakClientInstallationCredentials Credentials { get; set; }

Property Value

KeycloakClientInstallationCredentials

KeycloakTokenEndpoint

Token endpoint URL including Realm

public string KeycloakTokenEndpoint { get; }

Property Value

string

KeycloakUrlRealm

Realm URL

public string KeycloakUrlRealm { get; }

Property Value

string

Realm

Keycloak Realm

public string Realm { get; set; }

Property Value

string

Resource

Resource as client id

public string Resource { get; set; }

Property Value

string

Examples

"resource": "client-id"

SslRequired

Require HTTPS

[ConfigurationKeyName("SslRequired")]
public string SslRequired { get; set; }

Property Value

string

TokenClockSkew

Optional

[ConfigurationKeyName("TokenClockSkew")]
public TimeSpan TokenClockSkew { get; set; }

Property Value

TimeSpan

Remarks

• Default: 0 seconds

VerifyTokenAudience

Audience verification

[ConfigurationKeyName("VerifyTokenAudience")]
public bool? VerifyTokenAudience { get; set; }

Property Value

bool?