oauth2

Documentation

Overview

Package oauth2 provides access to the Google OAuth2 API.

See https://developers.google.com/accounts/docs/OAuth2

Usage example:

import "google.golang.org/api/oauth2/v2"
...
oauth2Service, err := oauth2.New(oauthHttpClient)

Index

• Constants
• type GetCertForOpenIdConnectCall
  • func (c *GetCertForOpenIdConnectCall) Do() (*Jwk, error)
  • func (c *GetCertForOpenIdConnectCall) Fields(s ...googleapi.Field) *GetCertForOpenIdConnectCall
• type Jwk
• type JwkKeys
• type Service
  • func New(client *http.Client) (*Service, error)
  • func (s *Service) GetCertForOpenIdConnect() *GetCertForOpenIdConnectCall
  • func (s *Service) Tokeninfo() *TokeninfoCall
• type Tokeninfo
• type TokeninfoCall
  • func (c *TokeninfoCall) AccessToken(accessToken string) *TokeninfoCall
  • func (c *TokeninfoCall) Do() (*Tokeninfo, error)
  • func (c *TokeninfoCall) Fields(s ...googleapi.Field) *TokeninfoCall
  • func (c *TokeninfoCall) IdToken(idToken string) *TokeninfoCall
  • func (c *TokeninfoCall) TokenHandle(tokenHandle string) *TokeninfoCall
• type UserinfoGetCall
  • func (c *UserinfoGetCall) Do() (*Userinfoplus, error)
  • func (c *UserinfoGetCall) Fields(s ...googleapi.Field) *UserinfoGetCall
• type UserinfoService
  • func NewUserinfoService(s *Service) *UserinfoService
  • func (r *UserinfoService) Get() *UserinfoGetCall
• type UserinfoV2MeGetCall
  • func (c *UserinfoV2MeGetCall) Do() (*Userinfoplus, error)
  • func (c *UserinfoV2MeGetCall) Fields(s ...googleapi.Field) *UserinfoV2MeGetCall
• type UserinfoV2MeService
  • func NewUserinfoV2MeService(s *Service) *UserinfoV2MeService
  • func (r *UserinfoV2MeService) Get() *UserinfoV2MeGetCall
• type UserinfoV2Service
  • func NewUserinfoV2Service(s *Service) *UserinfoV2Service
• type Userinfoplus

Constants

const (
	// Know your basic profile info and list of people in your circles.
	PlusLoginScope = "https://www.googleapis.com/auth/plus.login"

	// Know who you are on Google
	PlusMeScope = "https://www.googleapis.com/auth/plus.me"

	// View your email address
	UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"

	// View your basic profile info
	UserinfoProfileScope = "https://www.googleapis.com/auth/userinfo.profile"
)

OAuth2 scopes used by this API.

Types

type GetCertForOpenIdConnectCall

type GetCertForOpenIdConnectCall struct {
	// contains filtered or unexported fields
}

func (*GetCertForOpenIdConnectCall) Do

func (c *GetCertForOpenIdConnectCall) Do() (*Jwk, error)

func (*GetCertForOpenIdConnectCall) Fields

func (c *GetCertForOpenIdConnectCall) Fields(s ...googleapi.Field) *GetCertForOpenIdConnectCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type Jwk

type Jwk struct {
	Keys []*JwkKeys `json:"keys,omitempty"`
}

type JwkKeys

type JwkKeys struct {
	Alg string `json:"alg,omitempty"`

	E string `json:"e,omitempty"`

	Kid string `json:"kid,omitempty"`

	Kty string `json:"kty,omitempty"`

	N string `json:"n,omitempty"`

	Use string `json:"use,omitempty"`
}

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Userinfo *UserinfoService
	// contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)

func (*Service) GetCertForOpenIdConnect

func (s *Service) GetCertForOpenIdConnect() *GetCertForOpenIdConnectCall

GetCertForOpenIdConnect:

func (*Service) Tokeninfo

func (s *Service) Tokeninfo() *TokeninfoCall

Tokeninfo:

type Tokeninfo

