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

deviceauth

package module

Go to main page

Versions in this module

v0

v0.1.2

Sep 27, 2026

v0.1.1

Sep 27, 2026

v0.1.0

Sep 19, 2026

Changes in this version

+ var ErrCredentialScopeMismatch = errors.New("deviceauth: credential issuer or client ID does not match")

+ func ValidateRequiredScopes(granted, required []string) error

+ type Authentication struct

+ Credential Credential

+ Identity Identity

+ Login LoginResult

+ SessionToken *oauth2.Token

+ Warnings []error

+ type Client struct

+ func NewClient(config ClientConfig) (*Client, error)

+ func (c *Client) DeviceLogin(ctx context.Context, options DeviceLoginOptions) (LoginResult, error)

+ func (c *Client) DeviceLoginAndStore(ctx context.Context, options DeviceLoginOptions, store Store) (Authentication, error)

+ func (c *Client) Issuer() string

+ func (c *Client) Logout(ctx context.Context, store Store) error

+ func (c *Client) NewKeyringStore() (Store, error)

+ func (c *Client) OAuthConfig() oauth2.Config

+ func (c *Client) Revoke(ctx context.Context, token string) error

+ func (c *Client) ScopedStore(store Store) Store

+ func (c *Client) UserInfo(ctx context.Context, token *oauth2.Token) (Identity, error)

+ type ClientConfig struct

+ ClientID string

+ Issuer string

+ KeyringAccount string

+ KeyringService string

+ RequiredScopes []string

+ Scopes []string

type Credential

+ ClientID string

+ Issuer string

+ type DeviceLoginOptions struct

+ DeviceInfo DeviceInfo

+ ErrorOutput io.Writer

+ OpenBrowser func(string) error

+ Output io.Writer

+ TokenTransformer TokenTransformer

+ type Identity struct

+ Audience []string

+ Email string

+ Name string

+ Scopes []string

+ Subject string

+ type ReplacementRevocationWarning struct

+ Cause error

+ func (e *ReplacementRevocationWarning) Error() string

+ func (e *ReplacementRevocationWarning) Unwrap() error

+ type ResponseError struct

+ OAuthError string

+ Operation string

+ StatusCode int

+ func (e *ResponseError) Error() string

+ type TokenTransformer func(context.Context, *oauth2.Token) (*oauth2.Token, error)

v0.0.2

Sep 1, 2026

Changes in this version

+ type DeviceInfo struct

+ Arch string

+ ClientVersion string

+ Name string

+ OS string

type LoginOptions

+ DeviceInfo DeviceInfo

v0.0.1

Aug 31, 2026

Changes in this version

+ var ErrCredentialNotFound = errors.New("deviceauth: credential not found")

+ func OpenBrowser(rawURL string) error

+ type Credential struct

+ AccessToken string

+ AccountID string

+ AccountName string

+ Expiry time.Time

+ RefreshToken string

+ Scopes []string

+ TokenType string

+ type FileStore struct

+ func NewFileStore(path string) (*FileStore, error)

+ func (s *FileStore) Delete() error

+ func (s *FileStore) Load() (Credential, error)

+ func (s *FileStore) Save(credential Credential) error

+ type KeyringStore struct

+ func NewKeyringStore(service, account string) (*KeyringStore, error)

+ func (s *KeyringStore) Delete() error

+ func (s *KeyringStore) Load() (Credential, error)

+ func (s *KeyringStore) Save(credential Credential) error

+ type LoginOptions struct

+ ErrorOutput io.Writer

+ OAuthConfig oauth2.Config

+ OpenBrowser func(string) error

+ Output io.Writer

+ type LoginResult struct

+ Authorization *oauth2.DeviceAuthResponse

+ BrowserOpened bool

+ Token *oauth2.Token

+ func Login(ctx context.Context, options LoginOptions) (LoginResult, error)

+ type Store interface

+ Delete func() error

+ Load func() (Credential, error)

+ Save func(Credential) error