library/xyz.malefic.koven.auth

Package-level declarations

Types

ApiKeyAuth

object ApiKeyAuth : HeaderField<String>

A header field for API key authentication.

ApiKeyIdPath

data class ApiKeyIdPath(val keyId: String)

Path parameters identifying a single API key.

AuthType

sealed interface AuthType

The configuration for authentication.

BearerAuth

object BearerAuth : HeaderField<String>

An example header for bearer authentication.

OAuthFinalizeQuery

data class OAuthFinalizeQuery(val username: String? = null, val next: String? = null, val error: String? = null, val provider: String? = null)

Query parameters for OAuth finalization.

OAuthLoginPath

data class OAuthLoginPath(val provider: String)

Path parameters for OAuth login.

OAuthProvider

interface OAuthProvider

An interface for defining OAuth2 providers.

Principal

interface Principal

Represents an authenticated user (principal) in the system.

SimplePrincipal

@Serializable

data class SimplePrincipal(val userId: Uuid, val username: String) : Principal

A simple implementation of Principal.

Properties

ApiKeyCreateContract

val ApiKeyCreateContract: ApiContract<ApiKeyRequestModel, ApiKeyCreatedModel, Empty, Empty, Empty, Empty, Empty>

A contract for creating a new API key for the currently authenticated principal.

ApiKeyListContract

val ApiKeyListContract: ApiContract<Unit, List<ApiKeyInfoModel>, Empty, Empty, Empty, Empty, Empty>

A contract for listing the API keys owned by the currently authenticated principal.

ApiKeyRevokeContract

val ApiKeyRevokeContract: ApiContract<Unit, Unit, Empty, Empty, ApiKeyIdPath, Empty, Empty>

A contract for revoking an API key owned by the currently authenticated principal.

defaultPasswordValidation

expect val defaultPasswordValidation: Validation<UserRequestModel>

The default validation for user registration.

actual val defaultPasswordValidation: Validation<UserRequestModel>

The default validation for user registration on JS.

actual val defaultPasswordValidation: Validation<UserRequestModel>

The default validation for user registration on the JVM.

LogoutContract

val LogoutContract: ApiContract<Unit, Unit, Empty, Empty, Empty, Empty, Empty>

A contract for the logout endpoint.

OAuthFinalizeContract

val OAuthFinalizeContract: ApiContract<Unit, Unit, Empty, String, Empty, OAuthFinalizeQuery, Empty>

A contract for the OAuth callback finalization endpoint.

OAuthLinkContract

val OAuthLinkContract: ApiContract<Unit, Unit, Empty, String, OAuthLoginPath, Empty, Empty>

A contract for linking an OAuth provider to an existing account.

OAuthLoginContract

val OAuthLoginContract: ApiContract<Unit, Unit, Empty, String, OAuthLoginPath, Empty, Empty>

A contract for the OAuth login initiation endpoint.

PasswordLoginContract

val PasswordLoginContract: ApiContract<UserRequestModel, TokenResponseModel, Empty, Empty, Empty, Empty, Empty>

A contract for the user login endpoint.

PasswordRegisterContract

val PasswordRegisterContract: ApiContract<UserRequestModel, TokenResponseModel, Empty, Empty, Empty, Empty, Empty>

A contract for the user registration endpoint.

PasswordStrengthContract

val PasswordStrengthContract: ApiContract<String, Pair<Int, String?>, Empty, Empty, Empty, Empty, Empty>

A contract for the password strength endpoint.

RefreshContract

val RefreshContract: ApiContract<Unit, TokenResponseModel, Empty, Empty, Empty, Empty, Empty>

A contract for the token refresh endpoint.