oauth

package

Go to main page

Versions in this module

v1

v1.4.3

Mar 4, 2026

v1.4.2

Mar 4, 2026

Changes in this version

+ const OAuthProtectedResourcePath

type OAuthMetadata

+ func SynthesizeMetadata(issuerURL string) *OAuthMetadata

+ type ProtectedResourceMetadata struct

+ AuthorizationServers []string

+ BearerMethodsSupported []string

+ Resource string

+ ResourceName string

+ ScopesSupported []string

v1.4.1

Mar 3, 2026

Changes in this version

+ var ErrInvalidToken = errors.New("Invalid token")

+ type OAuth struct

+ ClientID string

+ ClientSecret string

+ Endpoint string

+ TokenURL string

+ func NewConfig(cfg *oauth2.Config) (*OAuth, error)

+ func NewToken(orig *oauth2.Token) (*OAuth, error)

+ func (o *OAuth) Valid() bool

type OAuthCredentials

+ RedirectURI string

v1.4.0

Mar 2, 2026

Changes in this version

+ const OAuthWellKnownPath

+ const OIDCWellKnownPath

+ type DevicePromptFunc func(userCode, verificationURI string) error

+ type IntrospectionResponse struct

+ Active bool

+ Audience []string

+ ClientID string

+ Expiry time.Time

+ IssuedAt time.Time

+ Issuer string

+ JWTID string

+ NotBefore time.Time

+ Scope string

+ Subject string

+ TokenType string

+ Username string

+ func (r *IntrospectionResponse) UnmarshalJSON(data []byte) error

+ type OAuthCredentials struct

+ ClientID string

+ ClientSecret string

+ Metadata *OAuthMetadata

+ OnRefresh func(*OAuthCredentials) error

+ TokenURL string

+ func AuthorizeWithBrowser(ctx context.Context, creds *OAuthCredentials, listener net.Listener, ...) (*OAuthCredentials, error)

+ func AuthorizeWithCode(ctx context.Context, creds *OAuthCredentials, prompt PromptFunc, ...) (*OAuthCredentials, error)

+ func AuthorizeWithCredentials(ctx context.Context, creds *OAuthCredentials, scopes ...string) (*OAuthCredentials, error)

+ func AuthorizeWithDevice(ctx context.Context, creds *OAuthCredentials, prompt DevicePromptFunc, ...) (*OAuthCredentials, error)

+ func Register(ctx context.Context, metadata *OAuthMetadata, clientName string, ...) (*OAuthCredentials, error)

+ func (creds *OAuthCredentials) Introspect(ctx context.Context) (*IntrospectionResponse, error)

+ func (creds *OAuthCredentials) Refresh(ctx context.Context) error

+ func (creds *OAuthCredentials) Revoke(ctx context.Context) error

+ func (creds *OAuthCredentials) Valid() bool

+ type OAuthFlow string

+ const OAuthFlowAuthorizationCode

+ const OAuthFlowClientCredentials

+ const OAuthFlowDeviceCode

+ const OAuthFlowRefreshToken

+ type OAuthMetadata struct

+ AuthorizationEndpoint string

+ CodeChallengeMethodsSupported []string

+ DeviceAuthorizationEndpoint string

+ GrantTypesSupported []string

+ IntrospectionEndpoint string

+ Issuer string

+ JwksURI string

+ RegistrationEndpoint string

+ ResponseModesSupported []string

+ ResponseTypesSupported []string

+ RevocationEndpoint string

+ ScopesSupported []string

+ TokenEndpoint string

+ TokenEndpointAuthMethodsSupported []string

+ func Discover(ctx context.Context, endpoint string) (*OAuthMetadata, error)

+ func (m *OAuthMetadata) OAuthEndpoint() oauth2.Endpoint

+ func (m *OAuthMetadata) SupportsDeviceFlow() bool

+ func (m *OAuthMetadata) SupportsFlow(flow OAuthFlow) error

+ func (m *OAuthMetadata) SupportsGrantType(flow OAuthFlow) bool

+ func (m *OAuthMetadata) SupportsIntrospection() bool

+ func (m *OAuthMetadata) SupportsPKCE() bool

+ func (m *OAuthMetadata) SupportsRegistration() bool

+ func (m *OAuthMetadata) SupportsRevocation() bool

+ func (m *OAuthMetadata) SupportsS256() bool

+ func (m *OAuthMetadata) ValidateScopes(scopes ...string) error

+ type OpenFunc func(url string) error

+ type PromptFunc func(authURL string) (code string, err error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL