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

profiles

package

Go to main page

Versions in this module

v1

v1.18.3

Apr 27, 2026

v1.18.2

Apr 16, 2026

v1.18.1

Apr 13, 2026

v1.18.0

Apr 13, 2026

v1.17.0

Apr 1, 2026

v1.16.11

Mar 25, 2026

v1.16.10

Mar 25, 2026

v1.16.9

Mar 25, 2026

v1.16.8

Mar 24, 2026

v1.16.7

Mar 24, 2026

v1.16.6

Mar 24, 2026

v1.16.5

Mar 23, 2026

v1.16.4

Mar 23, 2026

v1.16.3

Mar 23, 2026

v1.16.2

Mar 23, 2026

v1.16.1

Mar 23, 2026

v1.16.0

Mar 23, 2026

v1.15.0

Mar 17, 2026

v1.14.0

Mar 15, 2026

v1.13.3

Mar 11, 2026

v1.13.2

Mar 11, 2026

v1.13.1

Mar 11, 2026

v1.13.0

Mar 11, 2026

Changes in this version

+ var BuiltinProviders = map[string]*ProviderMetadata

+ func CalculateBillingDisable(errorCount int, cfg *ProfileCooldownConfig) time.Duration

+ func CalculateRateLimitCooldown(cfg *ProfileCooldownConfig) time.Duration

+ func ClearExpiredCooldowns(store *ProfileStore) bool

+ func FormatProfileList(result *ProfileListResult) string

+ func GetOAuthScopes(provider string, service string) ([]string, error)

+ func GetSuggestedProfileNames(provider string) []string

+ func IsAuthCooldownBypassedForProfile(store *ProfileStore, id ProfileID) bool

+ func IsProfileInCooldown(store *ProfileStore, id ProfileID) bool

+ func IsValidProvider(name string) bool

+ func MarkProfileFailure(store *ProfileStore, id ProfileID, reason FailureReason, ...)

+ func NewStore(cfg StoreConfig) (*vaultStore, error)

+ func RegisterCustomProvider(metadata *ProviderMetadata) error

+ func ResolveProfileUnusableUntil(store *ProfileStore, id ProfileID) *time.Time

+ func SupportsMode(provider string, mode AuthMode) bool

+ type APIKeyCredential struct

+ Key string

+ KeyRef string

+ type AuthMode string

+ const ModeAPIKey

+ const ModeOAuth

+ const ModeToken

+ type AuthProfile struct

+ APIKey *APIKeyCredential

+ CreatedAt time.Time

+ Enabled bool

+ ID ProfileID

+ LastError string

+ LastErrorAt *time.Time

+ LastUsedAt *time.Time

+ Mode AuthMode

+ Name string

+ OAuth *OAuthCredential

+ Priority int

+ Provider string

+ Token *TokenCredential

+ UpdatedAt time.Time

+ func (p *AuthProfile) ClearError()

+ func (p *AuthProfile) GetAPIKey(vaultGetter func(string) (string, error)) (string, error)

+ func (p *AuthProfile) GetToken(vaultGetter func(string) (string, error)) (string, error)

+ func (p *AuthProfile) IsExpired() bool

+ func (p *AuthProfile) IsValid() bool

+ func (p *AuthProfile) MarkError(err error)

+ func (p *AuthProfile) MarkUsed()

+ type FailureReason string

+ const FailureAuth

+ const FailureAuthPermanent

+ const FailureBilling

+ const FailureFormat

+ const FailureModelNotFound

+ const FailureRateLimit

+ const FailureSessionExpired

+ const FailureTimeout

+ const FailureUnknown

+ func ClassifyFailure(err error) FailureReason

+ func ClassifyFailureMessage(msg string) FailureReason

+ type FallbackChain struct

+ func NewFallbackChain(resolver *Resolver, providers ...string) *FallbackChain

+ func (f *FallbackChain) Resolve(ctx context.Context) (*ProfileResolutionResult, error)

+ type MultiResolver struct

+ func NewMultiResolver(resolver *Resolver) *MultiResolver

+ func (m *MultiResolver) ResolveAll(ctx context.Context, providers []string) map[string]*ProfileResolutionResult

+ type OAuthCredential struct

+ AccessToken string

+ ClientID string

+ Email string

+ ExpiresAt time.Time

+ Metadata map[string]string

+ ProfileName string

+ Provider string

+ RefreshToken string

+ Scopes []string

+ func (c *OAuthCredential) FromOAuthCredential(oc *oauth.OAuthCredential, profileName string)

+ func (c *OAuthCredential) IsExpired(buffer time.Duration) bool

+ func (c *OAuthCredential) IsValid() bool

+ func (c *OAuthCredential) ToOAuthCredential() *oauth.OAuthCredential

+ type OAuthEndpoint struct

+ AuthURL string

+ Scopes []string

+ TokenURL string

+ type OAuthManager interface

+ GetValidToken func(provider string) (*oauth.OAuthCredential, error)

+ SaveCredential func(cred *oauth.OAuthCredential) error

+ type OAuthTokenRefresher interface

+ RefreshToken func(provider, refreshToken string) (*oauth.OAuthCredential, error)

+ type ProfileAddArgs struct

+ APIKey string

+ Mode string

+ Name string

+ Priority int

+ Provider string

+ Token string

+ type ProfileAddResult struct

+ Error string

+ ProfileID string

+ Success bool

+ type ProfileCooldownConfig struct

+ BillingBackoffHours float64

+ BillingMaxHours float64

+ ByProvider map[string]ProviderCooldownOverride

+ FailureWindowHours float64

+ RateLimitSeconds int

+ type ProfileDeleteArgs struct

+ ProfileID string

+ type ProfileDeleteResult struct

+ Error string

+ Success bool

+ type ProfileEnableArgs struct

+ Enable bool

+ ProfileID string

+ type ProfileEnableResult struct

+ Error string

+ Success bool

+ type ProfileExportArgs struct

+ ProfileID string

+ type ProfileExportResult struct

+ Data json.RawMessage

+ Error string

+ Mode string

+ Success bool

+ type ProfileID string

+ func NewProfileID(provider, name string) ProfileID

+ func (p ProfileID) Name() string

+ func (p ProfileID) Provider() string

+ func (p ProfileID) String() string

+ type ProfileImportArgs struct

+ Data json.RawMessage

+ Mode string

+ Name string

+ Provider string

+ type ProfileImportResult struct

+ Error string

+ ProfileID string

+ Success bool

+ type ProfileListArgs struct

+ Enabled *bool

+ Mode string

+ Provider string

+ type ProfileListItem struct

+ Email string

+ Enabled bool

+ Expired bool

+ ID string

+ LastError string

+ LastUsedAt time.Time

+ Mode string

+ Name string

+ Priority int

+ Provider string

+ Valid bool

+ type ProfileListResult struct

+ Profiles []ProfileListItem

+ Total int

+ type ProfileManager interface

+ ClearExpiredCooldowns func()

+ Delete func(id ProfileID) error

+ Get func(id ProfileID) (*AuthProfile, bool)

+ GetByProvider func(provider string, preference ProfilePreference) []*AuthProfile

+ IsInCooldown func(id ProfileID) bool

+ List func() []*AuthProfile

+ MarkError func(id ProfileID, err error)

+ MarkFailure func(id ProfileID, reason FailureReason)

+ MarkUsed func(id ProfileID)

+ Resolve func(opts ResolutionOptions) *ProfileResolutionResult

+ Save func(profile *AuthProfile) error

+ type ProfilePreference string

+ const PreferDefault

+ const PreferRecent

+ const PreferType

+ const PreferValid

+ type ProfileResolutionResult struct

+ AttemptedProfiles []ProfileID

+ Credential string

+ Email string

+ Error error

+ Profile *AuthProfile

+ Provider string

+ type ProfileSetPriorityArgs struct

+ Priority int

+ ProfileID string

+ type ProfileSetPriorityResult struct

+ Error string

+ Success bool

+ type ProfileStore struct

+ LastGood map[string]string

+ Profiles map[string]*AuthProfile

+ UsageStats map[string]*ProfileUsageStats

+ Version int

+ func NewProfileStore() *ProfileStore

+ func (s *ProfileStore) Delete(id ProfileID)

+ func (s *ProfileStore) Get(id ProfileID) (*AuthProfile, bool)

+ func (s *ProfileStore) GetUsageStats(id ProfileID) *ProfileUsageStats

+ func (s *ProfileStore) List() []*AuthProfile

+ func (s *ProfileStore) ListByProvider(provider string) []*AuthProfile

+ func (s *ProfileStore) MarkAuthProfileGood(provider string, id ProfileID)

+ func (s *ProfileStore) MarshalJSON() ([]byte, error)

