httpapi

package

Go to main page

Versions in this module

v1

v1.0.2

Sep 30, 2026

Changes in this version

+ const RL2FASetupEmail

+ const RL2FASetupSMS

+ const RL2FASetupTOTP

+ const RLAPIKeyCreate

+ const RLDeviceKeyManage

+ const RLMeContactChange

+ const RLMeDelete

+ const RLMePasswordChange

+ const RLMeProviderUnlink

+ const RLMeRead

+ const RLMeUpdate

+ const RLRegisterAbandon

+ const RLRegisterAvailability

+ const RLRegisterCreate

+ const RLSessionList

+ const RLSessionLogout

+ const RLSessionRevoke

+ const RLSessionRevokeAll

+ const RLStepUpPassword

+ const RLTokenRefresh

+ var PathEnums = map[string][]string

type UserListQuery

+ Total bool

v0

v0.149.0

Sep 30, 2026

Changes in this version

+ const RLAdminRead

+ const RLAdminWrite

+ const RLStepUp2FASend

+ const RLUserUpdate

+ func ErrorMetadata() map[errmodel.Code]any

+ type AdminUserUpdateRequest struct

+ AvatarURL *string

+ Email *string

+ PhoneNumber *string

+ PreferredLanguage *string

+ Username *string

+ type AuthResult struct

+ Created bool

+ DeviceKey *iam.DeviceKey

+ Enrollment *EnrollmentStep

+ FreshAuth *FreshAuth

+ Recovery *authflow.AccountRecoveryConfirmation

+ ReturnTo *string

+ SecondFactor *SecondFactorStep

+ Status AuthStatus

+ TokenSet *iam.TokenSet

+ User *iam.User

+ Verification *VerificationStep

+ type AuthStatus string

+ const AuthAccountRecoveryRequired

+ const AuthComplete

+ const AuthEnrollmentRequired

+ const AuthSecondFactorRequired

+ const AuthVerificationRequired

+ type EmailChangeRequest struct

+ Email string

+ type EnrollmentStep struct

+ AllowedMethods []iam.TwoFactorMethod

+ TokenSet iam.TokenSet

type GroupOp

+ const OpInvitationCreate

+ const OpInvitationRevoke

+ const OpInvitationsList

+ const OpMemberSet

+ func (op GroupOp) Mutates() bool

type InvitationCreateRequest

+ Email string

+ type InvitationRedeemRequest struct

+ Code string

type MemberListQuery

+ Expand []string

+ type MemberRoleRequest struct

+ Role string

+ type OIDCExchangeRequest struct

+ Code string

+ type OIDCLoginStartRequest struct

+ InviteCode string

+ PopupNonce string

+ ReturnTo string

+ UI string

type PasswordlessStartRequest

+ InviteCode string

type PermissionSet

+ Role *iam.Role

+ type PhoneChangeRequest struct

+ PhoneNumber string

+ type ProfileUpdateRequest struct

+ AvatarURL *string

+ PreferredLanguage *string

+ Username *string

+ type ProviderError struct

+ ProviderError string

type RegisterRequest

+ InviteCode string

type RouteSpec

+ StepUp bool

+ type SecondFactorStep struct

+ Challenge string

+ Factor TwoFactorFactor

+ Factors []TwoFactorFactor

+ UserID string

+ type SessionEventQuery struct

+ Kind []string

+ type SignInKey struct

+ CreatedAt time.Time

+ Current bool

+ ID string

+ Kind SignInKeyKind

+ Label *string

+ LastUsedAt *time.Time

+ type SignInKeyKind string

+ const SignInKeyDeviceKey

+ const SignInKeyPasskey

type TwoFactorFactor

+ Destination *string

+ type TwoFactorFactorCreateRequest struct

+ Code string

+ Default bool

+ Method string

+ PhoneNumber *string

+ type TwoFactorFactorCreated struct

+ Auth *AuthResult

+ BackupCodes []string

+ Factor TwoFactorFactor

+ type TwoFactorFactorUpdateRequest struct

+ Default bool

+ type TwoFactorRequired struct

+ Method string

+ type TwoFactorSendRequest struct

+ Method string

+ type TwoFactorSetup struct

+ Destination *string

+ Method string

+ OTPAuthURI *string

+ Secret *string

+ type TwoFactorSetupRequest struct

+ Method string

+ PhoneNumber *string

