embedded

package

Go to main page

Versions in this module

v0

v0.80.0

Jul 4, 2026

Changes in this version

type Client

+ func (s *Client) AssignRolesBySlugAs(ctx context.Context, actorUserID string, userIDs []string, slug string) ([]authkit.OpResult, error)

+ func (s *Client) HardDeleteUsers(ctx context.Context, userIDs []string) ([]authkit.OpResult, error)

+ func (s *Client) MintAccessToken(ctx context.Context, userID string, extra map[string]any) (string, time.Time, error)

+ func (s *Client) ProviderUsernames(ctx context.Context, userIDs []string, provider string) (map[string]string, error)

+ func (s *Client) RemoveRolesBySlugAs(ctx context.Context, actorUserID string, userIDs []string, slug string) ([]authkit.OpResult, error)

+ func (s *Client) RestoreUsers(ctx context.Context, userIDs []string) ([]authkit.OpResult, error)

+ func (s *Client) RoleSlugsByUsers(ctx context.Context, userIDs []string) (map[string][]string, error)

+ func (s *Client) SoftDeleteUsers(ctx context.Context, userIDs []string) ([]authkit.OpResult, error)

v0.79.0

Jul 4, 2026

Changes in this version

type Client

+ func (s *Client) Genesis() GenesisClient

+ type GenesisClient struct

+ func (g GenesisClient) AssignGroupRole(ctx context.Context, ...) error

+ func (g GenesisClient) AssignRoleBySlug(ctx context.Context, userID, slug string) error

+ func (g GenesisClient) RemoveGroupSubject(ctx context.Context, persona, instanceSlug, subjectID, subjectKind string) error

+ func (g GenesisClient) RemoveRoleBySlug(ctx context.Context, userID, slug string) error

v0.78.0

Jul 3, 2026

v0.77.0

Jul 3, 2026

Changes in this version

type Client

+ func (s *Client) Config() Config

v0.76.0

Jul 2, 2026

v0.75.0

Jun 29, 2026

v0.74.1

Jun 29, 2026

v0.74.0

Jun 29, 2026

v0.73.0

Jun 26, 2026

Changes in this version

type Client

+ func (s *Client) LeaveGroup(ctx context.Context, userID, persona, instanceSlug string) error

v0.72.0

Jun 26, 2026

Changes in this version

+ const TwoFactorDisabled

+ const TwoFactorEmail

+ const TwoFactorOptional

+ const TwoFactorRequired

+ const TwoFactorSMS

+ const TwoFactorTOTP

+ var WithClickHouse = authcore.WithClickHouse

type Client

+ func (s *Client) CreateAccountRegistrationInvite(ctx context.Context, req authkit.CreateAccountRegistrationInviteRequest) (authkit.AccountRegistrationInviteCreated, error)

+ func (s *Client) RBACDriftReport(ctx context.Context) (authkit.RBACDriftReport, error)

+ func (s *Client) ResolveAPIKeyDetailed(ctx context.Context, keyID, secret string) (authkit.ResolvedAPIKey, error)

+ func (s *Client) RevokeAccountRegistrationInvite(ctx context.Context, inviteID, actorUserID string) error

+ type PersonaCapabilities = authcore.PersonaCapabilities

v0.71.0

Jun 26, 2026

v0.70.0

Jun 26, 2026

v0.69.0

Jun 26, 2026

v0.68.0

Jun 26, 2026

Changes in this version

+ func Unwrap(c *Client) *authcore.Service

type Option

+ func WithRedis(rd *redis.Client) Option

v0.67.0

Jun 26, 2026

v0.66.0

Jun 26, 2026

Changes in this version

type Client

+ func (s *Client) UsersByIDs(ctx context.Context, ids []string) ([]authkit.UserRef, error)

v0.65.0

Jun 26, 2026

Changes in this version

+ const AssuranceLevelMFA

+ const AssuranceLevelPassword

+ const DefaultBootstrapManifestPath

+ const DelegatedAccessTokenType

+ const EphemeralMemory

+ const EphemeralRedis

+ const ErrCodeInvalidEmail

+ const ErrCodeInvalidPhoneNumber

+ const ErrCodeOwnerSlugTaken

+ const ErrCodePasswordTooShort

+ const ErrCodeRenameRateLimited

+ const ErrCodeUsernameCannotContainAt

+ const ErrCodeUsernameCannotStartWithPlus

+ const ErrCodeUsernameInvalidCharacters

+ const ErrCodeUsernameMustStartWithLetter

+ const ErrCodeUsernameNotAllowed

+ const ErrCodeUsernameTooLong

+ const ErrCodeUsernameTooShort

+ const HashAlgoLegacyResetRequired

+ const KindChangeEmail

+ const KindChangePhone

+ const KindRegisterEmail

+ const KindRegisterPhone

+ const MaxCustomJWTLifetime

+ const OwnerRoleName

+ const PasswordlessChannelEmail

+ const PasswordlessChannelSMS

+ const PasswordlessModeBoth

+ const PasswordlessModeCode

+ const PasswordlessModeLink

+ const PermRootCredentialsManage

+ const PermRootResourcesRead

+ const PermRootRolesManage

+ const PermRootUsersBan

+ const PermRootUsersDelete

+ const PermRootUsersRecover

+ const RegistrationModeAdminBootstrapOnly

+ const RegistrationModeAdminOnly

+ const RegistrationModeClosed

+ const RegistrationModeInviteOnly

+ const RegistrationModeManifestOnly

+ const RegistrationModeOpen

+ const RegistrationVerificationNone

+ const RegistrationVerificationOptional

+ const RegistrationVerificationRequired

+ const RemoteApplicationAccessTokenType

+ const RootPersona

+ const SensitiveActionFreshAuthWindow

+ const ServiceJWTType

+ const SessionEventCreated

+ const SessionEventFailed

+ const SessionEventPasswordChange

+ const SessionEventPasswordRecovery

+ const SessionEventRevoked

+ const SessionRevokeReasonAdminRevoke

+ const SessionRevokeReasonAdminRevokeAll

+ const SessionRevokeReasonAdminSetPassword

+ const SessionRevokeReasonBanned

+ const SessionRevokeReasonEvicted

+ const SessionRevokeReasonLogout

+ const SessionRevokeReasonPasswordChange

+ const SessionRevokeReasonRefreshReuseDetected

+ const SessionRevokeReasonSoftDeleted

+ const SessionRevokeReasonUnknown

+ const SessionRevokeReasonUserDisabled

+ const SessionRevokeReasonUserRevoke

+ const SessionRevokeReasonUserRevokeAll

+ const SolanaProviderSlug

+ const SolanaSNSStatusDisabled

+ const SolanaSNSStatusError

+ const SolanaSNSStatusNotFound

+ const SolanaSNSStatusPending

+ const SolanaSNSStatusResolved

+ const SolanaSNSStatusStale

+ const SubjectKindRemoteApp

+ const SubjectKindUser

+ var BuildSchema = authcore.BuildSchema

+ var IntrinsicRootPermissions = authcore.IntrinsicRootPermissions

+ var IntrinsicRootPersona = authcore.IntrinsicRootPersona

+ var IsDevEnvironment = authcore.IsDevEnvironment

+ var LoadBootstrapManifestFile = authcore.LoadBootstrapManifestFile

+ var MintDelegatedAccessToken = authcore.MintDelegatedAccessToken

+ var MintRemoteApplicationAccessToken = authcore.MintRemoteApplicationAccessToken

+ var MintServiceJWT = authcore.MintServiceJWT

+ var NewGroupSchema = authcore.NewGroupSchema

+ var NewPermissionGroupStore = authcore.NewPermissionGroupStore

+ var NormalizeEmail = authcore.NormalizeEmail

