keycloak_client library
Classes
- ClientConfig
- DesktopConfig
- IAuthCredentialsStore
- Interface for credentials storage, defining methods for saving and retrieving user information and authentication data.
- IDesktopLoginStrategy
-
ILoginStrategy<
TConfig extends PlatformConfig> - Abstract login strategy. Each platform implements its own flow.
- IMobileLoginStrategy
- IPendingGrantStore
-
Persists
PendingGrantrecords across the OAuth redirect. - IWebLoginStrategy
- KeycloakClient
- Keycloak client for handling authentication, token management, and user sessions across all platforms.
- MobileConfig
- Placeholder for future mobile-only login settings.
- PlatformConfig
- UserCredentials
- Models related to authentication credentials and token refresh results.
- UserInfo
- User information model.
- WebConfig
- Placeholder for future web-only login settings.
Enums
Exceptions / Errors
- KeycloakException
- Base class for all exceptions thrown by the Keycloak client.
- KeycloakNetworkException
- Thrown when a network or connectivity error occurs. The operation may be retried.
- KeycloakServerException
- Thrown when the Keycloak server returns an HTTP error response.
- KeycloakSessionExpiredException
- Thrown when the refresh token is expired or absent and the session cannot be restored. The user must log in again.
- KeycloakTimeoutException