+ type UserSecurity = authflow.UserSecurity

+ type UsersQuery struct

+ IDs string

+ Username string

+ type VerificationStep struct

+ Channel string

+ Identifier string

v0.148.0

Sep 30, 2026

Changes in this version

+ var Features = []Feature

+ func Conform(t reflect.Type, v any) []string

+ func IsPage(t reflect.Type) bool

+ func PageItem(t reflect.Type) reflect.Type

+ type APIKeyCreateRequest struct

+ ExpiresAt *time.Time

+ Name string

+ Role string

+ type Availability struct

+ Email *AvailabilityField

+ PhoneNumber *AvailabilityField

+ Username *AvailabilityField

+ type AvailabilityField struct

+ Available bool

+ Error *string

+ type AvailabilityQuery struct

+ Email string

+ PhoneNumber string

+ Username string

+ type BackupCodes struct

+ BackupCodes []string

+ type BanRequest struct

+ KeepExisting bool

+ Reason string

+ Until *string

+ type Capabilities struct

+ Channels ChannelCapabilities

+ ExternalLoginProviders []ExternalLoginProvider

+ Languages []string

+ Passkeys PasskeyCapabilities

+ Password PasswordCapabilities

+ Passwordless PasswordlessCapabilities

+ Paths MountPaths

+ Registration RegistrationCapabilities

+ Solana SolanaCapabilities

+ TwoFactor TwoFactorCapabilities

+ Username UsernameCapabilities

+ Verification VerificationCapabilities

+ type ChannelCapabilities struct

+ Email bool

+ SMS bool

+ type CodeOrLinkRequest struct

+ Code string

+ Identifier string

+ Token string

+ type DelegatedTokenRequest struct

+ Audiences []string

+ DelegateCertificateDERB64URL string

+ RequestedGrant json.RawMessage

+ TTLSeconds int

+ type DeviceKeyEnrollBeginRequest struct

+ Email string

+ Label string

+ PublicKey string

+ type DeviceKeyEnrollFinishRequest struct

+ Code string

+ EnrollmentID string

+ SecondFactor string

+ Signature string

+ type DeviceKeyEnrollment struct

+ Challenge string

+ EnrollmentID string

+ ExpiresAt time.Time

+ type DeviceKeyLoginBeginRequest struct

+ DeviceKeyID string

+ type DeviceKeyLoginChallenge struct

+ Challenge string

+ ChallengeID string

+ ExpiresAt time.Time

+ type DeviceKeyLoginFinishRequest struct

+ ChallengeID string

+ Signature string

+ type DeviceKeySession struct

+ DeviceKey iam.DeviceKey

+ TokenSet iam.TokenSet

+ type ExternalLoginProvider struct

+ ID string

+ Name string

+ SupportsLink bool

+ SupportsLogin bool

+ SupportsRegistration bool

+ type Feature string

+ const Always

+ const FeatureAPIKeys

+ const FeatureDelegated

+ const FeatureDeviceKeys

+ const FeatureGroups

+ const FeatureOIDC

+ const FeaturePasskeys

+ const FeaturePasswordless

+ const FeatureRegistration

+ const FeatureSolana

+ const FeatureTwoFactor

+ type FreshAuth struct

+ AuthMethods []string

+ LastAuthenticatedAt *time.Time

+ StepUpRequiredForSensitiveActions bool

+ TimeUntilStepUpRequired int64

+ type GroupQuery struct

+ GroupID string

+ type IdentifierPasswordRequest struct

+ Identifier string

+ Password string

+ type IdentifierRequest struct

+ Identifier string

+ type InvitationCreateRequest struct

+ ExpiresAt *time.Time

+ Role string

+ type InviteRedeemRequest struct

+ Code string

+ type LabelRequest struct

+ Label string

+ type MemberAddRequest struct

+ Email string

+ Role string

+ UserID string

+ type MemberListQuery struct

+ Kind []string

+ Role []string

+ type MountPaths struct

+ API string

+ JWKS *string

+ OIDC *string

+ type OIDCCallbackQuery struct

+ Code string

+ Error string

+ Format string

+ State string

+ type OIDCLoginQuery struct

+ PopupNonce string

+ ReturnTo string

+ UI string

+ type OIDCLoginRequest struct

+ AccountInviteToken string

+ PopupNonce string

+ ReturnTo string

+ UI string

