Class AuthorizationServerClient

Namespace

Keycloak.AuthServices.Authorization.AuthorizationServer

Assembly

Keycloak.AuthServices.Authorization.dll

Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.

public class AuthorizationServerClient : IAuthorizationServerClient

Inheritance

object

AuthorizationServerClient

Implements

IAuthorizationServerClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AuthorizationServerClient(HttpClient, IOptions<KeycloakAuthorizationServerOptions>, ILogger<AuthorizationServerClient>)

public AuthorizationServerClient(HttpClient httpClient, IOptions<KeycloakAuthorizationServerOptions> clientOptions, ILogger<AuthorizationServerClient> logger)

Parameters

httpClient HttpClient

clientOptions IOptions<KeycloakAuthorizationServerOptions>

logger ILogger<AuthorizationServerClient>

Exceptions

ArgumentNullException

Methods

VerifyAccessToResource(string, string, ScopesValidationMode?, string?, CancellationToken)

Verifies access to the protected resource. Sends decision request to token endpoint {resource}#{scope}

public Task<bool> VerifyAccessToResource(string resource, string scope, ScopesValidationMode? scopesValidationMode = null, string? audience = null, CancellationToken cancellationToken = default)

Parameters

resource string

scope string

scopesValidationMode ScopesValidationMode?

audience string

The Keycloak client ID of the target resource server to use as the UMA audience parameter. When null, the global KeycloakAuthorizationServerOptions.Resource value is used.

cancellationToken CancellationToken

Returns

Task<bool>

Exceptions

ArgumentNullException

VerifyAccessToResource(string, string, string, ScopesValidationMode?, CancellationToken)

Verifies access to the protected resource using an explicit access token. Use this overload in SignalR or other long-lived connection scenarios where the token from HttpContext may be stale.

public Task<bool> VerifyAccessToResource(string resource, string scope, string accessToken, ScopesValidationMode? scopesValidationMode = null, CancellationToken cancellationToken = default)

Parameters

resource string

scope string

accessToken string

The access token to use for the authorization request.

scopesValidationMode ScopesValidationMode?

cancellationToken CancellationToken

Returns

Task<bool>

Exceptions

ArgumentNullException