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

auth

package

Go to main page

Versions in this module

v0

v0.3.0

Jul 9, 2026

v0.2.0

Jun 23, 2026

Changes in this version

type AuthFile

+ Current string

+ Profiles map[string]Profile

+ type Profile struct

+ AuthType AuthType

+ InsecureAPIKey string

+ InsecureOAuthCredential *OAuthCredential

+ RemoteURL string

+ type Session struct

+ func ResolveSession(profileFlag string) (*Session, error)

+ func (s *Session) IsEphemeral() bool

+ func (s *Session) ProfileName() string

+ func (s *Session) RemoteURL() string

type Store

+ func (s *Store) CurrentProfile() (name string, profile Profile, ok bool)

+ func (s *Store) GetProfile(profileName string) (Profile, bool)

+ func (s *Store) ProfileNames() ([]string, error)

+ func (s *Store) RemoveProfile(profileName string) error

+ func (s *Store) SetAPIKeyProfile(profileName, remoteURL, apiKey string, switchCurrent bool, ...) error

+ func (s *Store) SetOAuthProfile(profileName, remoteURL string, cred OAuthCredential, switchCurrent bool, ...) error

+ func (s *Store) SwitchProfile(profileName string) error

type Transport

+ Session *Session

v0.1.0

May 22, 2026

Changes in this version

+ func DefaultConfigDir() (string, error)

+ func OAuthContext(ctx context.Context, base http.RoundTripper) context.Context

+ type AuthFile struct

+ Hosts map[string]HostEntry

+ Version int

+ type AuthType string

+ const AuthTypeAPIKey

+ const AuthTypeOAuth

+ type HostEntry struct

+ ActiveUser string

+ Users map[string]UserEntry

+ type OAuthCredential struct

+ AccessToken string

+ Expiry time.Time

+ RefreshToken string

+ type Store struct

+ func NewStore(opts StoreOptions) *Store

+ func (s *Store) ActiveUser(host string) (label string, entry UserEntry, ok bool)

+ func (s *Store) GetAPIKey(host, label string) (string, error)

+ func (s *Store) GetOAuthCredential(host, label string) (*OAuthCredential, error)

+ func (s *Store) Load() (*AuthFile, error)

+ func (s *Store) RemoveUser(host, label string) error

+ func (s *Store) Save(af *AuthFile) error

+ func (s *Store) SetAPIKeyUser(host, label, apiKey string, warnWriter func(string)) error

+ func (s *Store) SetOAuthUser(host, label string, cred OAuthCredential, warnWriter func(string)) error

+ func (s *Store) SwitchUser(host, label string) error

+ type StoreOptions struct

+ Dir string

+ InsecureStorage bool

+ type Transport struct

+ Base http.RoundTripper

+ EnvAPIKey string

+ Host string

+ OAuthConfig *oauth2.Config

+ Store *Store

+ func (t *Transport) Do(req *http.Request) (*http.Response, error)

+ type UserEntry struct

+ AuthType AuthType

+ InsecureAPIKey string

+ InsecureOAuthCredential *OAuthCredential