+ type OIDCLoginResult struct

+ TokenSet iam.TokenSet

+ User OIDCUser

+ type OIDCStart struct

+ AuthURL string

+ State string

+ type OIDCStepUpResult struct

+ FreshAuth FreshAuth

+ Provider string

+ TokenSet iam.TokenSet

+ type OIDCUser struct

+ Email *string

+ ID string

+ type PageQuery struct

+ Cursor string

+ Limit *int

+ func (q PageQuery) Page() (iam.PageRequest, error)

+ type PasskeyCapabilities struct

+ Login bool

+ type PasswordCapabilities struct

+ AllowCommon bool

+ MaxLength int

+ MinLength int

+ RequireDigit bool

+ RequireLowercase bool

+ RequireSymbol bool

+ RequireUppercase bool

+ type PasswordChangeRequest struct

+ CurrentPassword string

+ NewPassword string

+ type PasswordLoginRequest struct

+ Identifier string

+ Password string

+ type PasswordRequest struct

+ Password string

+ type PasswordResetConfirmRequest struct

+ NewPassword string

+ Token string

+ type PasswordlessCapabilities struct

+ Channels []string

+ Enabled bool

+ type PasswordlessResult struct

+ ReturnTo *string

+ TokenSet iam.TokenSet

+ type PasswordlessStartRequest struct

+ AccountInviteToken string

+ Identifier string

+ Mode string

+ PreferredLanguage string

+ ReturnTo string

+ type PermissionSet struct

+ GroupID string

+ Permissions []iam.Perm

+ type PreferredLanguage struct

+ PreferredLanguage string

+ type PreferredLanguageRequest struct

+ PreferredLanguage string

+ type RegisterRequest struct

+ AccountInviteToken string

+ Identifier string

+ Password string

+ Username string

+ type RegistrationCapabilities struct

+ InviteTokenRequired bool

+ Mode string

+ type RegistrationResult struct

+ TokenSet iam.TokenSet

+ User RegistrationUser

+ type RegistrationUser struct

+ Email *string

+ PhoneNumber *string

+ Username string

+ type RemovedRole struct

+ GroupID string

+ Persona iam.Persona

+ RemovedAt time.Time

+ Role iam.Role

+ type RemovedRoles struct

+ RemovedRoles []RemovedRole

+ type Reply struct

+ Body any

+ Status int

+ type ReturnToRequest struct

+ ReturnTo string

+ type RoleInfo struct

+ Name iam.Role

+ Permissions []string

type RouteSpec

+ MountedWhen Feature

+ Perm string

+ Query any

+ Request any

+ Responses []Reply

+ Surface Surface

+ func Catalog() []RouteSpec

+ type SolanaAccount struct

+ Address string

+ PublicKey string

+ type SolanaCapabilities struct

+ Login bool

+ type SolanaChallenge struct

+ IssuedAt time.Time

+ Message string

+ Nonce string

+ type SolanaChallengeRequest struct

+ Address string

+ Username string

+ type SolanaLink struct

+ SolanaAddress string

+ type SolanaLoginResult struct

+ Created bool

+ TokenSet iam.TokenSet

+ User SolanaUser

+ type SolanaSignInOutput struct

+ Account SolanaAccount

+ Signature string

+ SignedMessage string

+ type SolanaSignInRequest struct

+ Output SolanaSignInOutput

+ type SolanaUser struct

+ ID string

+ SolanaAddress string

+ type StepUpResult struct

+ FreshAuth FreshAuth

+ TokenSet iam.TokenSet

+ type Surface string

+ const SurfaceAPI

+ const SurfaceBase

+ const SurfaceOIDC

+ type TokenRefreshRequest struct

+ GrantType string

+ RefreshToken string

+ type TokenRequest struct

+ Token string

+ type TwoFactorCapabilities struct

+ Methods []iam.TwoFactorMethod

+ Mode iam.TwoFactorMode

+ type TwoFactorChallengeRequest struct

+ Challenge string

+ FactorID string

+ UserID string

+ type TwoFactorEnrollRequest struct

+ Code string

+ Default bool

+ FactorID string

+ Method string

+ PhoneNumber *string

+ type TwoFactorEnrollResult struct

+ BackupCodes []string

+ Enabled bool

+ FreshAuth *FreshAuth

+ Method string

+ OTPAuthURI *string

+ Secret *string

+ TokenSet *iam.TokenSet

