api

package
v0.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 11, 2026 License: MIT Imports: 34 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	GetCsrfTokenErrors                              = contract.MustOperationErrors("getCsrfToken")
	GetGoogleLoginOptionsErrors                     = contract.MustOperationErrors("getGoogleLoginOptions")
	LoginWithGoogleErrors                           = contract.MustOperationErrors("loginWithGoogle")
	GetAppleLoginOptionsErrors                      = contract.MustOperationErrors("getAppleLoginOptions")
	LoginWithAppleErrors                            = contract.MustOperationErrors("loginWithApple")
	GetMicrosoftLoginOptionsErrors                  = contract.MustOperationErrors("getMicrosoftLoginOptions")
	LoginWithMicrosoftErrors                        = contract.MustOperationErrors("loginWithMicrosoft")
	LoginWithPasswordErrors                         = contract.MustOperationErrors("loginWithPassword")
	SignupDirectErrors                              = contract.MustOperationErrors("signupDirect")
	StartSignupChallengeErrors                      = contract.MustOperationErrors("startSignupChallenge")
	VerifySignupChallengeErrors                     = contract.MustOperationErrors("verifySignupChallenge")
	StartPasswordResetChallengeErrors               = contract.MustOperationErrors("startPasswordResetChallenge")
	VerifyPasswordResetChallengeErrors              = contract.MustOperationErrors("verifyPasswordResetChallenge")
	ResendChallengeErrors                           = contract.MustOperationErrors("resendChallenge")
	BeginPasskeyAuthenticationErrors                = contract.MustOperationErrors("beginPasskeyAuthentication")
	FinishPasskeyAuthenticationErrors               = contract.MustOperationErrors("finishPasskeyAuthentication")
	BeginPasskeyRegistrationErrors                  = contract.MustOperationErrors("beginPasskeyRegistration")
	FinishPasskeyRegistrationErrors                 = contract.MustOperationErrors("finishPasskeyRegistration")
	CheckRecentAuthenticationErrors                 = contract.MustOperationErrors("checkRecentAuthentication")
	ReauthenticateWithPasswordErrors                = contract.MustOperationErrors("reauthenticateWithPassword")
	ReauthenticateWithGoogleErrors                  = contract.MustOperationErrors("reauthenticateWithGoogle")
	ReauthenticateWithAppleErrors                   = contract.MustOperationErrors("reauthenticateWithApple")
	ReauthenticateWithMicrosoftErrors               = contract.MustOperationErrors("reauthenticateWithMicrosoft")
	BeginPasskeyReauthenticationErrors              = contract.MustOperationErrors("beginPasskeyReauthentication")
	FinishPasskeyReauthenticationErrors             = contract.MustOperationErrors("finishPasskeyReauthentication")
	LogoutErrors                                    = contract.MustOperationErrors("logout")
	RefreshSessionErrors                            = contract.MustOperationErrors("refreshSession")
	RefreshTokensErrors                             = contract.MustOperationErrors("refreshTokens")
	GetCurrentUserErrors                            = contract.MustOperationErrors("getCurrentUser")
	GetCurrentAccountErrors                         = contract.MustOperationErrors("getCurrentAccount")
	ChangeCurrentUsernameErrors                     = contract.MustOperationErrors("changeCurrentUsername")
	StartCurrentUserEmailChangeErrors               = contract.MustOperationErrors("startCurrentUserEmailChange")
	VerifyCurrentUserEmailChangeErrors              = contract.MustOperationErrors("verifyCurrentUserEmailChange")
	AddCurrentUserPasswordErrors                    = contract.MustOperationErrors("addCurrentUserPassword")
	ChangeCurrentUserPasswordErrors                 = contract.MustOperationErrors("changeCurrentUserPassword")
	LinkCurrentUserGoogleErrors                     = contract.MustOperationErrors("linkCurrentUserGoogle")
	LinkCurrentUserAppleErrors                      = contract.MustOperationErrors("linkCurrentUserApple")
	LinkCurrentUserMicrosoftErrors                  = contract.MustOperationErrors("linkCurrentUserMicrosoft")
	UnlinkCurrentUserAuthMethodErrors               = contract.MustOperationErrors("unlinkCurrentUserAuthMethod")
	DeleteCurrentUserPasskeyErrors                  = contract.MustOperationErrors("deleteCurrentUserPasskey")
	RevokeCurrentUserSessionErrors                  = contract.MustOperationErrors("revokeCurrentUserSession")
	RevokeCurrentUserOtherSessionsErrors            = contract.MustOperationErrors("revokeCurrentUserOtherSessions")
	SetCurrentUserPasswordErrors                    = contract.MustOperationErrors("setCurrentUserPassword")
	ListCurrentUserOrganizationsErrors              = contract.MustOperationErrors("listCurrentUserOrganizations")
	GetCurrentOrganizationErrors                    = contract.MustOperationErrors("getCurrentOrganization")
	ListCurrentOrganizationMembersErrors            = contract.MustOperationErrors("listCurrentOrganizationMembers")
	SwitchOrganizationErrors                        = contract.MustOperationErrors("switchOrganization")
	PreviewInvitationErrors                         = contract.MustOperationErrors("previewInvitation")
	AcceptInvitationErrors                          = contract.MustOperationErrors("acceptInvitation")
	LoginAndAcceptInvitationErrors                  = contract.MustOperationErrors("loginAndAcceptInvitation")
	AuthenticateAndAcceptInvitationWithGoogleErrors = contract.MustOperationErrors("authenticateAndAcceptInvitationWithGoogle")
	StartGoogleAccountRecoveryLinkErrors            = contract.MustOperationErrors("startGoogleAccountRecoveryLink")
	CompleteAccountRecoveryLinkWithPasswordErrors   = contract.MustOperationErrors("completeAccountRecoveryLinkWithPassword")
	CompleteAccountRecoveryLinkWithGoogleErrors     = contract.MustOperationErrors("completeAccountRecoveryLinkWithGoogle")
	CompleteAccountRecoveryLinkWithAppleErrors      = contract.MustOperationErrors("completeAccountRecoveryLinkWithApple")
	CompleteAccountRecoveryLinkWithMicrosoftErrors  = contract.MustOperationErrors("completeAccountRecoveryLinkWithMicrosoft")
)