type Tokeninfo struct {
	// AccessType: The access type granted with this token. It can be
	// offline or online.
	AccessType string `json:"access_type,omitempty"`

	// Audience: Who is the intended audience for this token. In general the
	// same as issued_to.
	Audience string `json:"audience,omitempty"`

	// Email: The email address of the user. Present only if the email scope
	// is present in the request.
	Email string `json:"email,omitempty"`

	// ExpiresIn: The expiry time of the token, as number of seconds left
	// until expiry.
	ExpiresIn int64 `json:"expires_in,omitempty"`

	// IssuedTo: To whom was the token issued to. In general the same as
	// audience.
	IssuedTo string `json:"issued_to,omitempty"`

	// Scope: The space separated list of scopes granted to this token.
	Scope string `json:"scope,omitempty"`

	// TokenHandle: The token handle associated with this token.
	TokenHandle string `json:"token_handle,omitempty"`

	// UserId: The obfuscated user id.
	UserId string `json:"user_id,omitempty"`

	// VerifiedEmail: Boolean flag which is true if the email address is
	// verified. Present only if the email scope is present in the request.
	VerifiedEmail *bool `json:"verified_email,omitempty"`
}

type TokeninfoCall

type TokeninfoCall struct {
	// contains filtered or unexported fields
}

func (*TokeninfoCall) AccessToken

func (c *TokeninfoCall) AccessToken(accessToken string) *TokeninfoCall

AccessToken sets the optional parameter "access_token":

func (*TokeninfoCall) Do

func (c *TokeninfoCall) Do() (*Tokeninfo, error)

func (*TokeninfoCall) Fields

func (c *TokeninfoCall) Fields(s ...googleapi.Field) *TokeninfoCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TokeninfoCall) IdToken

func (c *TokeninfoCall) IdToken(idToken string) *TokeninfoCall

IdToken sets the optional parameter "id_token":

func (*TokeninfoCall) TokenHandle

func (c *TokeninfoCall) TokenHandle(tokenHandle string) *TokeninfoCall

TokenHandle sets the optional parameter "token_handle":

type UserinfoGetCall

type UserinfoGetCall struct {
	// contains filtered or unexported fields
}

func (*UserinfoGetCall) Do

func (c *UserinfoGetCall) Do() (*Userinfoplus, error)

func (*UserinfoGetCall) Fields

func (c *UserinfoGetCall) Fields(s ...googleapi.Field) *UserinfoGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type UserinfoService

type UserinfoService struct {
	V2 *UserinfoV2Service
	// contains filtered or unexported fields
}

func NewUserinfoService

func NewUserinfoService(s *Service) *UserinfoService

func (*UserinfoService) Get

func (r *UserinfoService) Get() *UserinfoGetCall

Get:

type UserinfoV2MeGetCall

type UserinfoV2MeGetCall struct {
	// contains filtered or unexported fields
}

func (*UserinfoV2MeGetCall) Do

func (c *UserinfoV2MeGetCall) Do() (*Userinfoplus, error)

func (*UserinfoV2MeGetCall) Fields

func (c *UserinfoV2MeGetCall) Fields(s ...googleapi.Field) *UserinfoV2MeGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type UserinfoV2MeService

type UserinfoV2MeService struct {
	// contains filtered or unexported fields
}

func NewUserinfoV2MeService

func NewUserinfoV2MeService(s *Service) *UserinfoV2MeService

func (*UserinfoV2MeService) Get

func (r *UserinfoV2MeService) Get() *UserinfoV2MeGetCall

Get:

type UserinfoV2Service

type UserinfoV2Service struct {
	Me *UserinfoV2MeService
	// contains filtered or unexported fields
}

func NewUserinfoV2Service

func NewUserinfoV2Service(s *Service) *UserinfoV2Service

type Userinfoplus

type Userinfoplus struct {
	// Email: The user's email address.
	Email string `json:"email,omitempty"`

	// FamilyName: The user's last name.
	FamilyName string `json:"family_name,omitempty"`

	// Gender: The user's gender.
	Gender string `json:"gender,omitempty"`

	// GivenName: The user's first name.
	GivenName string `json:"given_name,omitempty"`

	// Hd: The hosted domain e.g. example.com if the user is Google apps
	// user.
	Hd string `json:"hd,omitempty"`

	// Id: The obfuscated ID of the user.
	Id string `json:"id,omitempty"`

	// Link: URL of the profile page.
	Link string `json:"link,omitempty"`

	// Locale: The user's preferred locale.
	Locale string `json:"locale,omitempty"`

	// Name: The user's full name.
	Name string `json:"name,omitempty"`

	// Picture: URL of the user's picture image.
	Picture string `json:"picture,omitempty"`

	// VerifiedEmail: Boolean flag which is true if the email address is
	// verified. Always verified because we only return the user's primary
	// email address.
	//
	// Default: true
	VerifiedEmail *bool `json:"verified_email,omitempty"`
}