oauth

Documentation

Index

• type Client
• type Config
  • func OAuth(server string, client *Client) *Config
  • func OAuthWithCache(server string, client *Client, cache cache.Cache) *Config
  • func (o *Config) AuthCodeURL(state string, opts ...oauth2.AuthCodeOption) string
  • func (o *Config) Exchange(code string) (*oauth2.Token, error)
  • func (o *Config) ExchangeAppKeyForToken(appID, accessKey string) (*oauth2.Token, error)
  • func (o *Config) ExchangeGatewayKeyForToken(gatewayID, gatewayKey string) (*oauth2.Token, error)
  • func (o *Config) PasswordCredentialsToken(username, password string) (*oauth2.Token, error)
  • func (o *Config) TokenSource(token *oauth2.Token) oauth2.TokenSource
• type OAuthError
  • func (e *OAuthError) Error() string

Types

type Client

type Client struct {
	ID           string
	Secret       string
	RedirectURL  string
	ExtraHeaders map[string]string
}

Client represents a client for the OAuth 2.0 flow

type Config

type Config struct {
	Server string
	Client *Client
	// contains filtered or unexported fields
}

func OAuth

func OAuth(server string, client *Client) *Config

OAuth creates a new 3-legged OAuth client

func OAuthWithCache

func OAuthWithCache(server string, client *Client, cache cache.Cache) *Config

OAuth creates a new 3-legged OAuth client that uses a cache to cache token exchanges

func (*Config) AuthCodeURL

func (o *Config) AuthCodeURL(state string, opts ...oauth2.AuthCodeOption) string

AuthCodeURL returns a URL to OAuth 2.0 provider's consent page that asks for permissions for the required scopes explicitly.

func (*Config) Exchange

func (o *Config) Exchange(code string) (*oauth2.Token, error)

Exchange exchanges an OAuth 2.0 Authorization Code for an oauth2.Token

func (*Config) ExchangeAppKeyForToken

func (o *Config) ExchangeAppKeyForToken(appID, accessKey string) (*oauth2.Token, error)

ExchangeAppKeyForToken exchanges an application Access Key for an equivalent

func (*Config) ExchangeGatewayKeyForToken

func (o *Config) ExchangeGatewayKeyForToken(gatewayID, gatewayKey string) (*oauth2.Token, error)

ExchangeGatewayKeyForToken exchanges an application Access Key for an equivalent

func (*Config) PasswordCredentialsToken

func (o *Config) PasswordCredentialsToken(username, password string) (*oauth2.Token, error)

PasswordCredentialsToken gets an oauth2.Token from username and password

func (*Config) TokenSource

func (o *Config) TokenSource(token *oauth2.Token) oauth2.TokenSource

TokenSource creates oauth2.TokenSource from an oauht2.Token

type OAuthError

type OAuthError struct {
	Code        int    `json:"code"`
	Description string `json:"description"`
}

func (*OAuthError) Error

func (e *OAuthError) Error() string