Functions

This section is empty.

Types

type APIHandler 

type APIHandler struct {
	Auth             *auth.Service
	Passkeys         *passkey.Service
	Session          *session.Service
	Organizations    *organization.Service
	Challenge        *challenge.Service
	Verification     *challenge.VerificationCodeService
	Limiter          ratelimiter.AuthLimiter
	Logger           *slog.Logger
	Google           GoogleVerifier
	Apple            AppleClient
	Microsoft        MicrosoftVerifier
	AppleCredentials AppleCredentialStore
	OAuthProviders   oauth.OAuthProviders
	Config           RuntimePolicyReader

	ChallengeEnabled     bool
	UsernameLoginEnabled bool
	AccessTTL            time.Duration
	RefreshTTL           time.Duration
}

func New 

func New(
	auth *auth.Service,
	passkeys *passkey.Service,
	session *session.Service,
	organizations *organization.Service,
	challenge *challenge.Service,
	verification *challenge.VerificationCodeService,
	limiter ratelimiter.AuthLimiter,
	logger *slog.Logger,
	google GoogleVerifier,
	oauthProviders oauth.OAuthProviders,
	configuration RuntimePolicyReader,
	challengeEnabled bool,
	usernameLoginEnabled bool,
	accessTTL time.Duration,
	refreshTTL time.Duration,
) *APIHandler

func (*APIHandler) AcceptInvitation added in v0.16.0 

func (h *APIHandler) AcceptInvitation(ctx context.Context, request contract.AcceptInvitationRequestObject) (contract.AcceptInvitationResponseObject, error)

func (*APIHandler) AddCurrentUserPassword added in v0.16.0 

func (h *APIHandler) AddCurrentUserPassword(ctx context.Context, request contract.AddCurrentUserPasswordRequestObject) (contract.AddCurrentUserPasswordResponseObject, error)

func (*APIHandler) AuthenticateAndAcceptInvitationWithGoogle added in v0.16.0 

func (h *APIHandler) AuthenticateAndAcceptInvitationWithGoogle(ctx context.Context, request contract.AuthenticateAndAcceptInvitationWithGoogleRequestObject) (contract.AuthenticateAndAcceptInvitationWithGoogleResponseObject, error)

func (*APIHandler) BeginPasskeyAuthentication added in v0.10.0 

func (h *APIHandler) BeginPasskeyAuthentication(ctx context.Context, _ contract.BeginPasskeyAuthenticationRequestObject) (contract.BeginPasskeyAuthenticationResponseObject, error)

func (*APIHandler) BeginPasskeyReauthentication added in v0.22.0 

func (h *APIHandler) BeginPasskeyReauthentication(ctx context.Context, request contract.BeginPasskeyReauthenticationRequestObject) (contract.BeginPasskeyReauthenticationResponseObject, error)

func (*APIHandler) BeginPasskeyRegistration added in v0.10.0 

func (h *APIHandler) BeginPasskeyRegistration(ctx context.Context, _ contract.BeginPasskeyRegistrationRequestObject) (contract.BeginPasskeyRegistrationResponseObject, error)

func (*APIHandler) ChangeCurrentUserPassword added in v0.16.0 

func (h *APIHandler) ChangeCurrentUserPassword(ctx context.Context, request contract.ChangeCurrentUserPasswordRequestObject) (contract.ChangeCurrentUserPasswordResponseObject, error)

func (*APIHandler) ChangeCurrentUsername added in v0.16.0 

func (h *APIHandler) ChangeCurrentUsername(ctx context.Context, request contract.ChangeCurrentUsernameRequestObject) (contract.ChangeCurrentUsernameResponseObject, error)

func (*APIHandler) CheckRecentAuthentication added in v0.22.0 

func (h *APIHandler) CheckRecentAuthentication(context.Context, contract.CheckRecentAuthenticationRequestObject) (contract.CheckRecentAuthenticationResponseObject, error)

func (*APIHandler) CompleteAccountRecoveryLinkWithApple added in v0.22.0 

func (h *APIHandler) CompleteAccountRecoveryLinkWithApple(ctx context.Context, request contract.CompleteAccountRecoveryLinkWithAppleRequestObject) (contract.CompleteAccountRecoveryLinkWithAppleResponseObject, error)

func (*APIHandler) CompleteAccountRecoveryLinkWithGoogle added in v0.16.0 

func (h *APIHandler) CompleteAccountRecoveryLinkWithGoogle(ctx context.Context, request contract.CompleteAccountRecoveryLinkWithGoogleRequestObject) (contract.CompleteAccountRecoveryLinkWithGoogleResponseObject, error)

func (*APIHandler) CompleteAccountRecoveryLinkWithMicrosoft added in v0.24.0 

func (h *APIHandler) CompleteAccountRecoveryLinkWithMicrosoft(ctx context.Context, request contract.CompleteAccountRecoveryLinkWithMicrosoftRequestObject) (contract.CompleteAccountRecoveryLinkWithMicrosoftResponseObject, error)

func (*APIHandler) CompleteAccountRecoveryLinkWithPassword added in v0.16.0 

func (h *APIHandler) CompleteAccountRecoveryLinkWithPassword(ctx context.Context, request contract.CompleteAccountRecoveryLinkWithPasswordRequestObject) (contract.CompleteAccountRecoveryLinkWithPasswordResponseObject, error)

func (*APIHandler) DeleteCurrentUserPasskey added in v0.16.0 

func (h *APIHandler) DeleteCurrentUserPasskey(ctx context.Context, request contract.DeleteCurrentUserPasskeyRequestObject) (contract.DeleteCurrentUserPasskeyResponseObject, error)

func (*APIHandler) FinishPasskeyAuthentication added in v0.10.0 

func (h *APIHandler) FinishPasskeyAuthentication(ctx context.Context, request contract.FinishPasskeyAuthenticationRequestObject) (contract.FinishPasskeyAuthenticationResponseObject, error)

func (*APIHandler) FinishPasskeyReauthentication added in v0.22.0 

func (h *APIHandler) FinishPasskeyReauthentication(ctx context.Context, request contract.FinishPasskeyReauthenticationRequestObject) (contract.FinishPasskeyReauthenticationResponseObject, error)

func (*APIHandler) FinishPasskeyRegistration added in v0.10.0 

func (h *APIHandler) FinishPasskeyRegistration(ctx context.Context, request contract.FinishPasskeyRegistrationRequestObject) (contract.FinishPasskeyRegistrationResponseObject, error)

func (*APIHandler) GetAppleLoginOptions added in v0.22.0 

func (h *APIHandler) GetAppleLoginOptions(ctx context.Context, _ contract.GetAppleLoginOptionsRequestObject) (contract.GetAppleLoginOptionsResponseObject, error)

func (*APIHandler) GetCsrfToken added in v0.10.0 

func (h *APIHandler) GetCsrfToken(ctx context.Context, _ contract.GetCsrfTokenRequestObject) (contract.GetCsrfTokenResponseObject, error)

func (*APIHandler) GetCurrentAccount added in v0.16.0 

func (h *APIHandler) GetCurrentAccount(ctx context.Context, request contract.GetCurrentAccountRequestObject) (contract.GetCurrentAccountResponseObject, error)

func (*APIHandler) GetCurrentOrganization added in v0.10.0 

func (h *APIHandler) GetCurrentOrganization(ctx context.Context, _ contract.GetCurrentOrganizationRequestObject) (contract.GetCurrentOrganizationResponseObject, error)

func (*APIHandler) GetCurrentUser added in v0.10.0 

func (h *APIHandler) GetCurrentUser(ctx context.Context, _ contract.GetCurrentUserRequestObject) (contract.GetCurrentUserResponseObject, error)

func (*APIHandler) GetGoogleLoginOptions added in v0.10.0 

func (h *APIHandler) GetGoogleLoginOptions(ctx context.Context, _ contract.GetGoogleLoginOptionsRequestObject) (contract.GetGoogleLoginOptionsResponseObject, error)

func (*APIHandler) GetMicrosoftLoginOptions added in v0.24.0 

func (h *APIHandler) GetMicrosoftLoginOptions(ctx context.Context, _ contract.GetMicrosoftLoginOptionsRequestObject) (contract.GetMicrosoftLoginOptionsResponseObject, error)

func (*APIHandler) LinkCurrentUserApple added in v0.22.0 

func (h *APIHandler) LinkCurrentUserApple(ctx context.Context, request contract.LinkCurrentUserAppleRequestObject) (contract.LinkCurrentUserAppleResponseObject, error)

func (*APIHandler) LinkCurrentUserGoogle added in v0.16.0 

func (h *APIHandler) LinkCurrentUserGoogle(ctx context.Context, request contract.LinkCurrentUserGoogleRequestObject) (contract.LinkCurrentUserGoogleResponseObject, error)

func (*APIHandler) LinkCurrentUserMicrosoft added in v0.24.0 

func (h *APIHandler) LinkCurrentUserMicrosoft(ctx context.Context, request contract.LinkCurrentUserMicrosoftRequestObject) (contract.LinkCurrentUserMicrosoftResponseObject, error)

func (*APIHandler) ListCurrentOrganizationMembers added in v0.10.0 

func (h *APIHandler) ListCurrentOrganizationMembers(ctx context.Context, request contract.ListCurrentOrganizationMembersRequestObject) (contract.ListCurrentOrganizationMembersResponseObject, error)

func (*APIHandler) ListCurrentUserOrganizations added in v0.10.0 

func (h *APIHandler) ListCurrentUserOrganizations(ctx context.Context, request contract.ListCurrentUserOrganizationsRequestObject) (contract.ListCurrentUserOrganizationsResponseObject, error)

func (*APIHandler) LoginAndAcceptInvitation added in v0.16.0 

func (h *APIHandler) LoginAndAcceptInvitation(ctx context.Context, request contract.LoginAndAcceptInvitationRequestObject) (contract.LoginAndAcceptInvitationResponseObject, error)

func (*APIHandler) LoginWithApple added in v0.22.0 

func (h *APIHandler) LoginWithApple(ctx context.Context, request contract.LoginWithAppleRequestObject) (contract.LoginWithAppleResponseObject, error)

func (*APIHandler) LoginWithGoogle added in v0.10.0 

func (h *APIHandler) LoginWithGoogle(ctx context.Context, request contract.LoginWithGoogleRequestObject) (contract.LoginWithGoogleResponseObject, error)

func (*APIHandler) LoginWithMicrosoft added in v0.24.0 

func (h *APIHandler) LoginWithMicrosoft(ctx context.Context, request contract.LoginWithMicrosoftRequestObject) (contract.LoginWithMicrosoftResponseObject, error)

func (*APIHandler) LoginWithPassword added in v0.10.0 

func (h *APIHandler) LoginWithPassword(ctx context.Context, request contract.LoginWithPasswordRequestObject) (contract.LoginWithPasswordResponseObject, error)

func (*APIHandler) Logout added in v0.10.0 

func (h *APIHandler) Logout(ctx context.Context, _ contract.LogoutRequestObject) (contract.LogoutResponseObject, error)

func (*APIHandler) PreviewInvitation added in v0.16.0 

func (h *APIHandler) PreviewInvitation(ctx context.Context, request contract.PreviewInvitationRequestObject) (contract.PreviewInvitationResponseObject, error)

func (*APIHandler) ReauthenticateWithApple added in v0.22.0 

func (h *APIHandler) ReauthenticateWithApple(ctx context.Context, request contract.ReauthenticateWithAppleRequestObject) (contract.ReauthenticateWithAppleResponseObject, error)

func (*APIHandler) ReauthenticateWithGoogle added in v0.22.0 

func (h *APIHandler) ReauthenticateWithGoogle(ctx context.Context, request contract.ReauthenticateWithGoogleRequestObject) (contract.ReauthenticateWithGoogleResponseObject, error)

func (*APIHandler) ReauthenticateWithMicrosoft added in v0.24.0 

func (h *APIHandler) ReauthenticateWithMicrosoft(ctx context.Context, request contract.ReauthenticateWithMicrosoftRequestObject) (contract.ReauthenticateWithMicrosoftResponseObject, error)

func (*APIHandler) ReauthenticateWithPassword added in v0.22.0 

func (h *APIHandler) ReauthenticateWithPassword(ctx context.Context, request contract.ReauthenticateWithPasswordRequestObject) (contract.ReauthenticateWithPasswordResponseObject, error)

func (*APIHandler) RefreshSession added in v0.10.0 

func (h *APIHandler) RefreshSession(ctx context.Context, request contract.RefreshSessionRequestObject) (contract.RefreshSessionResponseObject, error)

func (*APIHandler) RefreshTokens added in v0.10.0 

func (h *APIHandler) RefreshTokens(ctx context.Context, request contract.RefreshTokensRequestObject) (contract.RefreshTokensResponseObject, error)

func (*APIHandler) ResendChallenge added in v0.10.0 

func (h *APIHandler) ResendChallenge(ctx context.Context, request contract.ResendChallengeRequestObject) (contract.ResendChallengeResponseObject, error)

func (*APIHandler) RevokeCurrentUserOtherSessions added in v0.16.0 

func (h *APIHandler) RevokeCurrentUserOtherSessions(ctx context.Context, _ contract.RevokeCurrentUserOtherSessionsRequestObject) (contract.RevokeCurrentUserOtherSessionsResponseObject, error)

func (*APIHandler) RevokeCurrentUserSession added in v0.16.0 

func (h *APIHandler) RevokeCurrentUserSession(ctx context.Context, request contract.RevokeCurrentUserSessionRequestObject) (contract.RevokeCurrentUserSessionResponseObject, error)

func (*APIHandler) SetCurrentUserPassword added in v0.12.0 

func (h *APIHandler) SetCurrentUserPassword(ctx context.Context, request contract.SetCurrentUserPasswordRequestObject) (contract.SetCurrentUserPasswordResponseObject, error)

func (*APIHandler) SignupDirect added in v0.10.0 

func (h *APIHandler) SignupDirect(ctx context.Context, request contract.SignupDirectRequestObject) (contract.SignupDirectResponseObject, error)

func (*APIHandler) StartCurrentUserEmailChange added in v0.16.0 

func (h *APIHandler) StartCurrentUserEmailChange(ctx context.Context, request contract.StartCurrentUserEmailChangeRequestObject) (contract.StartCurrentUserEmailChangeResponseObject, error)
func (h *APIHandler) StartGoogleAccountRecoveryLink(ctx context.Context, request contract.StartGoogleAccountRecoveryLinkRequestObject) (contract.StartGoogleAccountRecoveryLinkResponseObject, error)

func (*APIHandler) StartPasswordResetChallenge added in v0.12.0 

func (h *APIHandler) StartPasswordResetChallenge(ctx context.Context, request contract.StartPasswordResetChallengeRequestObject) (contract.StartPasswordResetChallengeResponseObject, error)

func (*APIHandler) StartSignupChallenge added in v0.10.0 

func (h *APIHandler) StartSignupChallenge(ctx context.Context, request contract.StartSignupChallengeRequestObject) (contract.StartSignupChallengeResponseObject, error)

func (*APIHandler) SwitchOrganization added in v0.10.0 

func (h *APIHandler) SwitchOrganization(ctx context.Context, request contract.SwitchOrganizationRequestObject) (contract.SwitchOrganizationResponseObject, error)

func (*APIHandler) UnlinkCurrentUserAuthMethod added in v0.16.0 

func (h *APIHandler) UnlinkCurrentUserAuthMethod(ctx context.Context, request contract.UnlinkCurrentUserAuthMethodRequestObject) (contract.UnlinkCurrentUserAuthMethodResponseObject, error)

func (*APIHandler) VerifyCurrentUserEmailChange added in v0.16.0 

func (h *APIHandler) VerifyCurrentUserEmailChange(ctx context.Context, request contract.VerifyCurrentUserEmailChangeRequestObject) (contract.VerifyCurrentUserEmailChangeResponseObject, error)

func (*APIHandler) VerifyPasswordResetChallenge added in v0.12.0 

func (h *APIHandler) VerifyPasswordResetChallenge(ctx context.Context, request contract.VerifyPasswordResetChallengeRequestObject) (contract.VerifyPasswordResetChallengeResponseObject, error)

func (*APIHandler) VerifySignupChallenge added in v0.10.0 

func (h *APIHandler) VerifySignupChallenge(ctx context.Context, request contract.VerifySignupChallengeRequestObject) (contract.VerifySignupChallengeResponseObject, error)

type AppleClient added in v0.22.0 

type AppleClient interface {
	Exchange(context.Context, string, string) (apple.ExchangeResult, error)
	Revoke(context.Context, string) error
}

type AppleCredentialStore added in v0.22.0 

type AppleCredentialStore interface {
	QueueRevocation(context.Context, string) error
	StageProviderLink(context.Context, uuid.UUID, string, time.Time) error
}

type GoogleVerifier added in v0.16.0 

type GoogleVerifier interface {
	VerifyIDToken(context.Context, string, string) (*google.Identity, error)
	ExchangeAuthorizationCode(context.Context, string, string) (*google.Identity, error)
}

type MicrosoftVerifier added in v0.24.0 

type MicrosoftVerifier interface {
	Authority() string
	VerifyIDToken(context.Context, string, string) (*microsoft.Identity, error)
}

type RuntimePolicyReader added in v0.21.0 

type RuntimePolicyReader interface {
	config.AuthenticationPolicyReader
	config.SessionCookiePolicyReader
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.