oauth2

package
v2.3.1-rc.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 23, 2016 License: BSD-3-Clause, Apache-2.0 Imports: 13 Imported by: 0

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/v1"
...
oauth2Service, err := oauth2.New(oauthHttpClient)

Index

Constants

View Source
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.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetCertForOpenIdConnectCall

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

func (*GetCertForOpenIdConnectCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GetCertForOpenIdConnectCall) Do

Do executes the "oauth2.getCertForOpenIdConnect" call.

func (*GetCertForOpenIdConnectCall) Fields

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

func (*GetCertForOpenIdConnectCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GetCertForOpenIdConnectRawCall

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

func (*GetCertForOpenIdConnectRawCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GetCertForOpenIdConnectRawCall) Do

Do executes the "oauth2.getCertForOpenIdConnectRaw" call. Exactly one of *Raw or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Raw.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GetCertForOpenIdConnectRawCall) Fields

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

func (*GetCertForOpenIdConnectRawCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GetRobotJwkCall

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

func (*GetRobotJwkCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GetRobotJwkCall) Do

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

Do executes the "oauth2.getRobotJwk" call. Exactly one of *Jwk or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Jwk.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GetRobotJwkCall) Fields

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

func (*GetRobotJwkCall) IfNoneMatch

func (c *GetRobotJwkCall) IfNoneMatch(entityTag string) *GetRobotJwkCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GetRobotMetadataRawCall

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

func (*GetRobotMetadataRawCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GetRobotMetadataRawCall) Do

func (c *GetRobotMetadataRawCall) Do() (*Raw, error)

Do executes the "oauth2.getRobotMetadataRaw" call. Exactly one of *Raw or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Raw.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GetRobotMetadataRawCall) Fields

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

func (*GetRobotMetadataRawCall) IfNoneMatch

func (c *GetRobotMetadataRawCall) IfNoneMatch(entityTag string) *GetRobotMetadataRawCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GetRobotMetadataX509Call

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

func (*GetRobotMetadataX509Call) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GetRobotMetadataX509Call) Do

Do executes the "oauth2.getRobotMetadataX509" call.

func (*GetRobotMetadataX509Call) Fields

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

func (*GetRobotMetadataX509Call) IfNoneMatch

func (c *GetRobotMetadataX509Call) IfNoneMatch(entityTag string) *GetRobotMetadataX509Call

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type Jwk

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

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Keys") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*Jwk) MarshalJSON

func (s *Jwk) MarshalJSON() ([]byte, error)

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"`

	// ForceSendFields is a list of field names (e.g. "Alg") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*JwkKeys) MarshalJSON

func (s *JwkKeys) MarshalJSON() ([]byte, error)

type Raw

type Raw struct {
	Keyvalues []*RawKeyvalues `json:"keyvalues,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Keyvalues") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*Raw) MarshalJSON

func (s *Raw) MarshalJSON() ([]byte, error)

type RawKeyvalues

type RawKeyvalues struct {
	Algorithm string `json:"algorithm,omitempty"`

	Exponent string `json:"exponent,omitempty"`

	Keyid string `json:"keyid,omitempty"`

	Modulus string `json:"modulus,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Algorithm") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*RawKeyvalues) MarshalJSON

func (s *RawKeyvalues) MarshalJSON() ([]byte, error)

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) GetCertForOpenIdConnectRaw

func (s *Service) GetCertForOpenIdConnectRaw() *GetCertForOpenIdConnectRawCall

GetCertForOpenIdConnectRaw:

func (*Service) GetRobotJwk

func (s *Service) GetRobotJwk(robotEmail string) *GetRobotJwkCall

GetRobotJwk:

func (*Service) GetRobotMetadataRaw

func (s *Service) GetRobotMetadataRaw(robotEmail string) *GetRobotMetadataRawCall

GetRobotMetadataRaw:

func (*Service) GetRobotMetadataX509

func (s *Service) GetRobotMetadataX509(robotEmail string) *GetRobotMetadataX509Call

GetRobotMetadataX509:

func (*Service) Tokeninfo

func (s *Service) Tokeninfo() *TokeninfoCall

Tokeninfo: Get token info

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"`

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

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

	// IssuedAt: The issue time of the token, as number of seconds.
	IssuedAt int64 `json:"issued_at,omitempty"`

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

	// Issuer: Who issued the token.
	Issuer string `json:"issuer,omitempty"`

	// Nonce: Nonce of the id token.
	Nonce string `json:"nonce,omitempty"`

	// Scope: The space separated list of scopes granted to this token.
	Scope string `json:"scope,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"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AccessType") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*Tokeninfo) MarshalJSON

func (s *Tokeninfo) MarshalJSON() ([]byte, error)

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": The oauth2 access token

func (*TokeninfoCall) Context

func (c *TokeninfoCall) Context(ctx context.Context) *TokeninfoCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TokeninfoCall) Do

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

Do executes the "oauth2.tokeninfo" call. Exactly one of *Tokeninfo or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Tokeninfo.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

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": The ID token

type UserinfoGetCall

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

func (*UserinfoGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserinfoGetCall) Do

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

Do executes the "oauth2.userinfo.get" call. Exactly one of *Userinfoplus or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Userinfoplus.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserinfoGetCall) Fields

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

func (*UserinfoGetCall) IfNoneMatch

func (c *UserinfoGetCall) IfNoneMatch(entityTag string) *UserinfoGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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: Get user info

type UserinfoV2MeGetCall

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

func (*UserinfoV2MeGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserinfoV2MeGetCall) Do

Do executes the "oauth2.userinfo.v2.me.get" call. Exactly one of *Userinfoplus or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Userinfoplus.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserinfoV2MeGetCall) Fields

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

func (*UserinfoV2MeGetCall) IfNoneMatch

func (c *UserinfoV2MeGetCall) IfNoneMatch(entityTag string) *UserinfoV2MeGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type UserinfoV2MeService

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

func NewUserinfoV2MeService

func NewUserinfoV2MeService(s *Service) *UserinfoV2MeService

func (*UserinfoV2MeService) Get

Get: Get user info

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"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Email") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*Userinfoplus) MarshalJSON

func (s *Userinfoplus) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

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