+ type TwoFactorFactor struct

+ Email *string

+ ID string

+ IsDefault bool

+ Method string

+ PhoneNumber *string

+ type TwoFactorFactorQuery struct

+ FactorID string

+ type TwoFactorStatus struct

+ AllowedMethods []string

+ BackupCodesRemaining int

+ DefaultFactor *TwoFactorFactor

+ Enabled bool

+ Factors []TwoFactorFactor

+ Method string

+ PhoneNumber *string

+ type TwoFactorStepUpRequest struct

+ BackupCode bool

+ Code string

+ FactorID string

+ Method string

+ type TwoFactorVerifyRequest struct

+ BackupCode bool

+ Challenge string

+ Code string

+ FactorID string

+ UserID string

+ type UserListQuery struct

+ Entitlement string

+ Order string

+ RootRole string

+ Search string

+ Sort string

+ Status string

+ type UserProfile = authflow.UserProfile

+ type UsernameCapabilities struct

+ FormerNames naming.PolicyInfo

+ MaxLength int

+ MinLength int

+ Pattern string

+ RenameIntervalSeconds int64

+ Renames bool

+ type UsernameChange struct

+ Naming naming.State

+ Username string

+ type UsernameRequest struct

+ Username string

+ type VerificationCapabilities struct

+ Registration string

+ type WebAuthnCredential = json.RawMessage

+ type WireField struct

+ Name string

+ Optional bool

+ Tag string

+ Type reflect.Type

+ func Fields(t reflect.Type) []WireField

+ type WireKind int

+ const WireAny

+ const WireArray

+ const WireBoolean

+ const WireBytes

+ const WireInteger

+ const WireMap

+ const WireNullable

+ const WireNumber

+ const WireObject

+ const WireOpaque

+ const WirePage

+ const WireString

+ const WireTime

+ func KindOf(t reflect.Type) WireKind

v0.147.0

Sep 30, 2026

Changes in this version

+ const CookieOIDCState

+ const CookieRefresh

+ const OIDCPath

+ const OIDCStatePrefix

+ const RL2FADisable

+ const RL2FAEnable

+ const RL2FARegenerateCodes

+ const RL2FAStartEmail

+ const RL2FAStartPhone

+ const RL2FAStartTOTP

+ const RL2FAVerify

+ const RLAPIKeyMint

+ const RLAdminUserSessionsList

+ const RLAdminUserSessionsRevokeAll

+ const RLAuthLogout

+ const RLAuthRegister

+ const RLAuthRegisterAbandon

+ const RLAuthRegisterAvailability

+ const RLAuthSessionsList

+ const RLAuthSessionsRevoke

+ const RLAuthSessionsRevokeAll

+ const RLAuthToken

+ const RLContactChangeRequest

+ const RLDelegatedTokenMint

+ const RLDeviceKeyEnrollBegin

+ const RLDeviceKeyEnrollFinish

+ const RLDeviceKeyLoginBegin

+ const RLDeviceKeyLoginFinish

+ const RLDeviceKeysManage

+ const RLInviteCreate

+ const RLInviteRedeem

+ const RLOIDCCallback

+ const RLOIDCStart

+ const RLPasskeyLogin

+ const RLPasskeyRegister

+ const RLPasswordLogin

+ const RLPasswordResetConfirm

+ const RLPasswordResetRequest

+ const RLPasswordStepUp

+ const RLPasswordlessConfirm

+ const RLPasswordlessStart

+ const RLSolanaChallenge

+ const RLSolanaLink

+ const RLSolanaLogin

+ const RLUserDelete

+ const RLUserMe

+ const RLUserPasswordChange

+ const RLUserPreferredLanguage

+ const RLUserUnlinkProvider

+ const RLUserUpdateUsername

+ const RLVerifyConfirm

+ const RLVerifyRequest

+ var CookieRegistry = []CookieVariant

+ var GroupRoutes = []GroupRoute

+ func DefaultRateLimits() map[string]ratelimit.Limit

+ func MuxPath(p string) string

+ func SanitizeReturnTo(value string) string

+ type AuthCapabilities struct

+ Channels AuthChannelCapabilities

+ ExternalLoginProviders []AuthProviderSummary

+ Languages []string

+ Passkeys AuthPasskeyCapabilities

+ Password AuthPasswordCapabilities

