Skip to content

Add request timeout option #79

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

Draft
societ-campbellwray wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add request timeout option #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd4ff9f
Add request timeout option
societ-campbellwray Jul 7, 2026
5412467
Address timeout review fixes
societ-campbellwray Jul 7, 2026
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
56 changes: 34 additions & 22 deletions src/Keycloak.Net.Core/Common/Extensions/FlurlRequestExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,23 @@ private static async Task<string> GetAccessTokenAsync(string url,
}
}

var result = await url.AppendPathSegment($"{options.Prefix}/realms/{realm}/protocol/openid-connect/token")
.WithHeader("Accept", "application/json")
.PostUrlEncodedAsync(new List<KeyValuePair<string, string>>
{
new("grant_type", "password"),
new("username", userName),
new("password", password),
new("client_id", options.AdminClientId)
})
.ReceiveJson<AccessTokenDto>()
.ConfigureAwait(false);
var request = url.AppendPathSegment($"{options.Prefix}/realms/{realm}/protocol/openid-connect/token")
.WithHeader("Accept", "application/json");

if (options.Timeout.HasValue)
{
request = request.WithTimeout(options.Timeout.Value);
}

var result = await request.PostUrlEncodedAsync(new List<KeyValuePair<string, string>>
{
new("grant_type", "password"),
new("username", userName),
new("password", password),
new("client_id", options.AdminClientId)
})
.ReceiveJson<AccessTokenDto>()
.ConfigureAwait(false);

if (canCache)
{
Expand Down Expand Up @@ -88,16 +94,22 @@ private static async Task<string> GetAccessTokenAsync(string url,
}
}

var result = await url.AppendPathSegment($"{options.Prefix}/realms/{realm}/protocol/openid-connect/token")
.WithHeader("Content-Type", "application/x-www-form-urlencoded")
.PostUrlEncodedAsync(new List<KeyValuePair<string, string>>
{
new("grant_type", "client_credentials"),
new("client_secret", clientSecret),
new("client_id", options.AdminClientId)
})
.ReceiveJson<AccessTokenDto>()
.ConfigureAwait(false);
var request = url.AppendPathSegment($"{options.Prefix}/realms/{realm}/protocol/openid-connect/token")
.WithHeader("Content-Type", "application/x-www-form-urlencoded");

if (options.Timeout.HasValue)
{
request = request.WithTimeout(options.Timeout.Value);
}

var result = await request.PostUrlEncodedAsync(new List<KeyValuePair<string, string>>
{
new("grant_type", "client_credentials"),
new("client_secret", clientSecret),
new("client_id", options.AdminClientId)
})
.ReceiveJson<AccessTokenDto>()
.ConfigureAwait(false);

if (canCache)
{
Expand Down Expand Up @@ -158,4 +170,4 @@ public static IFlurlRequest WithForwardedHttpHeaders(this IFlurlRequest request,
}

internal record AccessTokenDto([property: JsonPropertyName("access_token")] string AccessToken);
}
}
38 changes: 27 additions & 11 deletions src/Keycloak.Net.Core/KeycloakClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,25 @@ public KeycloakClient(string url,
public void SetSerializer(ISerializer serializer) =>
_serializer = serializer ?? throw new ArgumentNullException(nameof(serializer));

private IFlurlRequest GetBaseUrl(string authenticationRealm) =>
new Url(_url).AppendPathSegment(_options.Prefix)
.WithSettings(settings => settings.JsonSerializer = _serializer)
.WithAuthentication(_getToken,
_url,
_options.AuthenticationRealm ?? authenticationRealm,
_userName,
_password,
_clientSecret,
_options);
private IFlurlRequest GetBaseUrl(string authenticationRealm)
{
var request = new Url(_url).AppendPathSegment(_options.Prefix)
.WithSettings(settings => settings.JsonSerializer = _serializer)
.WithAuthentication(_getToken,
_url,
_options.AuthenticationRealm ?? authenticationRealm,
_userName,
_password,
_clientSecret,
_options);

if (_options.Timeout.HasValue)
{
request = request.WithTimeout(_options.Timeout.Value);
}

return request;
}

internal record CountDto(int Count);
}
Expand All @@ -83,14 +92,21 @@ public class KeycloakOptions
/// </summary>
public IKeycloakAccessTokenCache? AccessTokenCache { get; }

/// <summary>
/// Specify the maximum time to wait for HTTP requests.
/// </summary>
public TimeSpan? Timeout { get; }

public KeycloakOptions(string prefix = "",
string adminClientId = "admin-cli",
string? authenticationRealm = null,
IKeycloakAccessTokenCache? accessTokenCache = null)
IKeycloakAccessTokenCache? accessTokenCache = null,
TimeSpan? timeout = null)
{
Prefix = prefix.TrimStart('/').TrimEnd('/');
AdminClientId = adminClientId;
AuthenticationRealm = authenticationRealm;
AccessTokenCache = accessTokenCache;
Timeout = timeout;
}
}