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

v3

v3.9.0

Oct 6, 2026

v3.8.0

Sep 28, 2026

v3.7.1

Sep 8, 2026

v3.7.0

Sep 4, 2026

Changes in this version

+ const AccessTokenGracePeriod

+ const AuthTypePAT

+ const AuthTypeSSO

+ const SSOAuthServerBase

+ const SSOClientID

+ const SourceEnv

+ var ErrSSOSessionExpired = fmt.Errorf("SSO session expired")

+ func AccessTokenExpiry(rawToken string) (time.Time, error)

+ func AccountIDFromToken(token string) string

+ func CheckAndUpdateAccessToken(r *ResolvedAuth, now time.Time) error

+ func CodeChallenge(verifier string) string

+ func DeleteCredential(profileName string) error

+ func ExchangeCode(tokenEndpoint, clientID, code, verifier, redirectURI string) (accessToken, refreshToken string, err error)

+ func GenerateCodeVerifier() (string, error)

+ func IsAccessTokenExpiringSoon(rawToken string, now time.Time) bool

+ func LoadCredentials() (map[string]*ProfileCredentials, error)

+ func Masked(s string) string

+ func MaskedToken(s string) string

+ func NormalizeAPIURL(s string) string

+ func RandomState() (string, error)

+ func RefreshSSOToken(oldRefreshToken string) (accessToken, refreshToken string, err error)

+ func SSOAuthServerURL() string

+ func SSOClientIDValue() string

+ func SaveCredentials(creds map[string]*ProfileCredentials) error

+ func SetCredential(profileName, token string) error

+ func SetSSOCredentials(profileName, token, refreshToken string) error

+ func Validate(r *ResolvedAuth) error

+ func ValidateAPIURL(apiURL string) error

+ func ValidatePATFormat(token string) error

+ type AuthServerMeta struct

+ AuthorizationEndpoint string

+ Issuer string

+ RegistrationEndpoint string

+ TokenEndpoint string

+ func FetchAuthServerMeta(c *http.Client, authServerBaseURL string) (*AuthServerMeta, error)

+ type AuthType = config.AuthType

+ type ProfileCredentials struct

+ RefreshToken string

+ SSOToken string

+ Token string

+ type ResolvedAuth struct

+ APIUrl string

+ AccountID string

+ AuthType AuthType

+ Email string

+ ExplicitProfile string

+ OrgID string

+ PATToken string

+ ProjectID string

+ RefreshToken string

+ RegistryURL string

+ SSOToken string

+ Source string

+ TokenKind TokenKind

+ UIUrl string

+ UserID string

+ UserType string

+ func Load(profileFlag string) (*ResolvedAuth, error)

+ func Resolve(profileFlag string) (*ResolvedAuth, error)

+ func ResolveWithOverrides(profileFlag, orgOverride, projectOverride string) (*ResolvedAuth, error)

+ func (a *ResolvedAuth) SetAuthHeader(req *http.Request)

+ func (r *ResolvedAuth) LoginHint(cmd string) string

+ type TokenKind string

+ const TokenKindJWT

+ const TokenKindPAT

+ const TokenKindSAT

+ const TokenKindUnknown

+ func TokenType(token string) TokenKind