Skip to main content

Module types

Module types 

Source

Structs§

ApiKey
API key response shape.
ApiKeyStartingCharacters
UTF-16 code units selected from the beginning of a generated API key.
AuthRequest
Authentication request wrapper
AuthResponse
Authentication response wrapper
CodeMessageResponse
Middleware error response { code: String, message: String }.
CreateAccount
Account creation data
CreateApiKey
API key creation data.
CreateDeviceCode
Input for creating a new device authorization code.
CreateInvitation
Invitation creation data
CreateJwk
CreateMember
Member creation data
CreateOrganization
Organization creation data
CreateOrganizationRole
CreatePasskey
Input for creating a new passkey.
CreateSession
Session creation data
CreateTeam
CreateTwoFactor
Two-factor authentication creation data.
CreateUser
User creation data
CreateVerification
Verification token creation data
CreateWalletAddress
DeviceCode
Device authorization code storage shape.
ErrorCodeMessageResponse
Error body { code: String, message: String } matching the TS better-auth error response shape.
ErrorMessageResponse
Error body { message: String }.
Headers
Response headers preserving repeated header names such as Set-Cookie.
HealthCheckResponse
Health-check response for /health.
Invitation
Organization invitation
Jwk
Private keyring persistence. Public JWKS responses must select public material explicitly.
ListUsersParams
Parameters for listing users through the configured adapter.
Member
Organization member
MultipartFile
MultipartFiles
Multipart file contents retained for application handlers alongside decoded fields.
OkResponse
Generic { ok: bool } response used by /ok and /error endpoints.
Organization
Organization entity - matches OpenAPI schema
OrganizationRole
Passkey
Passkey response shape.
RateLimitErrorResponse
Rate-limit error response with retryAfter field.
RequestExtensions
Typed state shared only by trusted handlers in one request dispatch.
RequestMeta
Metadata extracted from an incoming request for session creation.
StatusMessageResponse
{ status: bool, message: String } response (e.g. change-email).
StatusResponse
Generic { status: bool } response.
StoredOrganizationPermissions
Literal organization-role permission JSON from storage.
SuccessMessageResponse
{ success: bool, message: String } response (e.g. delete-user).
SuccessResponse
Generic { success: bool } response (e.g. sign-out).
Team
A team within one organization. The durable capacity counter is private to storage.
TeamMember
A user membership in a team. The uniqueness key is never returned on the wire.
TwoFactor
Two-factor authentication response shape.
UpdateAccount
Account update data (for refreshing OAuth tokens)
UpdateApiKey
API key update data.
UpdateDeviceCode
Input for updating an existing device authorization code.
UpdateOrganization
Organization update data
UpdateOrganizationRole
UpdatePasskey
Input for updating a passkey.
UpdatePasskeyAuthentication
Input for updating stored passkey credential state after authentication.
UpdateTeam
UpdateTwoFactor
Mutate one exact factor generation without resetting its lockout state.
UpdateUser
User update data
UpdateUserRequest
UpdateUserResponse
UpdateVerification
ValidationErrorResponse
Validation error response { code, message, errors }.
WalletAddress
An address linked to a SIWE identity on one chain.

Enums§

AddTeamMemberResult
ApiKeyStartText
How API-key starting characters are persisted.
HttpMethod
HTTP method enumeration
InvitationStatus
Invitation status
OrganizationRoleSelector
Role references are always paired with an organization by store operations.
ParsedRequestBody
Body decoded by trusted dispatch after its media policy has been checked. Original request bytes and headers remain available to application hooks.
UserFilterValue
String operands for admin user-list filtering.

Type Aliases§

OrganizationPermissions
Preserve insertion order because upstream stores permission JSON as a string.