+ var NormalizePhone = authcore.NormalizePhone

+ var NormalizePreferredLanguage = authcore.NormalizePreferredLanguage

+ var NormalizeRemoteAppTrustSource = authcore.NormalizeRemoteAppTrustSource

+ var OwnerGrant = authcore.OwnerGrant

+ var ParseBootstrapManifestYAML = authcore.ParseBootstrapManifestYAML

+ var PermCredentialsManage = authcore.PermCredentialsManage

+ var PermCredentialsRead = authcore.PermCredentialsRead

+ var PermMembersManage = authcore.PermMembersManage

+ var PermMembersRead = authcore.PermMembersRead

+ var PermRolesManage = authcore.PermRolesManage

+ var PermRolesRead = authcore.PermRolesRead

+ var PermissionPersona = authcore.PermissionPersona

+ var ValidateEmail = authcore.ValidateEmail

+ var ValidateGrantPattern = authcore.ValidateGrantPattern

+ var ValidatePassword = authcore.ValidatePassword

+ var ValidatePermission = authcore.ValidatePermission

+ var ValidatePhone = authcore.ValidatePhone

+ var ValidateUsername = authcore.ValidateUsername

+ var ValidationErrorCode = authcore.ValidationErrorCode

+ var WithAPIKeyResourceAuthorizer = authcore.WithAPIKeyResourceAuthorizer

+ var WithAuthLogger = authcore.WithAuthLogger

+ var WithDBTXWrapper = authcore.WithDBTXWrapper

+ var WithEmailSender = authcore.WithEmailSender

+ var WithEntitlements = authcore.WithEntitlements

+ var WithEphemeralStore = authcore.WithEphemeralStore

+ var WithPostgres = authcore.WithPostgres

+ var WithSMSSender = authcore.WithSMSSender

+ var WithSessionRevokeReason = authcore.WithSessionRevokeReason

+ var WithSolanaSNSResolver = authcore.WithSolanaSNSResolver

+ type APIKeyResourceAuthorizationRequest = authcore.APIKeyResourceAuthorizationRequest

+ type APIKeyResourceAuthorizer = authcore.APIKeyResourceAuthorizer

+ type APIKeyResourceAuthorizerFunc = authcore.APIKeyResourceAuthorizerFunc

+ type APIKeysConfig = authcore.APIKeysConfig

+ type AdminRecoverUserInput = authcore.AdminRecoverUserInput

+ type AuthEventLogReader = authcore.AuthEventLogReader

+ type AuthEventLogger = authcore.AuthEventLogger

+ type AuthSessionEvent = authcore.AuthSessionEvent

+ type BatchEntitlementsProvider = authcore.BatchEntitlementsProvider

+ type Client struct

+ func New(cfg Config, pg *pgxpool.Pool, extraOpts ...Option) (*Client, error)

+ func Wrap(impl *authcore.Service) *Client

+ func (s *Client) AdminCountUsers(ctx context.Context, opts authkit.AdminUserListOptions) (int64, error)

+ func (s *Client) AdminGetUser(ctx context.Context, id string) (*authkit.AdminUser, error)

+ func (s *Client) AdminListUserSessions(ctx context.Context, userID string) ([]authkit.Session, error)

+ func (s *Client) AdminListUsers(ctx context.Context, opts authkit.AdminUserListOptions) (*authkit.AdminListUsersResult, error)

+ func (s *Client) AdminRevokeUserSessions(ctx context.Context, userID string) error

+ func (s *Client) AdminSetPassword(ctx context.Context, userID, new string) error

+ func (s *Client) ApplyBootstrapManifest(ctx context.Context, manifest authkit.BootstrapManifest, ...) (authkit.BootstrapManifestResult, error)

+ func (s *Client) ApplyBootstrapManifestFile(ctx context.Context, path string, opts authkit.BootstrapReconcileOptions) (authkit.BootstrapManifestResult, error)

+ func (s *Client) AssignGroupRole(ctx context.Context, ...) error