+ Passwordless AuthPasswordlessCapabilities

+ Paths AuthPaths

+ Registration AuthRegistrationCapabilities

+ Solana AuthSolanaCapabilities

+ Username AuthUsernameCapabilities

+ Verification AuthVerificationCapabilities

+ type AuthChannelCapabilities struct

+ Email bool

+ SMS bool

+ type AuthPasskeyCapabilities struct

+ Login bool

+ type AuthPasswordCapabilities struct

+ MaxLength int

+ MinLength int

+ RejectCommon bool

+ RequireDigit bool

+ RequireLowercase bool

+ RequireSymbol bool

+ RequireUppercase bool

+ type AuthPasswordlessCapabilities struct

+ Channels []string

+ Enabled bool

+ type AuthPaths struct

+ API string

+ JWKS string

+ OIDC string

+ type AuthProviderSummary struct

+ ID string

+ Name string

+ SupportsLink bool

+ SupportsLogin bool

+ SupportsRegistration bool

+ type AuthRegistrationCapabilities struct

+ InviteTokenRequired bool

+ Mode string

+ type AuthSolanaCapabilities struct

+ Login bool

+ type AuthUsernameCapabilities struct

+ FormerNames naming.PolicyInfo

+ MaxLength int

+ MinLength int

+ Pattern string

+ RenameIntervalSeconds int64

+ Renames bool

+ type AuthVerificationCapabilities struct

+ Registration string

+ type Backend interface

+ type ClientIPFunc func(r *http.Request) string

+ func ClientIPFromForwardedHeaders(trusted, cloudflare []netip.Prefix) ClientIPFunc

+ func DefaultClientIP() ClientIPFunc

+ type CookieVariant struct

+ Current bool

+ Domain string

+ Kind cookieKind

+ Name string

+ Path string

+ Secure bool

+ func CurrentCookie(kind cookieKind, secure bool) CookieVariant

+ func (v CookieVariant) Identity() string

+ type DelegatedTokenResponse struct

+ ExpiresAt time.Time

+ Token string

+ TokenType string

+ type GroupOp int

+ const OpAPIKeyMint

+ const OpAPIKeyRevoke

+ const OpAPIKeysList

+ const OpInviteLinkList

+ const OpInviteLinkMint

+ const OpInviteLinkRevoke

+ const OpMemberAdd

+ const OpMemberRemove

+ const OpMemberRoleAssign

+ const OpMembersList

+ const OpRolesList

+ func (op GroupOp) Available(p rbac.Persona) bool

+ func (op GroupOp) Perms(p rbac.Persona) []iam.Perm

+ type GroupRoute struct

+ Method string

+ Op GroupOp

+ Path string

+ func MountedGroupRoutes(s *rbac.Schema) []GroupRoute

+ type Mount struct

+ func NewMount(svc *Service) (result *Mount, err error)

+ func (m *Mount) Routes() []iam.Route

+ func (m *Mount) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type RateLimitResult struct

+ Allowed bool

+ Availability *authflow.ActionAvailability

+ RetryAfter time.Duration

+ type RateLimiter interface

+ AllowNamed func(bucket string, key string) (bool, error)

+ type RateLimiterWithResult interface

+ AllowNamedResult func(bucket string, key string) (ratelimit.Result, error)

+ type RouteSpec struct

+ Auth iam.RouteAuthTier

+ Bucket string

+ Group iam.RouteGroup

+ Handler http.Handler

+ MFAEnrollmentExempt bool

+ Method string

+ Path string

+ Permission string

+ type Service struct

+ func New(client Backend, cfg config.Config, deps config.Deps) (*Service, error)

+ func (s *Service) APIRoutes(groups ...iam.RouteGroup) []RouteSpec

+ func (s *Service) Backend() Backend

+ func (s *Service) Capabilities() AuthCapabilities

+ func (s *Service) Close()

+ func (s *Service) GroupHandler(gr GroupRoute) http.HandlerFunc

+ func (s *Service) JWKSHandler() http.Handler

+ func (s *Service) OIDCBrowserRoutes(groups ...iam.RouteGroup) []RouteSpec

+ func (s *Service) PermissionGroupRoutes() []RouteSpec

+ func (s *Service) SMSAvailable() bool

+ type TwoFactorFactorResponse struct

+ Email *string

+ ID string

+ IsDefault bool

+ Method string

+ PhoneNumber *string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL