Skip to main content

IIntrospectionHandler Interface

Abblix.Oidc.Server

Abblix.Oidc.Server.Endpoints.Introspection.Interfaces

IIntrospectionHandler Interface

Defines the contract for handling introspection requests to determine the current state and validity of OAuth 2.0 tokens, such as access tokens or refresh tokens.

public interface IIntrospectionHandler

Derived
IntrospectionHandler

Methods

IIntrospectionHandler.HandleAsync(IntrospectionRequest, ClientRequest) Method

Asynchronously processes an introspection request, validating its authorization and the token in question, and then returning the token's state and other relevant information.

System.Threading.Tasks.Task<Abblix.Utils.Result<Abblix.Oidc.Server.Endpoints.Introspection.Interfaces.IntrospectionSuccess,Abblix.Oidc.Server.Common.OidcError>> HandleAsync(Abblix.Oidc.Server.Model.IntrospectionRequest introspectionRequest, Abblix.Oidc.Server.Model.ClientRequest clientRequest);

Parameters

introspectionRequest IntrospectionRequest

The introspection request containing the token and possibly other parameters required for validating the request and introspecting the token.

clientRequest ClientRequest

Additional information about the client making the request, which may be necessary for validating the request in certain contexts.

Returns

System.Threading.Tasks.Task<Abblix.Utils.Result<IntrospectionSuccess,OidcError>>
A System.Threading.Tasks.Task that, when completed successfully, results in an IntrospectionSuccess or an OidcError. The success response contains information about the token's current state, such as whether it is active, and potentially other metadata. In case of an invalid request, the error response will detail the reasons for rejection.

Remarks

Implementations of this interface play a critical role in the security of OAuth 2.0 and OIDC systems by enabling resource servers and other relying parties to verify the validity and metadata of tokens. This helps prevent unauthorized access and ensures that tokens are used in accordance with their intended scopes and lifetimes.