Help us shape the future of Go! Take the 2026 Go Developer Survey

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

api

package module

Go to main page

Versions in this module

v0

v0.1.3

Oct 26, 2026

v0.1.2

Oct 3, 2026

v0.1.1

Oct 2, 2026

v0.1.0

Sep 28, 2026

Changes in this version

+ var ErrClosed = errors.New("api: closed")

+ var ErrConflict = errors.New("api: conflict")

+ var ErrForbidden = errors.New("api: forbidden")

+ var ErrInvalid = errors.New("api: invalid input")

+ var ErrNotFound = errors.New("api: not found")

+ var ErrUnauthorized = errors.New("api: unauthorized")

+ var ErrUnavailable = errors.New("api: verification unavailable")

+ type Cache interface

+ Close func() error

+ Invalidate func()

+ Lookup func(ctx context.Context, key string, change uint64) (ReadResult, error)

+ Start func(ctx context.Context) error

+ type CacheFactory func(Source) (Cache, error)

+ type Client struct

+ Banned bool

+ CreatedAt time.Time

+ ID string

+ Name string

+ Scopes []string

+ type Config struct

+ DefaultTTL time.Duration

+ MaxTTL time.Duration

+ Scopes []string

+ type Credential struct

+ ClientID string

+ CreatedAt time.Time

+ Generation int64

+ ID string

+ Name string

+ RevokedAt *time.Time

+ Scopes []string

+ type IssueRequest struct

+ ClientID string

+ Name string

+ Scopes []string

+ TTL time.Duration

+ type Issued struct

+ Credential Credential

+ ExpiresAt time.Time

+ Token string

+ type Option func(*settings) error

+ func WithCache(factory CacheFactory, maxStaleness time.Duration) Option

+ type Principal struct

+ ClientID string

+ CredentialID string

+ Scopes []string

+ type ReadResult struct

+ Generation uint64

+ ReadAt time.Time

+ Record Record

+ type Record struct

+ Client Client

+ Credential Credential

+ Secret SecretVersion

+ type RotateRequest struct

+ CredentialID string

+ ExpectedGeneration int64

+ GracePeriod time.Duration

+ TTL time.Duration

+ type SecretVersion struct

+ CreatedAt time.Time

+ CredentialID string

+ Digest [32]byte

+ ExpiresAt time.Time

+ Generation int64

+ ID string

+ type Service struct

+ func New(store Store, cfg Config, options ...Option) (*Service, error)

+ func (s *Service) Authenticate(ctx context.Context, token string, required ...string) (Principal, error)

+ func (s *Service) Client(ctx context.Context, id string) (Client, error)

+ func (s *Service) Clients(ctx context.Context, after string, limit int) ([]Client, error)

+ func (s *Service) Close() error

+ func (s *Service) CreateClient(ctx context.Context, name string, scopes []string) (Client, error)

+ func (s *Service) Credential(ctx context.Context, id string) (Credential, error)

+ func (s *Service) Credentials(ctx context.Context, clientID, after string, limit int) ([]Credential, error)

+ func (s *Service) Errors() <-chan error

+ func (s *Service) Issue(ctx context.Context, req IssueRequest) (Issued, error)

+ func (s *Service) Revoke(ctx context.Context, id string) error

+ func (s *Service) RevokeAll(ctx context.Context, clientID string) error

+ func (s *Service) Rotate(ctx context.Context, req RotateRequest) (Issued, error)

+ func (s *Service) SetClientBanned(ctx context.Context, id string, banned bool) error

+ func (s *Service) SetClientScopes(ctx context.Context, id string, scopes []string) error

+ func (s *Service) Start(ctx context.Context) error

+ type Snapshot struct

+ Generation uint64

+ ReadAt time.Time

+ Records map[string]Record

+ type Source interface

+ Lookup func(ctx context.Context, secretID string) (ReadResult, error)

+ MaxStaleness func() time.Duration

+ Now func() time.Time

+ Snapshot func(ctx context.Context) (Snapshot, error)

+ type Store interface

+ Client func(ctx context.Context, id string) (Client, error)

+ Clients func(ctx context.Context, afterID string, limit int) ([]Client, error)

+ CreateClient func(ctx context.Context, client Client) error

+ Credential func(ctx context.Context, id string) (Credential, error)

+ Credentials func(ctx context.Context, clientID, afterID string, limit int) ([]Credential, error)

+ Issue func(ctx context.Context, cred Credential, version SecretVersion) error

+ Lookup func(ctx context.Context, secretID string) (Record, error)

+ Revoke func(ctx context.Context, id string, at time.Time) error

+ RevokeAll func(ctx context.Context, clientID string, at time.Time) error

+ Rotate func(ctx context.Context, credID string, expectedGeneration int64, ...) (Credential, error)

+ SetClientBanned func(ctx context.Context, id string, banned bool) error

+ SetClientScopes func(ctx context.Context, id string, scopes []string) error

+ Snapshot func(ctx context.Context) (map[string]Record, error)

+ type TimedStore interface

+ IssueWithLifetime func(ctx context.Context, cred Credential, version SecretVersion, ttl time.Duration) (Credential, SecretVersion, error)

+ RotateWithLifetime func(ctx context.Context, credID string, expectedGeneration int64, ...) (Credential, SecretVersion, error)

+ type Watcher interface

+ Watch func(ctx context.Context, invalidate func()) error

+ type WatcherWithErrors interface

+ WatchWithErrors func(ctx context.Context, invalidate func(), report func(error)) error