Documentation
¶
Overview ¶
Package clientcredentials implements the OAuth2.0 "client credentials" token flow, also known as the "two-legged OAuth 2.0".
This should be used when the client is acting on its own behalf or when the client is the resource owner. It may also be used when requesting access to protected resources based on an authorization previously arranged with the authorization server.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// ClientID is the application's ID.
ClientID string
// ClientSecret is the application's secret.
ClientSecret string
// TokenURL is the resource server's token endpoint
// URL. This is a constant specific to each server.
TokenURL string
// Scope specifies optional requested permissions.
Scopes []string
// EndpointParams specifies additional parameters for requests to the token endpoint.
// Password-based authentication (https://tools.ietf.org/html/rfc6749#section-4.3) may
// be implemented by setting EndpointParams to -
// url.Values{
// "grant_type": {"password"},
// "username": {<username>},
// "password": {<password>},
// }
EndpointParams url.Values
// ExpiryDelta determines how man seconds sooner a token should
// expire than the delivered expiration time.
ExpiryDelta int64
// HTTPClientFunc specifies a function specifiying
// the *http.Client used on Token calls to the oauth2
// server. If nil,
HTTPClientFunc ctxclient.Func
}
Config describes a 2-legged OAuth2 flow, with both the client application information and the server's endpoint URLs.
func (*Config) Client ¶
Client returns an HTTP client using the provided token. The token will auto-refresh as necessary. The underlying HTTP transport by requests contexts. The returned client and its Transport should not be modified.
func (*Config) Token ¶
Token refreshes the token by using a new client credentials request. tokens received this way do not include a refresh token. Do not call this function directly unless creating own caching tokensource. Use the tokensource create by Config.TokenSource.
func (*Config) TokenSource ¶
func (c *Config) TokenSource(t *oauth2.Token) oauth2.TokenSource
TokenSource returns a TokenSource that returns t until t expires, automatically refreshing it as necessary using the provided context and the client ID and client secret.
Most users will use Config.Client instead.
Source Files