+ func (s *Client) AssignGroupRoleAs(ctx context.Context, ...) error

+ func (s *Client) AssignRoleBySlug(ctx context.Context, userID, slug string) error

+ func (s *Client) AssignRoleBySlugAs(ctx context.Context, actorUserID, userID, slug string) error

+ func (s *Client) BanUser(ctx context.Context, userID string, reason *string, until *time.Time, ...) error

+ func (s *Client) Can(ctx context.Context, ...) (bool, error)

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

+ func (s *Client) CheckSMSHealth(ctx context.Context) error

+ func (s *Client) CleanupExpiredAuthState(ctx context.Context) error

+ func (s *Client) ClearPasswordlessCodeAttempts(ctx context.Context, identifier string)

+ func (s *Client) ConfirmPasswordlessCode(ctx context.Context, identifier, code string) (authkit.PasswordlessConfirmResult, error)

+ func (s *Client) ConfirmPasswordlessToken(ctx context.Context, token string) (authkit.PasswordlessConfirmResult, error)

+ func (s *Client) CreateGroupInviteLink(ctx context.Context, req authkit.CreateGroupInviteLinkRequest) (authkit.GroupInviteLinkCreated, error)

+ func (s *Client) CreatePermissionGroup(ctx context.Context, req authkit.CreatePermissionGroupRequest) (string, error)

+ func (s *Client) CreateUser(ctx context.Context, email, username string) (*authkit.User, error)

+ func (s *Client) DeleteRemoteApplication(ctx context.Context, issuer string) error

+ func (s *Client) EnsureRootGroup(ctx context.Context) (string, error)

+ func (s *Client) EntitlementsProvider() EntitlementsProvider

+ func (s *Client) EphemeralMode() EphemeralMode

+ func (s *Client) ExchangeRefreshToken(ctx context.Context, refreshToken string, ua string, ip net.IP) (string, time.Time, string, error)

+ func (s *Client) ExternalInvitesEnabled() bool

+ func (s *Client) GetEmailByUserID(ctx context.Context, id string) (string, error)

+ func (s *Client) GetProviderUsername(ctx context.Context, userID, provider string) (string, error)

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

+ func (s *Client) GetUserByEmail(ctx context.Context, email string) (*authkit.User, error)

+ func (s *Client) GetUserByPhone(ctx context.Context, phone string) (*authkit.User, error)

+ func (s *Client) GetUserBySolanaAddress(ctx context.Context, address string) (*authkit.User, error)

+ func (s *Client) GetUserByUsername(ctx context.Context, username string) (*authkit.User, error)

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

+ func (s *Client) HardDeleteUser(ctx context.Context, userID string) error

+ func (s *Client) HasEmailSender() bool

+ func (s *Client) HasSMSSender() bool

+ func (s *Client) ImportUsers(ctx context.Context, inputs []authkit.ImportUserInput) (authkit.ImportUsersResult, error)

+ func (s *Client) IsUserAllowed(ctx context.Context, userID string) (bool, error)

+ func (s *Client) IssueAccessToken(ctx context.Context, userID, email string, extra map[string]any) (string, time.Time, error)

+ func (s *Client) JWKS() jwtkit.JWKS

+ func (s *Client) Keyfunc() func(token *jwt.Token) (any, error)

+ func (s *Client) LinkProvider(ctx context.Context, userID, provider, subject string, email *string) error

+ func (s *Client) LinkProviderByIssuer(ctx context.Context, userID, issuer, providerSlug, subject string, ...) error

+ func (s *Client) ListAPIKeys(ctx context.Context, persona, instanceSlug string) ([]authkit.APIKey, error)

+ func (s *Client) ListEffectivePermissions(ctx context.Context, subjectID, subjectKind, persona, instanceSlug string) ([]string, error)

+ func (s *Client) ListEntitlements(ctx context.Context, userID string) []string

