Skip to content

BackChannelAuthenticationResponseFormatter Class

Handles the formatting of responses for back-channel authentication requests. This class ensures that the appropriate HTTP responses are generated based on the type of back-channel authentication response, encapsulating success or error scenarios as defined by OAuth 2.0 standards.

C#
public class BackChannelAuthenticationResponseFormatter : Abblix.Oidc.Server.Mvc.Formatters.Interfaces.IBackChannelAuthenticationResponseFormatter

Inheritance System.Object → BackChannelAuthenticationResponseFormatter

Implements IBackChannelAuthenticationResponseFormatter

Constructors

BackChannelAuthenticationResponseFormatter(IIssuerProvider) Constructor

Handles the formatting of responses for back-channel authentication requests. This class ensures that the appropriate HTTP responses are generated based on the type of back-channel authentication response, encapsulating success or error scenarios as defined by OAuth 2.0 standards.

C#
public BackChannelAuthenticationResponseFormatter(Abblix.Oidc.Server.Features.Issuer.IIssuerProvider issuerProvider);

Parameters

issuerProvider IIssuerProvider

Methods

BackChannelAuthenticationResponseFormatter.FormatResponseAsync(BackChannelAuthenticationRequest, ClientRequest, Result<BackChannelAuthenticationSuccess,OidcError>) Method

This method transforms the back-channel authentication response into a suitable HTTP response, ensuring that different outcomes (success or various types of errors) are appropriately represented as HTTP status codes and payloads.

C#
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ActionResult> FormatResponseAsync(Abblix.Oidc.Server.Model.BackChannelAuthenticationRequest request, Abblix.Oidc.Server.Model.ClientRequest clientRequest, Abblix.Utils.Result<Abblix.Oidc.Server.Model.BackChannelAuthenticationSuccess,Abblix.Oidc.Server.Common.OidcError> response);

Parameters

request BackChannelAuthenticationRequest

The original back-channel authentication request that triggered the response.

clientRequest ClientRequest

The client request containing authentication details.

response Abblix.Utils.Result<BackChannelAuthenticationSuccess,OidcError>

The back-channel authentication response result that needs to be formatted into an HTTP result.

Implements FormatResponseAsync(BackChannelAuthenticationRequest, ClientRequest, Result<BackChannelAuthenticationSuccess,OidcError>)

Returns

System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ActionResult>
A System.Threading.Tasks.Task representing the asynchronous operation, with the formatted response as an Microsoft.AspNetCore.Mvc.ActionResult.

Remarks

This method formats successful authentication requests as 200 OK, client-related errors as 401 Unauthorized or 403 Forbidden, and general errors as 400 Bad Request. Per RFC 9110 Section 11.6.1, all 401 responses include a WWW-Authenticate header matching the client's authentication scheme per RFC 6749 Section 5.2.