+ func (s *ProfileStore) Set(p *AuthProfile)

+ type ProfileTestArgs struct

+ ProfileID string

+ type ProfileTestResult struct

+ Email string

+ Error string

+ Expired bool

+ ExpiresIn time.Duration

+ Success bool

+ Valid bool

+ type ProfileTools struct

+ func NewProfileTools(store ProfileManager, resolver *Resolver) *ProfileTools

+ func (t *ProfileTools) Add(ctx context.Context, args ProfileAddArgs) (*ProfileAddResult, error)

+ func (t *ProfileTools) Delete(ctx context.Context, args ProfileDeleteArgs) (*ProfileDeleteResult, error)

+ func (t *ProfileTools) Enable(ctx context.Context, args ProfileEnableArgs) (*ProfileEnableResult, error)

+ func (t *ProfileTools) Export(ctx context.Context, args ProfileExportArgs) (*ProfileExportResult, error)

+ func (t *ProfileTools) Import(ctx context.Context, args ProfileImportArgs) (*ProfileImportResult, error)

+ func (t *ProfileTools) List(ctx context.Context, args ProfileListArgs) (*ProfileListResult, error)

+ func (t *ProfileTools) Providers(ctx context.Context) (*ProvidersListResult, error)

+ func (t *ProfileTools) SetPriority(ctx context.Context, args ProfileSetPriorityArgs) (*ProfileSetPriorityResult, error)

+ func (t *ProfileTools) Test(ctx context.Context, args ProfileTestArgs) (*ProfileTestResult, error)

+ type ProfileUsageStats struct

+ CooldownUntil *time.Time

+ DisabledReason FailureReason

+ DisabledUntil *time.Time

+ ErrorCount int

+ FailureCounts map[FailureReason]int

+ LastFailureAt *time.Time

+ LastUsed *time.Time

+ type ProviderCooldownOverride struct

+ BillingBackoffHours float64

+ RateLimitSeconds int

+ type ProviderInfo struct

+ Description string

+ EnvKey string

+ Label string

+ Modes []string

+ Name string

+ Website string

+ type ProviderMetadata struct

+ Description string

+ EnvKey string

+ Label string

+ Modes []AuthMode

+ Name string

+ OAuthEndpoint OAuthEndpoint

+ ParentProvider string

+ Scopes []string

+ Website string

+ func GetProvider(name string) (*ProviderMetadata, bool)

+ func GetProviderWithScopes(name string) (*ProviderMetadata, bool)

+ func ListProviders() []*ProviderMetadata

+ func ListProvidersByMode(mode AuthMode) []*ProviderMetadata

+ type ProvidersListResult struct

+ Providers []ProviderInfo

+ type ResolutionOptions struct

+ Mode AuthMode

+ Preference ProfilePreference

+ PreferredProfile string

+ Provider string

+ RequireValid bool

+ type Resolver struct

+ func NewResolver(cfg ResolverConfig) *Resolver

+ func (r *Resolver) GetCacheStats() map[string]interface{}

+ func (r *Resolver) InvalidateCache(provider string)

+ func (r *Resolver) Resolve(ctx context.Context, provider string, preferredProfile string) (*ProfileResolutionResult, error)

+ func (r *Resolver) ResolveAPIKey(ctx context.Context, provider string) (string, *AuthProfile, error)

+ func (r *Resolver) ResolveAny(ctx context.Context, provider string) (*ProfileResolutionResult, error)

+ func (r *Resolver) ResolveOAuth(ctx context.Context, provider string) (*oauth.OAuthCredential, *AuthProfile, error)

+ func (r *Resolver) ResolveWithMode(ctx context.Context, provider string, mode AuthMode) (*ProfileResolutionResult, error)

+ type ResolverConfig struct

+ DefaultPreference ProfilePreference

+ Logger *slog.Logger

+ OAuthManager OAuthManager

+ Store ProfileManager

+ type StoreConfig struct

+ CachePath string

+ CooldownConfig *ProfileCooldownConfig

+ Logger *slog.Logger

+ OAuthManager OAuthManager

+ Vault VaultInterface

+ type TokenCredential struct

+ ExpiresAt *time.Time

+ Token string

+ TokenRef string

+ type VaultInterface interface

+ Delete func(name string) error

+ Get func(name string) (string, error)

+ Has func(name string) bool

+ IsUnlocked func() bool

+ Set func(name, value string) error