+ func (s *Client) ListGroupInviteLinks(ctx context.Context, persona, instanceSlug string) ([]authkit.GroupInviteLink, error)

+ func (s *Client) ListGroupMembers(ctx context.Context, persona, instanceSlug string) ([]authkit.GroupMember, error)

+ func (s *Client) ListRemoteApplications(ctx context.Context, activeOnly bool) ([]authkit.RemoteApplication, error)

+ func (s *Client) ListRoleSlugsByUser(ctx context.Context, userID string) []string

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

+ func (s *Client) ListSubjectGroups(ctx context.Context, subjectID, subjectKind string) ([]authkit.SubjectGroupMembership, error)

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

+ func (s *Client) ListUsersDeletedBefore(ctx context.Context, cutoff time.Time, limit int) ([]string, error)

+ func (s *Client) MintAPIKey(ctx context.Context, persona, instanceSlug, name, role, createdBy string, ...) (authkit.APIKey, string, error)

+ func (s *Client) MintAPIKeyWithOptions(ctx context.Context, persona, instanceSlug string, ...) (authkit.APIKey, string, error)

+ func (s *Client) MintCustomJWT(ctx context.Context, opts authkit.CustomJWTMintOptions) (string, error)

+ func (s *Client) MintDelegatedAccessToken(ctx context.Context, p authkit.DelegatedAccessParams) (string, error)

+ func (s *Client) MintRemoteApplicationAccessToken(ctx context.Context, p authkit.RemoteApplicationAccessParams) (string, error)

+ func (s *Client) MintServiceJWT(ctx context.Context, opts authkit.ServiceJWTMintOptions) (string, authkit.ServiceJWTClaims, error)

+ func (s *Client) Options() Options

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

+ func (s *Client) Postgres() *pgxpool.Pool

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

+ func (s *Client) RecordFailedPasswordlessCode(ctx context.Context, identifier string)

+ func (s *Client) RedeemGroupInviteLink(ctx context.Context, code, redeemerUserID string) (authkit.RedeemGroupInviteLinkResult, error)

+ func (s *Client) RemoveGroupSubjectAs(ctx context.Context, ...) error

+ func (s *Client) RemoveRoleBySlug(ctx context.Context, userID, slug string) error

+ func (s *Client) RemoveRoleBySlugAs(ctx context.Context, actorUserID, userID, slug string) error

+ func (s *Client) ResolveAPIKey(ctx context.Context, keyID, secret string) (string, []string, error)

+ func (s *Client) ResolveAPIKeyWithResources(ctx context.Context, keyID, secret string) (authkit.ResolvedAPIKey, error)

+ func (s *Client) ResolveGroupIDForSlug(ctx context.Context, persona, instanceSlug string) (string, error)

+ func (s *Client) ResolveRemoteAppAttributeDef(ctx context.Context, appID, key string, version int32) (*authkit.RemoteAppAttributeDef, error)

+ func (s *Client) ResolveRemoteApplicationAuthority(ctx context.Context, appID string) ([]string, error)

+ func (s *Client) RestoreUser(ctx context.Context, id string) error

+ func (s *Client) RevokeAPIKey(ctx context.Context, persona, instanceSlug, tokenID string) (bool, error)

+ func (s *Client) RevokeAllSessions(ctx context.Context, userID string, keepSessionID *string) error

+ func (s *Client) RevokeGroupInviteLink(ctx context.Context, persona, instanceSlug, linkID string) error

+ func (s *Client) SMSAvailable() bool

+ func (s *Client) Schema() string

+ func (s *Client) SeedPermissionGroupContainment(ctx context.Context) error

+ func (s *Client) SetEmailVerified(ctx context.Context, id string, v bool) error

+ func (s *Client) SetEntitlementsProvider(p EntitlementsProvider)

+ func (s *Client) SoftDeleteUser(ctx context.Context, id string) error

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

+ func (s *Client) TimeUntilUsernameRenameAvailable(ctx context.Context, userID string, now time.Time) (int64, error)

