engine

package

Go to main page

Versions in this module

v1

v1.32.1

Oct 18, 2026

v1.32.0

Oct 17, 2026

Changes in this version

type Engine

+ func (s *Engine) BeginPasskeyMFAEnrollment(ctx context.Context, in authflow.TwoFactorEnrollInput) (*protocol.CredentialCreation, error)

+ func (s *Engine) CompleteTwoFactorStepUp(ctx context.Context, userID, sessionID, factorID, code string, backup bool) error

+ func (s *Engine) FinishPasskeyMFAEnrollment(ctx context.Context, in authflow.TwoFactorEnrollInput, response []byte) (authflow.LoginOutcome, error)

+ func (s *Engine) RegenerateBackupCodesForSession(ctx context.Context, userID, sessionID string) ([]string, error)

v1.30.1

Oct 16, 2026

v1.30.0

Oct 15, 2026

Changes in this version

+ func WithTenant(ctx context.Context, id iam.TenantID) context.Context

type Engine

+ func (s *Engine) AccountScope(ctx context.Context) (iam.GroupRef, error)

+ func (s *Engine) CreateTenant(ctx context.Context, tenant iam.Tenant) error

+ func (s *Engine) MigrateGroupPersona(ctx context.Context, in iam.GroupPersonaMigration) (iam.GroupPersonaMigrationReport, error)

+ func (s *Engine) RemoteUserInfoTx(ctx context.Context, host pgx.Tx, ref iam.GroupRef, issuer string, ...) (map[string]userinfo.User, error)

+ func (s *Engine) ResolveTenantActor(ctx context.Context, verified auth.Verified) (iam.TenantActor, error)

+ func (s *Engine) Tenant(ctx context.Context, id iam.TenantID) (iam.Tenant, error)

+ func (s *Engine) UserInfoTx(ctx context.Context, host pgx.Tx, ids []string) (map[string]userinfo.User, error)

+ type MigrationOptions struct

+ LegacyTenantID iam.TenantID

v1.29.1

Oct 15, 2026

v1.29.0

Oct 15, 2026

Changes in this version

+ var ErrMigrationsRequired = errors.New("authkit: database migrations are required")

type Engine

+ func (s *Engine) CanDirect(ctx context.Context, a auth.Identity, ref iam.GroupRef, perm iam.Perm) (bool, error)

+ func (s *Engine) GenerateUsername(ctx context.Context) (string, error)

+ func (s *Engine) OwnsRefreshToken(ctx context.Context, token string) (bool, error)

v1.28.0

Oct 14, 2026

Changes in this version

type Engine

+ func (s *Engine) Probes() []Probe

+ func (s *Engine) Providers() []provider.Provider

+ func (s *Engine) Ready(ctx context.Context) error

+ type Probe struct

+ Check func(context.Context) error

+ Name string

v1.27.0

Oct 12, 2026

v1.26.0

Oct 12, 2026

v1.25.0

Oct 12, 2026

v1.24.0

Oct 11, 2026

v1.23.0

Oct 11, 2026

v1.22.3

Oct 11, 2026

v1.22.2

Oct 11, 2026

v1.22.1

Oct 11, 2026

v1.22.0

Oct 11, 2026

Changes in this version

type ResourceAccess

+ ExchangedGroup string

v1.21.0

Oct 11, 2026

v1.20.0

Oct 11, 2026

Changes in this version

type Engine

+ func (s *Engine) AcceptAgreements(ctx context.Context, userID string, refs []iam.AgreementRef, ...) error

+ func (s *Engine) Agreements() []iam.Agreement

+ func (s *Engine) AgreementsDue(ctx context.Context, userID string) ([]iam.Agreement, error)

+ func (s *Engine) AuthenticateClientAssertion(ctx context.Context, client authflow.OAuthClient, assertion string) error

+ func (s *Engine) CreateGroupOAuthClient(ctx context.Context, who auth.Identity, ref iam.GroupRef, n iam.NewOAuthClient, ...) (iam.OAuthClientCreated, error)

+ func (s *Engine) DeleteGroupOAuthClient(ctx context.Context, who auth.Identity, ref iam.GroupRef, clientID string, ...) error

+ func (s *Engine) GroupName(ctx context.Context, groupID string) *string

+ func (s *Engine) GroupOAuthClient(ctx context.Context, ref iam.GroupRef, clientID string) (iam.OAuthClient, error)

+ func (s *Engine) GroupOAuthClients(ctx context.Context, ref iam.GroupRef) ([]iam.OAuthClient, error)

+ func (s *Engine) OAuthClient(ctx context.Context, clientID string) (authflow.OAuthClient, bool, error)

+ func (s *Engine) OAuthClientOrigin(ctx context.Context, origin string) (bool, error)

+ func (s *Engine) OAuthConsents(ctx context.Context, userID string) ([]iam.OAuthConsent, error)

+ func (s *Engine) RecordAgreements(ctx context.Context, userID string, refs []iam.AgreementRef, ...) error

+ func (s *Engine) RevokeConsent(ctx context.Context, userID, clientID string, opts ...ops.Option) error

+ func (s *Engine) RotateGroupOAuthClientSecret(ctx context.Context, who auth.Identity, ref iam.GroupRef, clientID string, ...) (string, error)

+ func (s *Engine) ScopeDescriptions(scopes []string) []errmodel.ScopeDescription

+ func (s *Engine) SetSMSLimiter(rl ratelimit.Limiter)

+ func (s *Engine) UpdateGroupOAuthClient(ctx context.Context, who auth.Identity, ref iam.GroupRef, clientID string, ...) (iam.OAuthClient, error)

+ func (s *Engine) UserAgreements(ctx context.Context, userID string) ([]iam.AgreementAcceptance, error)

+ func (s *Engine) VerifyIDToken(ctx context.Context, raw string) (iam.IDToken, error)

+ func (s *Engine) WithdrawConsent(ctx context.Context, who auth.Identity, userID, clientID string) error

type ResourceAccess

+ ClientGroup string

v1.19.0

Oct 10, 2026

Changes in this version

type Engine

+ func (s *Engine) CreateGroupRole(ctx context.Context, who auth.Identity, ref iam.GroupRef, n iam.NewGroupRole, ...) (iam.GroupRole, error)

+ func (s *Engine) DeleteGroupRole(ctx context.Context, who auth.Identity, ref iam.GroupRef, role iam.Role, ...) error

+ func (s *Engine) GroupRole(ctx context.Context, ref iam.GroupRef, role iam.Role) (iam.GroupRole, error)

+ func (s *Engine) ListGroupRoles(ctx context.Context, ref iam.GroupRef) ([]iam.GroupRole, error)

+ func (s *Engine) UpdateGroupRole(ctx context.Context, who auth.Identity, ref iam.GroupRef, role iam.Role, ...) (iam.GroupRole, error)

v1.18.0

Oct 10, 2026

Changes in this version

+ const ResourceSignInWindow

+ func IsResourceTokenRequest(r *http.Request) bool

type Engine

+ func (s *Engine) AcceptRemoteInvitation(ctx context.Context, v auth.Verified, id string) (iam.Role, error)

+ func (s *Engine) Authenticate(r *http.Request) (auth.Verified, error)

+ func (s *Engine) AuthenticateResource(r *http.Request) (auth.Verified, error)

+ func (s *Engine) CreateDirectoryUser(ctx context.Context, t scim.Tenant, u scim.User) (scim.User, error)

+ func (s *Engine) DeclareRemoteApplications(ctx context.Context, ref iam.GroupRef, apps []iam.RemoteApplication, ...) error

+ func (s *Engine) DeleteDirectoryUser(ctx context.Context, t scim.Tenant, id string) error

+ func (s *Engine) DirectoryUser(ctx context.Context, t scim.Tenant, id string) (scim.User, error)

+ func (s *Engine) DirectoryUsers(ctx context.Context, t scim.Tenant, filter string, startIndex, count int) (scim.ListResponse[scim.User], error)

+ func (s *Engine) OAuthRemoteAssertion(ctx context.Context, in authflow.OAuthJWTBearer) (authflow.OAuthTokens, error)

+ func (s *Engine) PatchDirectoryUser(ctx context.Context, t scim.Tenant, id string, req scim.PatchRequest) (scim.User, error)

+ func (s *Engine) RecordRemoteUserClaims(ctx context.Context, groupID, issuer, subject string, c RemoteUserClaims) error

+ func (s *Engine) RemoteInvitations(ctx context.Context, v auth.Verified) ([]iam.Invitation, error)

+ func (s *Engine) RemoteUser(ctx context.Context, groupID, issuer, subject string) (RemoteUser, error)

+ func (s *Engine) RemoteUserInfo(ctx context.Context, groupID, issuer string, subjects []string) (map[string]userinfo.User, error)

+ func (s *Engine) RemoteUserRoles(ctx context.Context, ref iam.GroupRef) ([]iam.RemoteUserRole, error)

+ func (s *Engine) RemoveRemoteUserRole(ctx context.Context, who auth.Identity, ref iam.GroupRef, remoteUserID string, ...) error

+ func (s *Engine) ReplaceDirectoryUser(ctx context.Context, t scim.Tenant, id string, u scim.User) (scim.User, error)

+ func (s *Engine) ResourceEnabled() bool

+ func (s *Engine) SCIMTenant(ctx context.Context, who auth.Identity, boundGroup string) (scim.Tenant, error)

+ func (s *Engine) SearchRemoteUserInfo(ctx context.Context, groupID, issuer, query string, limit int) ([]userinfo.User, error)

+ func (s *Engine) VerifyResourceRequest(r *http.Request) (ResourceAccess, error)

+ type RemoteUser struct

+ Active bool

+ CreatedAt time.Time

+ Email string

+ GroupID string

+ ID string

+ Issuer string

+ Name string

+ ProvisionedAt *time.Time

+ Subject string

+ UpdatedAt time.Time

+ Username string

+ type RemoteUserClaims struct

+ Email string

+ EmailVerified bool

+ Name string

+ UpdatedAt time.Time

+ Username string

+ type ResourceAccess struct

+ Application *iam.RemoteApplication

+ Asserted bool

+ Ceilings []iam.Perm

+ Claims verify.Claims

+ Permissions []string

+ Scoped bool

+ func (a ResourceAccess) Group() string

v1.17.0

Oct 10, 2026

v1.16.0

Oct 10, 2026

Changes in this version

type Engine

+ func (s *Engine) RateLimiter(limits map[string]ratelimit.Limit) (ratelimit.Limiter, error)

v1.15.0

Oct 10, 2026

v1.14.0

Oct 10, 2026

Changes in this version

type Engine

+ func (s *Engine) SearchUserInfo(ctx context.Context, query string, limit int) ([]userinfo.User, error)

+ func (s *Engine) UserInfo(ctx context.Context, ids []string) (map[string]userinfo.User, error)

v1.13.0

Oct 10, 2026

v1.12.0

Oct 10, 2026

v1.11.0

Oct 9, 2026

Changes in this version

type Engine

+ func (s *Engine) AuthorizeSCIM(_ context.Context, accessToken, jkt string) error

+ func (s *Engine) Contacts(ctx context.Context, ids []string) (map[string]contacts.Contact, error)

+ func (s *Engine) ProvisioningTargets(ctx context.Context) ([]iam.ProvisioningTarget, error)

+ func (s *Engine) SCIMUser(ctx context.Context, id string) (scim.User, error)

+ func (s *Engine) SCIMUsers(ctx context.Context, filter string, startIndex, count int) (scim.ListResponse[scim.User], error)

+ func (s *Engine) SearchContacts(ctx context.Context, query string, limit int) ([]contacts.Contact, error)

v1.10.1

Oct 9, 2026

v1.10.0

Oct 9, 2026

Changes in this version

type Engine

+ func (s *Engine) OAuthJWTBearer(ctx context.Context, in authflow.OAuthJWTBearer) (authflow.OAuthTokens, error)

v1.9.0

Oct 9, 2026

v1.8.0

Oct 9, 2026

v1.7.0

Oct 9, 2026

Changes in this version

type Engine

+ func (s *Engine) RootGroupID(ctx context.Context) (string, error)

v1.6.1

Oct 9, 2026

v1.6.0

Oct 9, 2026

Changes in this version

type Engine

+ func (s *Engine) RevokeOAuthGrant(ctx context.Context, grantID string, opts ...ops.Option) error

v1.5.0

Oct 9, 2026

Changes in this version

type Engine

+ func (s *Engine) ApproveOAuthAuthorization(ctx context.Context, userID, sessionID, id string) (string, error)

+ func (s *Engine) BeginOAuthAuthorization(ctx context.Context, a authflow.OAuthAuthorization) (string, error)

+ func (s *Engine) DeclineOAuthAuthorization(ctx context.Context, id, code string) (string, error)

+ func (s *Engine) EndOAuthSession(ctx context.Context, in authflow.OAuthEndSession) (string, error)

+ func (s *Engine) ExchangeOAuthCode(ctx context.Context, in authflow.OAuthCodeExchange) (authflow.OAuthTokens, error)

+ func (s *Engine) ExchangeOAuthToken(ctx context.Context, in authflow.OAuthTokenExchange) (authflow.OAuthTokens, error)

+ func (s *Engine) OAuthAuthorization(ctx context.Context, id string) (authflow.OAuthAuthorization, error)

+ func (s *Engine) OAuthClientCredentials(ctx context.Context, in authflow.OAuthClientCredentials) (authflow.OAuthTokens, error)

+ func (s *Engine) OAuthUserInfo(ctx context.Context, accessToken, jkt string) (map[string]any, error)

+ func (s *Engine) RefreshOAuthTokens(ctx context.Context, in authflow.OAuthRefresh) (authflow.OAuthTokens, error)

+ func (s *Engine) RevokeOAuthToken(ctx context.Context, clientID, token string) error

v1.4.0

Oct 8, 2026

v1.3.1

Oct 5, 2026

v1.3.0

Oct 4, 2026

Changes in this version

type Engine

+ func (s *Engine) ConfirmDeviceVerification(ctx context.Context, in authflow.DeviceVerificationInput) (authflow.LoginOutcome, error)

+ func (s *Engine) SendDeviceVerification(ctx context.Context, userID, challenge, channel string) (*authflow.DeviceChallenge, error)

v1.2.0

Oct 1, 2026

Changes in this version

type Engine

+ func (s *Engine) PatchPublicMetadata(ctx context.Context, a iam.Actor, userID string, patch map[string]any, ...) error

v1.1.1

Oct 1, 2026

v1.1.0

Sep 30, 2026

Changes in this version

type Engine

+ func (s *Engine) BeginPasskeyStepUp(ctx context.Context, userID, sessionID string) (*protocol.CredentialAssertion, error)

+ func (s *Engine) BeginSolanaStepUp(ctx context.Context, userID, sessionID, domain string) (siws.SignInInput, error)

+ func (s *Engine) Send2FAStepUpCode(ctx context.Context, userID, sessionID, factorID string) error

+ func (s *Engine) SendStepUpCode(ctx context.Context, userID, sessionID, channel string) error

+ func (s *Engine) SetClock(now func() time.Time)

+ func (s *Engine) StepUpWithCode(ctx context.Context, userID, sessionID, code string) error

+ func (s *Engine) StepUpWithPasskey(ctx context.Context, userID, sessionID string, response []byte) error

+ func (s *Engine) StepUpWithSolana(ctx context.Context, userID, sessionID string, output siws.SignInOutput) error

+ func (s *Engine) UnlinkProvider(ctx context.Context, userID, provider string) error

+ func (s *Engine) Verify2FAStepUpCode(ctx context.Context, userID, sessionID, factorID, code string) (bool, error)

v1.0.3

Sep 30, 2026

v1.0.2

Sep 30, 2026

v0

v0.149.0

Sep 30, 2026

Changes in this version

type Engine

+ func (s *Engine) ConsumeOIDCResult(ctx context.Context, code string) (json.RawMessage, bool, error)

+ func (s *Engine) Disable2FA(ctx context.Context, userID string) error

+ func (s *Engine) Disable2FAFactor(ctx context.Context, userID, factorID string) error

+ func (s *Engine) EmailAvailable() bool

+ func (s *Engine) EmailHealth() (time.Time, error)

+ func (s *Engine) PutOIDCResult(ctx context.Context, code string, result json.RawMessage) error

+ func (s *Engine) RelabelDeviceKey(ctx context.Context, userID, id, label string) (iam.DeviceKey, error)

+ func (s *Engine) RemovePhone(ctx context.Context, a iam.Actor, userID string) error

+ func (s *Engine) SetDefault2FAFactor(ctx context.Context, userID, factorID string) (authflow.TwoFactorFactor, error)

+ func (s *Engine) UserSecurity(ctx context.Context, in authflow.ProfileInput) (authflow.UserSecurity, error)

v0.148.0

Sep 30, 2026

Changes in this version

+ func ParseBootstrapManifestYAML(raw []byte) (iam.BootstrapManifest, error)

type Engine

+ func (s *Engine) RolePermissions(role iam.Role) ([]iam.Perm, error)

+ func (s *Engine) TwoFactorMethods() []iam.TwoFactorMethod

v0.147.0

Sep 30, 2026

Changes in this version

+ func Migrate(ctx context.Context, pool *pgxpool.Pool, cfg config.Config, ...) error

+ type Authenticator struct

+ func (a *Authenticator) CheckIssuerKeys(ctx context.Context) error

+ func (a *Authenticator) IssuerKeyStatuses() []verify.IssuerKeyStatus

+ func (a *Authenticator) Verify(ctx context.Context, token string) (verify.Claims, error)

+ func (a *Authenticator) VerifyRequest(r *http.Request) (verify.Claims, error)

+ func (a *Authenticator) VerifyServiceJWT(ctx context.Context, token string, opts ...verify.ServiceJWTVerifyOption) (iam.ServiceJWTClaims, error)

+ type Engine struct

+ func New(ctx context.Context, cfg config.Config, deps config.Deps) (_ *Engine, err error)

+ func (s *Engine) AddMFAEnrollmentExemptRoutes(paths []string)

+ func (s *Engine) ApplyBootstrapManifest(ctx context.Context, manifest iam.BootstrapManifest, opts iam.BootstrapOptions, ...) (iam.BootstrapResult, error)

+ func (s *Engine) Ban(ctx context.Context, a iam.Actor, userID string, b iam.Ban, opts ...ops.Option) error

+ func (s *Engine) BeginDeviceKeyEnrollment(ctx context.Context, email, publicKey, label string) (authflow.DeviceKeyChallenge, error)

+ func (s *Engine) BeginDeviceKeyLogin(ctx context.Context, deviceKeyID string) (authflow.DeviceKeyChallenge, error)

+ func (s *Engine) BeginPasskeyLogin(ctx context.Context) (*protocol.CredentialAssertion, error)

+ func (s *Engine) BeginPasskeyRegistration(ctx context.Context, userID string) (*protocol.CredentialCreation, error)

+ func (s *Engine) BeginTwoFactorEnrollment(ctx context.Context, userID string, enrollmentToken bool, sessionID string) (authflow.TwoFactorEnrollmentScope, error)

+ func (s *Engine) Can(ctx context.Context, a iam.Actor, ref iam.GroupRef, perm iam.Perm) (bool, error)

+ func (s *Engine) ChangePassword(ctx context.Context, userID, current, new string, keepSessionID *string) error

+ func (s *Engine) CheckIssuerKeys(ctx context.Context) error

+ func (s *Engine) CheckPendingRegistrationConflict(ctx context.Context, email, username string) (bool, bool, error)

+ func (s *Engine) CheckPhoneRegistrationConflict(ctx context.Context, phone, username string) (bool, bool, error)

+ func (s *Engine) CheckRecentSignIn(ctx context.Context, cl verify.Claims) error

+ func (s *Engine) CheckSession(ctx context.Context, cl verify.Claims) error

+ func (s *Engine) CheckUserPassword(ctx context.Context, userID, pass string) error

+ func (s *Engine) CheckUsername(ctx context.Context, name string) error

+ func (s *Engine) ClaimDPoPProof(ctx context.Context, key string, ttl time.Duration) (bool, error)

+ func (s *Engine) Close()

+ func (s *Engine) CompleteExternalLogin(ctx context.Context, in authflow.ExternalLoginInput) (authflow.LoginOutcome, error)

+ func (s *Engine) CompleteLoginChallenge(ctx context.Context, in authflow.LoginChallengeInput) (authflow.LoginOutcome, error)

+ func (s *Engine) Config() config.Config

+ func (s *Engine) ConfirmAccountRecovery(ctx context.Context, token string) error

+ func (s *Engine) ConfirmPasswordReset(ctx context.Context, token, newPassword string) (string, error)

+ func (s *Engine) ConfirmVerification(ctx context.Context, in authflow.VerificationInput) (authflow.LoginOutcome, error)

+ func (s *Engine) ConsumeOIDCState(ctx context.Context, state string) (oidcstate.StateData, bool, error)

+ func (s *Engine) ContinueRefreshMFA(ctx context.Context, userID, sessionID string) (authflow.LoginOutcome, error)

+ func (s *Engine) CreateAPIKey(ctx context.Context, a iam.Actor, ref iam.GroupRef, k iam.NewAPIKey, ...) (iam.APIKeyCreated, error)

+ func (s *Engine) CreateGroup(ctx context.Context, ng iam.NewGroup, opts ...ops.Option) (iam.Group, error)

+ func (s *Engine) CreateInvitation(ctx context.Context, a iam.Actor, ref iam.GroupRef, n iam.NewInvitation, ...) (iam.InvitationCreated, error)

+ func (s *Engine) CreateUser(ctx context.Context, n iam.NewUser, opts ...ops.Option) (iam.User, error)

+ func (s *Engine) DelegationAuthorizer() iam.DelegationAuthorizer

+ func (s *Engine) DeleteGroup(ctx context.Context, ref iam.GroupRef, opts ...ops.Option) error

+ func (s *Engine) DeletePasskey(ctx context.Context, userID, id string) error

+ func (s *Engine) DeletePendingPhoneRegistrationByPhone(ctx context.Context, phone string) error

+ func (s *Engine) DeletePendingRegistrationByEmail(ctx context.Context, email string) error

+ func (s *Engine) DeleteRemoteApplication(ctx context.Context, actor iam.Actor, ref iam.GroupRef, id string, ...) error

+ func (s *Engine) DeleteUsers(ctx context.Context, a iam.Actor, ids []string, opts ...ops.Option) ([]iam.OpResult, error)

+ func (s *Engine) DeviceKeys(ctx context.Context, userID string) ([]iam.DeviceKey, error)

+ func (s *Engine) Disable2FAFactorWithRemovedRoles(ctx context.Context, userID, factorID string) ([]authflow.RemovedMFARoleAssignment, error)

+ func (s *Engine) Disable2FAWithRemovedRoles(ctx context.Context, userID string) ([]authflow.RemovedMFARoleAssignment, error)

+ func (s *Engine) EffectivePermissions(ctx context.Context, a iam.Actor, refs []iam.GroupRef) (map[string][]iam.Perm, error)

+ func (s *Engine) EnrollTwoFactor(ctx context.Context, in authflow.TwoFactorEnrollInput) (authflow.TwoFactorEnrollOutcome, error)

+ func (s *Engine) EnsureUserRole(ctx context.Context, ref iam.GroupRef, u iam.UserRef, role iam.Role, ...) (iam.User, error)

+ func (s *Engine) ExchangeRefreshToken(ctx context.Context, refreshToken string, ua string, ip net.IP) (idToken string, expiresAt time.Time, newRefresh string, err error)

+ func (s *Engine) FinishDeviceKeyEnrollment(ctx context.Context, enrollmentID, code, signature, secondFactor string) (authflow.DeviceKeyAuthResult, error)

+ func (s *Engine) FinishDeviceKeyLogin(ctx context.Context, challengeID, signature string) (authflow.DeviceKeyAuthResult, error)

+ func (s *Engine) FinishPasskeyLogin(ctx context.Context, response []byte, userAgent string, ip net.IP) (authflow.LoginOutcome, error)

+ func (s *Engine) FinishPasskeyRegistration(ctx context.Context, userID string, response []byte) (authflow.Passkey, error)

+ func (s *Engine) GenerateSIWSChallenge(ctx context.Context, domain, address, username string) (siws.SignInInput, error)

+ func (s *Engine) Get2FASettings(ctx context.Context, userID string) (*authflow.TwoFactorSettings, error)

+ func (s *Engine) GetPendingPhoneRegistrationByPhone(ctx context.Context, phone string) (*authflow.PendingRegistration, error)

+ func (s *Engine) GetPendingRegistrationByEmail(ctx context.Context, email string) (*authflow.PendingRegistration, error)

+ func (s *Engine) GetProviderLinkByIssuer(ctx context.Context, issuer, subject string) (string, *string, error)

+ func (s *Engine) GetRemoteApplication(ctx context.Context, issuer string) (*iam.RemoteApplication, error)

+ func (s *Engine) Group(ctx context.Context, ref iam.GroupRef) (iam.Group, error)

+ func (s *Engine) GroupRoles(ctx context.Context, ref iam.GroupRef, subjects []iam.Subject) (map[iam.Subject]iam.Role, error)

+ func (s *Engine) Groups(ctx context.Context, ids []string) (map[string]iam.Group, error)

+ func (s *Engine) HasEmailSender() bool

+ func (s *Engine) HasPassword(ctx context.Context, userID string) (bool, error)

+ func (s *Engine) HasProviderLink(ctx context.Context, userID, issuer, providerSlug string) (bool, error)

+ func (s *Engine) HasUsableMFA(ctx context.Context, userID string) (bool, error)

+ func (s *Engine) ImportSolanaLinks(ctx context.Context, rows []iam.ImportSolanaLink, opts ...ops.Option) (iam.ImportSolanaLinksResult, error)

+ func (s *Engine) ImportUsers(ctx context.Context, rows []iam.ImportUser, opts iam.ImportOptions, ...) (iam.ImportResult, error)

+ func (s *Engine) IssuerKeyStatuses() []verify.IssuerKeyStatus

+ func (s *Engine) JWKS() keys.JWKS

+ func (s *Engine) KnownPermission(perm iam.Perm) bool

+ func (s *Engine) LinkProvider(ctx context.Context, userID string, l iam.ProviderLink, opts ...ops.Option) error

+ func (s *Engine) LinkSolanaWallet(ctx context.Context, userID string, output siws.SignInOutput) error

+ func (s *Engine) ListAPIKeys(ctx context.Context, ref iam.GroupRef, p iam.PageRequest) (iam.ListPage[iam.APIKey], error)

+ func (s *Engine) ListDeviceKeys(ctx context.Context, userID, currentID string) ([]iam.DeviceKey, error)

+ func (s *Engine) ListEnabledRemoteApplications(ctx context.Context) ([]iam.RemoteApplication, error)

+ func (s *Engine) ListGroupMembers(ctx context.Context, ref iam.GroupRef, q iam.MemberQuery) (iam.ListPage[iam.GroupMember], error)

+ func (s *Engine) ListGroups(ctx context.Context, q iam.GroupQuery) (iam.ListPage[iam.Group], error)

+ func (s *Engine) ListInvitations(ctx context.Context, ref iam.GroupRef, p iam.PageRequest) (iam.ListPage[iam.Invitation], error)

+ func (s *Engine) ListMemberships(ctx context.Context, subject iam.Subject, p iam.PageRequest) (iam.ListPage[iam.Membership], error)

+ func (s *Engine) ListPasskeys(ctx context.Context, userID string) ([]authflow.Passkey, error)

+ func (s *Engine) ListRemoteApplications(ctx context.Context, ref iam.GroupRef, page iam.PageRequest) (iam.ListPage[iam.RemoteApplication], error)

+ func (s *Engine) ListSessionEvents(ctx context.Context, userID string, q iam.SessionEventQuery) (iam.ListPage[iam.SessionEvent], error)

+ func (s *Engine) ListUserSessions(ctx context.Context, userID string) ([]authflow.Session, error)

+ func (s *Engine) ListUsers(ctx context.Context, q iam.UserQuery) (iam.ListPage[iam.UserEntry], error)

+ func (s *Engine) LogSessionFailed(ctx context.Context, userID string, sessionID string, reason *string, ...)

+ func (s *Engine) MarkSessionAuthenticated(ctx context.Context, userID, sessionID string) error

+ func (s *Engine) MarkSessionAuthenticatedWithMethods(ctx context.Context, userID, sessionID string, authMethods []string) error

+ func (s *Engine) MintAccessToken(ctx context.Context, userID string, o iam.AccessTokenOptions, ...) (iam.Token, error)

+ func (s *Engine) MintDelegatedAccessToken(ctx context.Context, actor iam.Actor, d iam.DelegatedAccess, ...) (iam.Token, error)

+ func (s *Engine) MintServiceJWT(ctx context.Context, opts iam.ServiceJWT, options ...ops.Option) (iam.Token, iam.ServiceJWTClaims, error)

+ func (s *Engine) MintSessionAccessToken(ctx context.Context, userID, sessionID string) (string, time.Time, error)

+ func (s *Engine) NewAuthenticator(audiences []string, opts ...verify.VerifierOption) (*Authenticator, error)

+ func (s *Engine) ParseBootstrapManifestYAML(raw []byte) (iam.BootstrapManifest, error)

+ func (s *Engine) PasskeysEnabled() bool

+ func (s *Engine) PasswordLogin(ctx context.Context, in authflow.PasswordLoginInput) (authflow.LoginOutcome, error)

+ func (s *Engine) PasswordlessLogin(ctx context.Context, in authflow.PasswordlessLoginInput) (authflow.LoginOutcome, error)

+ func (s *Engine) PatchUserMetadata(ctx context.Context, a iam.Actor, userID string, patch map[string]any, ...) error

+ func (s *Engine) Permission(text string) (iam.Perm, error)

+ func (s *Engine) PermissionGroupSchema() *rbac.Schema

+ func (s *Engine) Persona(name string) (iam.Persona, error)

+ func (s *Engine) ProviderSlugs(ctx context.Context, userID string) ([]string, error)

+ func (s *Engine) PublicKeysByKID() map[string]crypto.PublicKey

+ func (s *Engine) PublicNativeUserRegistrationEnabled() bool

+ func (s *Engine) PublicUsers(ctx context.Context, ids []string) (map[string]iam.PublicUser, error)

+ func (s *Engine) PurgeGroup(ctx context.Context, ref iam.GroupRef, opts ...ops.Option) error

+ func (s *Engine) PurgeUsers(ctx context.Context, ids []string, opts ...ops.Option) ([]iam.OpResult, error)

+ func (s *Engine) PutOIDCState(ctx context.Context, state string, data oidcstate.StateData) error

+ func (s *Engine) RecordFailedDeviceKeyEnrollment(ctx context.Context, enrollmentID string)

+ func (s *Engine) RedeemInvitation(ctx context.Context, a iam.Actor, code string) (authflow.InviteRedemption, error)

+ func (s *Engine) RegenerateBackupCodes(ctx context.Context, userID string) ([]string, error)

+ func (s *Engine) Register(ctx context.Context, in authflow.RegisterInput) (authflow.RegisterOutcome, error)

+ func (s *Engine) RegistrationVerificationEnabled() bool

+ func (s *Engine) RemoteApplication(ctx context.Context, ref iam.AppRef) (iam.RemoteApplication, error)

+ func (s *Engine) RemoveGroupMember(ctx context.Context, a iam.Actor, ref iam.GroupRef, subject iam.Subject, ...) error

+ func (s *Engine) RenamePasskey(ctx context.Context, userID, id, label string) error

+ func (s *Engine) RequestEmailChange(ctx context.Context, userID, newEmail string) error

+ func (s *Engine) RequestEmailVerification(ctx context.Context, email string, ttl time.Duration) error

+ func (s *Engine) RequestPasswordReset(ctx context.Context, email string, ttl time.Duration, ip *string, ua *string) error

+ func (s *Engine) RequestPhoneChange(ctx context.Context, userID, newPhone string) error

+ func (s *Engine) RequestPhonePasswordReset(ctx context.Context, phone string, ttl time.Duration, ip *string, ua *string) error

+ func (s *Engine) RequestPhoneVerification(ctx context.Context, phone string, ttl time.Duration) error

+ func (s *Engine) Require2FAForStepUpMethod(ctx context.Context, userID, sessionID, method string) (destination, selectedMethod string, factor authflow.TwoFactorFactor, err error)

+ func (s *Engine) RequireProvenContact(ctx context.Context, userID string) error

+ func (s *Engine) ResendLoginChallenge(ctx context.Context, userID, nonce, factorID string) (*authflow.TwoFactorChallenge, error)

+ func (s *Engine) ResetAccountMFA(ctx context.Context, userID string, opts ...ops.Option) error

+ func (s *Engine) ResolveAPIKey(ctx context.Context, token string) (iam.APIKeyPrincipal, error)

+ func (s *Engine) ResolveUsername(ctx context.Context, name string) (iam.NameResolution, error)

+ func (s *Engine) RestoreUsers(ctx context.Context, a iam.Actor, ids []string, opts ...ops.Option) ([]iam.OpResult, error)

+ func (s *Engine) RevokeAPIKey(ctx context.Context, a iam.Actor, ref iam.GroupRef, id string, ...) error

+ func (s *Engine) RevokeAccountSessions(ctx context.Context, a iam.Actor, userID string, opts ...ops.Option) (iam.AccountSessionRevocation, error)

+ func (s *Engine) RevokeDeviceKey(ctx context.Context, userID, currentID, targetID string) error

+ func (s *Engine) RevokeInvitation(ctx context.Context, a iam.Actor, ref iam.GroupRef, id string, ...) error

+ func (s *Engine) RevokeIssuerSessions(ctx context.Context, userID string, keepSessionID *string) error

+ func (s *Engine) RevokeOtherDeviceKeys(ctx context.Context, userID, currentID string) error

+ func (s *Engine) RevokeSession(ctx context.Context, a iam.Actor, userID, sessionID string, opts ...ops.Option) error

+ func (s *Engine) RevokeSessionByIDForUser(ctx context.Context, userID, sessionID string) error

+ func (s *Engine) RiverJobs() riverhelpers.Contribution

+ func (s *Engine) Role(text string) (iam.Role, error)

+ func (s *Engine) SMSAvailable() bool

+ func (s *Engine) SMSHealth() (time.Time, error)

+ func (s *Engine) SendWelcome(ctx context.Context, userID string)

+ func (s *Engine) SessionFreshness(ctx context.Context, userID, sessionID string, now time.Time) (authflow.SessionFreshness, error)

+ func (s *Engine) Sessions(ctx context.Context, userID string) ([]iam.Session, error)

+ func (s *Engine) SetGroupRole(ctx context.Context, a iam.Actor, ref iam.GroupRef, subject iam.Subject, ...) (iam.GroupMember, error)

+ func (s *Engine) SetPasswordAfterFreshAuth(ctx context.Context, userID, new string, keepSessionID *string) error

+ func (s *Engine) Start(ctx context.Context) error

+ func (s *Engine) StartPasswordless(ctx context.Context, req authflow.PasswordlessStartRequest) (authflow.PasswordlessStartResult, error)

+ func (s *Engine) StepUpRequired(ctx context.Context, userID string) error

+ func (s *Engine) TwoFactorAllowedMethods() []string

+ func (s *Engine) TwoFactorEnabled() bool

+ func (s *Engine) Unban(ctx context.Context, a iam.Actor, userID string, opts ...ops.Option) error

+ func (s *Engine) UnlinkProviderUnlessLast(ctx context.Context, userID, provider string) (bool, error)

+ func (s *Engine) UpdateUser(ctx context.Context, a iam.Actor, userID string, u iam.UserUpdate, ...) (iam.User, error)

+ func (s *Engine) UpsertRemoteApplication(ctx context.Context, actor iam.Actor, ref iam.GroupRef, ...) (iam.RemoteApplication, error)

+ func (s *Engine) User(ctx context.Context, ref iam.UserRef, opts ...ops.Option) (iam.User, error)

+ func (s *Engine) UserEntry(ctx context.Context, userID string) (iam.UserEntry, error)

+ func (s *Engine) UserMetadata(ctx context.Context, userID string) (map[string]any, error)

+ func (s *Engine) UserNamingState(ctx context.Context, id string) (naming.State, error)

+ func (s *Engine) UserProfile(ctx context.Context, in authflow.ProfileInput) (authflow.UserProfile, error)

+ func (s *Engine) Users(ctx context.Context, ids []string) (map[string]iam.User, error)

+ func (s *Engine) ValidatePassword(value string, identifiers ...string) error

+ func (s *Engine) ValidateUsername(username string) error

+ func (s *Engine) ValidateUsernameForRegistration(ctx context.Context, username string) (string, error)

+ func (s *Engine) Verify(ctx context.Context, token string) (verify.Claims, error)

+ func (s *Engine) Verify2FAStepUpMethodCode(ctx context.Context, userID, sessionID, method, code string) (bool, error)

+ func (s *Engine) VerifyBackupCode(ctx context.Context, userID, backupCode string) (bool, error)

+ func (s *Engine) VerifyPendingPassword(ctx context.Context, email, pass string) bool

+ func (s *Engine) VerifyPendingPhonePassword(ctx context.Context, phone, pass string) bool

+ func (s *Engine) VerifyRequest(r *http.Request) (verify.Claims, error)

+ func (s *Engine) VerifySIWSAndLogin(ctx context.Context, output siws.SignInOutput, extra map[string]any) (authflow.LoginOutcome, error)

+ func (s *Engine) VerifyServiceJWT(ctx context.Context, token string, opts ...verify.ServiceJWTVerifyOption) (iam.ServiceJWTClaims, error)

+ type SolanaSNSResolver interface

+ ResolvePrimaryName func(ctx context.Context, address string) (string, error)

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