Skip to content

Updated readme TargetApiAuthClass example to improve authentication l… #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Adolfok3 merged 1 commit into from
Mar 20, 2025
Merged

Updated readme TargetApiAuthClass example to improve authentication l… #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,26 +39,29 @@ This will make the `TargetApi` HttpClient use the Authorization Interceptor hand
The `TargetApiAuthClass` must implement the `IAuthenticationHandler` interface, so that the package can perform the necessary dependency and know where and when to generate the authorization headers. An example implementation of the class would look like this:

```csharp
public async ValueTask<AuthorizationHeaders?> AuthenticateAsync(AuthorizationHeaders? expiredHeaders, CancellationToken cancellation)
public class TargetApiAuthClass : IAuthenticationHandler
{
HttpResponseMessage? response = null;

if (expiredHeaders == null)
public async ValueTask<AuthorizationHeaders?> AuthenticateAsync(AuthorizationHeaders? expiredHeaders, CancellationToken cancellation)
{
// Generate the login for the first time and return the authorization headers
response = await _client.PostAsync("auth", null, cancellation);
}
else
{
// If a previous login was made, the expiredHeaders will be passed and you can reuse to reauthenticate. It is most commonly used for integrations with APIs that use RefreshToken.
// If the target API does not have the refresh token functionality, you will not need to implement this if condition e you can ignore the parameter 'expiredHeaders' performing always a new login
response = await _client.PostAsync($"refresh?refresh={expiredHeaders.OAuthHeaders!.RefreshToken}", null, cancellation);
}
HttpResponseMessage? response = null;

var content = await response.Content.ReadAsStringAsync(cancellation);
var newHeaders = JsonSerializer.Deserialize<User>(content)!;
if (expiredHeaders == null)
{
// Generate the login for the first time and return the authorization headers
response = await _client.PostAsync("auth", null, cancellation);
}
else
{
// If a previous login was made, the expiredHeaders will be passed and you can reuse to reauthenticate. It is most commonly used for integrations with APIs that use RefreshToken.
// If the target API does not have the refresh token functionality, you will not need to implement this if condition e you can ignore the parameter 'expiredHeaders' performing always a new login
response = await _client.PostAsync($"refresh?refresh={expiredHeaders.OAuthHeaders!.RefreshToken}", null, cancellation);
}

return new OAuthHeaders(newHeaders.AccessToken, newHeaders.TokenType, newHeaders.ExpiresIn, newHeaders.RefreshToken, newHeaders.RefreshTokenExpiresIn);
var content = await response.Content.ReadAsStringAsync(cancellation);
var newHeaders = JsonSerializer.Deserialize<User>(content)!;

return new OAuthHeaders(newHeaders.AccessToken, newHeaders.TokenType, newHeaders.ExpiresIn, newHeaders.RefreshToken, newHeaders.RefreshTokenExpiresIn);
}
}
```

Expand Down
Loading