+ func (s *Client) UnassignGroupRoleAs(ctx context.Context, ...) error

+ func (s *Client) UnbanUser(ctx context.Context, userID string) error

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

+ func (s *Client) UpdateBiography(ctx context.Context, id string, bio *string) error

+ func (s *Client) UpdateEmail(ctx context.Context, id, email string) error

+ func (s *Client) UpdateImportedUser(ctx context.Context, userID string, input authkit.ImportUserInput) (*authkit.User, error)

+ func (s *Client) UpdateUsername(ctx context.Context, id, username string) error

+ func (s *Client) UpsertPasswordHash(ctx context.Context, userID, hash, algo string, params []byte) error

+ func (s *Client) UpsertRemoteApplication(ctx context.Context, in authkit.RemoteApplication) (*authkit.RemoteApplication, error)

+ func (s *Client) UpsertRoleBySlug(ctx context.Context, name, slug string, description *string) error

+ func (s *Client) ValidateVerificationConfiguration() error

+ func (s *Client) VerifyUserPassword(ctx context.Context, userID, pass string) bool

+ type Config = authcore.Config

+ type CustomRoleResolver = authcore.CustomRoleResolver

+ type EmailSender = authcore.EmailSender

+ type EntitlementFilterProvider = authcore.EntitlementFilterProvider

+ type EntitlementsProvider = authcore.EntitlementsProvider

+ type EphemeralMode = authcore.EphemeralMode

+ type EphemeralStore = authcore.EphemeralStore

+ type FrontendConfig = authcore.FrontendConfig

+ type GeneratedRoute = authcore.GeneratedRoute

+ type GroupAssignment = authcore.GroupAssignment

+ type GroupInviteEmailSender = authcore.GroupInviteEmailSender

+ type GroupInviteMessage = authcore.GroupInviteMessage

+ type GroupSchema = authcore.GroupSchema

+ type IdentityConfig = authcore.IdentityConfig

+ type KeysConfig = authcore.KeysConfig

+ type Keyset = authcore.Keyset

+ type ManagementProfile = authcore.ManagementProfile

+ type Option = authcore.Option

+ type Options = authcore.Options

+ type Passkey = authcore.Passkey

+ type PasskeyConfig = authcore.PasskeyConfig

+ type PasskeyLoginResult = authcore.PasskeyLoginResult

+ type PendingChangeKind = authcore.PendingChangeKind

+ type PendingRegistration = authcore.PendingRegistration

+ type PermissionDef = authcore.PermissionDef

+ type PermissionGroupStore = authcore.PermissionGroupStore

+ type PersonaDef = authcore.PersonaDef

+ type RBACConfig = authcore.RBACConfig

+ type RegistrationConfig = authcore.RegistrationConfig

+ type RegistrationMode = authcore.RegistrationMode

+ type RegistrationVerificationPolicy = authcore.RegistrationVerificationPolicy

+ type RemovedMFARoleAssignment = authcore.RemovedMFARoleAssignment

+ type RoleDef = authcore.RoleDef

+ type SMSHealthChecker = authcore.SMSHealthChecker

+ type SMSSender = authcore.SMSSender

+ type SessionEventType = authcore.SessionEventType

+ type SessionFreshness = authcore.SessionFreshness

+ type SessionRevokeReason = authcore.SessionRevokeReason

+ type SolanaConfig = authcore.SolanaConfig

+ type SolanaLinkedAccount = authcore.SolanaLinkedAccount

+ type SolanaSNSResolver = authcore.SolanaSNSResolver

+ type TokenConfig = authcore.TokenConfig

+ type TwoFactorConfig = authcore.TwoFactorConfig

+ type TwoFactorFactor = authcore.TwoFactorFactor

+ type TwoFactorSettings = authcore.TwoFactorSettings

+ type ValidationError = authcore.ValidationError

+ type VerificationMessage = authcore.VerificationMessage

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