Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

authn

package module

Go to main page

Versions in this module

v0

v0.3.0

Aug 11, 2026

Changes in this version

type AuthContext

+ func (a *AuthContext) ExtraClaims() ExtraClaims

+ type ClaimSpec struct

+ Optional []string

+ Required []string

type ClientContext

+ ExtraClaims ExtraClaims

type ClientPrincipal

+ ExtraClaims ExtraClaims

type Config

+ ClientClaims ClaimSpec

+ RolesClaim string

+ UserClaims ClaimSpec

+ type ExtraClaims map[string]any

+ func (c ExtraClaims) String(name string) string

+ func (c ExtraClaims) Strings(name string) []string

+ type Option func(*TokenExtractor)

+ func WithClientClaims(spec ClaimSpec) Option

+ func WithRolesClaim(name string) Option

+ func WithUserClaims(spec ClaimSpec) Option

type UserContext

+ ExtraClaims ExtraClaims

type UserPrincipal

+ ExtraClaims ExtraClaims

+ Subject string

v0.2.0

Aug 1, 2026

v0.1.0

Jul 28, 2026

Changes in this version

+ func Middleware(userProfileService UserProfileService, tokenExtractor *TokenExtractor) func(http.Handler) http.Handler

+ func RequireAuth(userProfileService UserProfileService, tokenExtractor *TokenExtractor) func(http.Handler) http.Handler

+ type AllowedGrantType string

+ const AuthorizationCodeGrant

+ const ClientCredentialsGrant

+ type AuthContext struct

+ Client *ClientContext

+ User *UserContext

+ func GetAuthContext(ctx context.Context) *AuthContext

+ func (a *AuthContext) Roles() []string

+ func (a *AuthContext) Scopes() []string

+ func (a *AuthContext) Subject() string

+ func (a *AuthContext) Type() PrincipalType

+ type ClientContext struct

+ ClientID string

+ Roles []string

+ Scopes []string

+ type ClientPrincipal struct

+ ClientID string

+ Roles []string

+ Scopes []string

+ type Config struct

+ Audience string

+ ClientIDs []string

+ InsecureSkipTLSVerify bool

+ Issuer string

+ JWKSURL string

+ func (c Config) Validate() error

+ type ContextKey string

+ const AuthContextKey

+ type Manager struct

+ func NewManager(userProfileService UserProfileService, authConfig Config) (*Manager, error)

+ func (m *Manager) Close() error

+ func (m *Manager) Health() error

+ func (m *Manager) Middleware() func(http.Handler) http.Handler

+ func (m *Manager) OptionalAuthMiddleware() func(http.Handler) http.Handler

+ func (m *Manager) RequireAuthMiddleware() func(http.Handler) http.Handler

+ type Principal struct

+ ClientPrincipal *ClientPrincipal

+ Type PrincipalType

+ UserPrincipal *UserPrincipal

+ type PrincipalType string

+ const ClientPrincipalType

+ const UserPrincipalType

+ type TokenExtractor struct

+ func NewTokenExtractor(jwksURL, issuer, audience string, expectedClientIDs []string) (*TokenExtractor, error)

+ func NewTokenExtractorWithClient(jwksURL, issuer, audience string, expectedClientIDs []string, ...) (*TokenExtractor, error)

+ func (te *TokenExtractor) ExtractPrincipalFromHeader(authHeader string) (*Principal, error)

+ type UserContext struct

+ Email string

+ ID string

+ IDPUserID string

+ OUHandle string

+ OUID string

+ PhoneNumber string

+ Roles []string

+ Scopes []string

+ type UserPrincipal struct

+ Email string

+ OUHandle string

+ OUID string

+ PhoneNumber *string

+ Roles []string

+ Scopes []string

+ UserID string

+ type UserProfileService interface

+ GetOrCreateUser func(ctx context.Context, idpUserID, email, phone, orgID, ouHandle string) (string, error)