OAuthHandler ExchangeCodeAsync signature change

[halter73]

OAuthHandler ExchangeCodeAsync signature change

The signature of OAuthHandler.ExchangeCodeAsync was changed from:

protected virtual System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.OAuth.OAuthTokenResponse> ExchangeCodeAsync(string code, string redirectUri) { throw null; }

To:

protected virtual System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.OAuth.OAuthTokenResponse> ExchangeCodeAsync(Microsoft.AspNetCore.Authentication.OAuth.OAuthCodeExchangeContext context) { throw null; }

Version introduced

3.0

Old behavior

The code and redirectUri strings were passed as separate arguments.

New behavior

Code and RedirectUri are now properties on OAuthCodeExchangeContext that can be set via the OAuthCodeExchangeContext constructor. This new OAuthCodeExchangeContext type is now the only argument passed to OAuthHandler.ExchangeCodeAsync.

Reason for change

To flow additional parameters in a way that allows for similar non-breaking changes to be made in the future without adding new ExchangeCodeAsync overloads.

Recommended action

Construct an OAuthCodeExchangeContext with the appropriate code and redirectUri values. An AuthenticationProperties will also need to be passed in. This single OAuthCodeExchangeContext can then be passed to OAuthHandler.ExchangeCodeAsync instead of multiple arguments.

Category

ASP.NET Core

Affected APIs

OAuthHandler<TOptions>.ExchangeCodeAsync(string code, string redirectUri)

---

Issue metadata

• Issue type: breaking-change