Skip to main content

IUserCodeVerificationService Interface

Abblix.Oidc.Server

Abblix.Oidc.Server.Features.DeviceAuthorization.Interfaces

IUserCodeVerificationService Interface

Defines the contract for a service that handles user code verification in the Device Authorization Grant flow (RFC 8628).

public interface IUserCodeVerificationService

Derived
UserCodeVerificationService

Methods

IUserCodeVerificationService.ApproveAsync(string, AuthorizedGrant) Method

Approves the device authorization request, linking the user's authorization to the pending device.

System.Threading.Tasks.Task<bool> ApproveAsync(string userCode, Abblix.Oidc.Server.Endpoints.Token.Interfaces.AuthorizedGrant authorizedGrant);

Parameters

userCode System.String

The user-entered verification code.

authorizedGrant AuthorizedGrant

The authorized grant containing the user's authentication session and context.

Returns

System.Threading.Tasks.Task<System.Boolean>
A task that returns true if the approval was successful; false if the code is invalid or expired.

IUserCodeVerificationService.DenyAsync(string) Method

Denies the device authorization request.

System.Threading.Tasks.Task<bool> DenyAsync(string userCode);

Parameters

userCode System.String

The user-entered verification code.

Returns

System.Threading.Tasks.Task<System.Boolean>
A task that returns true if the denial was successful; false if the code is invalid or expired.

IUserCodeVerificationService.VerifyAsync(string) Method

Verifies a user code and returns the associated device authorization request details.

System.Threading.Tasks.Task<Abblix.Oidc.Server.Features.DeviceAuthorization.UserCodeVerificationResult> VerifyAsync(string userCode);

Parameters

userCode System.String

The user-entered verification code.

Returns

System.Threading.Tasks.Task<UserCodeVerificationResult>
A task that returns the verification result containing request details if valid, or an appropriate error if the code is invalid, expired, or already used.