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

cboxid

package module

Go to main page

Versions in this module

v0

v0.5.0

Jul 26, 2026

Changes in this version

+ const HintAccessToken

+ const HintRefreshToken

type Client

+ func (c *Client) LogoutURLWithHint(returnTo, idTokenHint string) string

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

v0.4.0

Jul 24, 2026

v0.3.0

Jul 21, 2026

Changes in this version

type Client

+ func (c *Client) Refresh(ctx context.Context, refreshToken string) (*oauth2.Token, error)

v0.2.0

Jul 17, 2026

Changes in this version

+ var ErrManifestRejected = errors.New("cboxid: manifest push rejected")

type Client

+ func (c *Client) Manifest() Manifest

+ func (c *Client) PublishManifest(ctx context.Context) (Summary, error)

type Config

+ Permissions []Permission

+ Roles []Role

+ type Manifest struct

+ Permissions []Permission

+ Roles []Role

+ Version string

+ type Permission struct

+ Description string

+ Key string

+ type Role struct

+ Description string

+ Key string

+ Name string

+ Permissions []string

+ type Summary struct

+ OrphanedPermissions []string

+ OrphanedRoles []string

+ PermissionsDeclared int

+ RolesDeclared int

+ Unchanged bool

v0.1.0

Jul 16, 2026

Changes in this version

+ var ErrAuthentication = errors.New("cboxid: authentication failed")

+ var ErrConfiguration = errors.New("cboxid: configuration error")

+ var ErrInvalidState = errors.New("cboxid: login state did not match")

+ func VerifyWebhook(payload string, signatureHeader string, secret string, toleranceSeconds int) bool

+ type AuthParams struct

+ LoginHint string

+ Prompt string

+ Scopes []string

+ type AuthorizationRequest struct

+ CodeVerifier string

+ Nonce string

+ State string

+ URL string

+ type Callback struct

+ Code string

+ Error string

+ State string

+ type CboxUser struct

+ AccessToken string

+ Claims map[string]any

+ Email string

+ Expiry time.Time

+ ID string

+ IDToken string

+ Name string

+ OrganizationID string

+ RefreshToken string

+ Token *oauth2.Token

+ type Client struct

+ func New(ctx context.Context, cfg Config) (*Client, error)

+ func (c *Client) Authenticate(ctx context.Context, cb Callback, stored Stored) (*CboxUser, error)

+ func (c *Client) CreateAuthorizationRequest(params AuthParams) AuthorizationRequest

+ func (c *Client) Introspect(ctx context.Context, token string) (map[string]any, error)

+ func (c *Client) LogoutURL(returnTo string) string

+ func (c *Client) MachineToken(ctx context.Context, params MachineTokenParams) (string, error)

+ func (c *Client) PollDeviceToken(ctx context.Context, auth *DeviceAuth) (*CboxUser, error)

+ func (c *Client) ProfileURL(returnTo string) string

+ func (c *Client) RequestDeviceAuthorization(ctx context.Context, params DeviceParams) (*DeviceAuth, error)

+ func (c *Client) UserInfo(ctx context.Context, accessToken string) (map[string]any, error)

+ type Config struct

+ AccountPath string

+ ClientID string

+ ClientSecret string

+ HTTPClient *http.Client

+ Issuer string

+ RedirectURI string

+ Scopes []string

+ type DeviceAuth struct

+ DeviceCode string

+ Expiry time.Time

+ Interval int64

+ UserCode string

+ VerificationURI string

+ VerificationURIComplete string

+ type DeviceParams struct

+ Scopes []string

+ type MachineTokenParams struct

+ Resource string

+ Scopes []string

+ type Stored struct

+ CodeVerifier string

+ Nonce string

+ State string