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.2.0

Jun 17, 2026

v0.1.5

May 28, 2026

v0.1.4

May 25, 2026

v0.1.3

May 25, 2026

v0.1.1

May 8, 2026

v0.1.0

May 8, 2026

v0.0.2

May 25, 2026

Changes in this version

+ const DefaultAPIKeyExpiryDays

+ const GRPCAppName

+ var CLIScopes = []string

+ var ErrEmailNotVerified = errors.New("auth: email not verified")

+ var ErrRefreshFailed = errors.New(...)

+ func APIKeyName(hostname string, now time.Time) string

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

+ func Audience() string

+ func ClientID() string

+ func DeviceCodeURL() string

+ func GenerateTenantDomain(orgName string) string

+ func Hostname() string

+ func IsExpired(token string, now time.Time) bool

+ func NewRegistrationPrompter(accessToken string) func() (*RegistrationInput, error)

+ func NormalizeTenantDomain(s string) string

+ func PrintVerification(verificationURL, userCode string)

+ func PromptTenantPicker(tenants []string) (string, error)

+ func RefreshAndPersistIfExpired(ctx context.Context, store cloud.CredentialStore, creds *cloud.Credentials, ...) (*cloud.Credentials, error)

+ func RegisterTenant(ctx context.Context, in RegisterTenantInput) (string, error)

+ func SaveAPIKey(_ context.Context, store cloud.CredentialStore, in APIKeyInput) error

+ func SaveBootstrapResult(store cloud.CredentialStore, accessToken, refreshToken string, ...) error

+ func TokenURL() string

+ func VerifyAPIKey(ctx context.Context, in APIKeyInput) error

+ type APIKeyInput struct

+ APIKey string

+ Tenant string

+ type BootstrapInput struct

+ APIKeyExpiryDays int

+ APIKeyName string

+ AccessToken string

+ ConnFor ControlPlaneConnFunc

+ CreateAPIKey bool

+ Picker TenantPicker

+ PreferredTenant string

+ RegistrationPrompter func() (*RegistrationInput, error)

+ type BootstrapResult struct

+ APIKey string

+ APIKeyExpiresAt time.Time

+ Tenant string

+ func PostOAuthBootstrap(ctx context.Context, in BootstrapInput) (*BootstrapResult, error)

+ type ControlPlaneConnFunc func(token, tenant string) (*grpc.ClientConn, error)

+ type DeviceFlowResult struct

+ AccessToken string

+ RefreshToken string

+ func RefreshTokens(ctx context.Context, accessToken, refreshToken string) (*DeviceFlowResult, error)

+ func RunDeviceFlow(ctx context.Context, sink DeviceFlowSink, retries ...DeviceFlowRetry) (*DeviceFlowResult, error)

+ type DeviceFlowRetry struct

+ OnExhausted func() error

+ OnRetry func(err error)

+ ShouldRetry func(err error) bool

+ func EmailVerificationRetry(stdin io.Reader) DeviceFlowRetry

+ type DeviceFlowSink func(verificationURL, userCode string)

+ type RegisterTenantInput struct

+ AccessToken string

+ ConnFor ControlPlaneConnFunc

+ Email string

+ Name string

+ OrganizationDomain string

+ OrganizationName string

+ type RegistrationInput struct

+ Email string

+ Name string

+ OrganizationDomain string

+ OrganizationName string

+ func PromptRegistration(accessToken string) (RegistrationInput, error)

+ type Status struct

+ APIKey bool

+ OAuth bool

+ OAuthExpiresAt time.Time

+ Profile string

+ Tenant string

+ func BuildStatus(_ context.Context, profile string, opts []cloud.KeychainOption) (Status, error)

+ type TenantPicker func(tenants []string) (string, error)