2020-07-08 06:30:25 -04:00
// Copyright 2020 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package oauth2 provides access to the Google OAuth2 API.
//
2020-10-01 17:06:15 -04:00
// For product documentation, see: https://developers.google.com/identity/protocols/oauth2/
2020-07-08 06:30:25 -04:00
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/oauth2/v2"
// ...
// ctx := context.Background()
// oauth2Service, err := oauth2.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for authentication.
//
// For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// Other authentication options
//
// By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
//
2020-10-01 17:06:15 -04:00
// oauth2Service, err := oauth2.NewService(ctx, option.WithScopes(oauth2.OpenIDScope))
2020-07-08 06:30:25 -04:00
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// oauth2Service, err := oauth2.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// oauth2Service, err := oauth2.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package oauth2 // import "google.golang.org/api/oauth2/v2"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes . NewBuffer
var _ = strconv . Itoa
var _ = fmt . Sprintf
var _ = json . NewDecoder
var _ = io . Copy
var _ = url . Parse
var _ = gensupport . MarshalJSON
var _ = googleapi . Version
var _ = errors . New
var _ = strings . Replace
var _ = context . Canceled
var _ = internaloption . WithDefaultEndpoint
const apiId = "oauth2:v2"
const apiName = "oauth2"
const apiVersion = "v2"
const basePath = "https://www.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View your email address
UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
// See your personal info, including any personal info you've made
// publicly available
UserinfoProfileScope = "https://www.googleapis.com/auth/userinfo.profile"
2020-10-01 17:06:15 -04:00
// Associate you with your personal info on Google
OpenIDScope = "openid"
2020-07-08 06:30:25 -04:00
)
// NewService creates a new Service.
func NewService ( ctx context . Context , opts ... option . ClientOption ) ( * Service , error ) {
scopesOption := option . WithScopes (
"https://www.googleapis.com/auth/userinfo.email" ,
"https://www.googleapis.com/auth/userinfo.profile" ,
2020-10-01 17:06:15 -04:00
"openid" ,
2020-07-08 06:30:25 -04:00
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append ( [ ] option . ClientOption { scopesOption } , opts ... )
opts = append ( opts , internaloption . WithDefaultEndpoint ( basePath ) )
client , endpoint , err := htransport . NewClient ( ctx , opts ... )
if err != nil {
return nil , err
}
s , err := New ( client )
if err != nil {
return nil , err
}
if endpoint != "" {
s . BasePath = endpoint
}
return s , nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New ( client * http . Client ) ( * Service , error ) {
if client == nil {
return nil , errors . New ( "client is nil" )
}
s := & Service { client : client , BasePath : basePath }
s . Userinfo = NewUserinfoService ( s )
return s , nil
}
type Service struct {
client * http . Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Userinfo * UserinfoService
}
func ( s * Service ) userAgent ( ) string {
if s . UserAgent == "" {
return googleapi . UserAgent
}
return googleapi . UserAgent + " " + s . UserAgent
}
func NewUserinfoService ( s * Service ) * UserinfoService {
rs := & UserinfoService { s : s }
rs . V2 = NewUserinfoV2Service ( s )
return rs
}
type UserinfoService struct {
s * Service
V2 * UserinfoV2Service
}
func NewUserinfoV2Service ( s * Service ) * UserinfoV2Service {
rs := & UserinfoV2Service { s : s }
rs . Me = NewUserinfoV2MeService ( s )
return rs
}
type UserinfoV2Service struct {
s * Service
Me * UserinfoV2MeService
}
func NewUserinfoV2MeService ( s * Service ) * UserinfoV2MeService {
rs := & UserinfoV2MeService { s : s }
return rs
}
type UserinfoV2MeService struct {
s * Service
}
type Tokeninfo struct {
// 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" `
// 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:"-" `
2020-10-01 17:06:15 -04:00
// ForceSendFields is a list of field names (e.g. "Audience") to
2020-07-08 06:30:25 -04:00
// 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:"-" `
2020-10-01 17:06:15 -04:00
// NullFields is a list of field names (e.g. "Audience") to include in
2020-07-08 06:30:25 -04:00
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields [ ] string ` json:"-" `
}
func ( s * Tokeninfo ) MarshalJSON ( ) ( [ ] byte , error ) {
type NoMethod Tokeninfo
raw := NoMethod ( * s )
return gensupport . MarshalJSON ( raw , s . ForceSendFields , s . NullFields )
}
2020-10-01 17:06:15 -04:00
type Userinfo struct {
2020-07-08 06:30:25 -04:00
// 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:"-" `
// NullFields is a list of field names (e.g. "Email") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields [ ] string ` json:"-" `
}
2020-10-01 17:06:15 -04:00
func ( s * Userinfo ) MarshalJSON ( ) ( [ ] byte , error ) {
type NoMethod Userinfo
2020-07-08 06:30:25 -04:00
raw := NoMethod ( * s )
return gensupport . MarshalJSON ( raw , s . ForceSendFields , s . NullFields )
}
// method id "oauth2.tokeninfo":
type TokeninfoCall struct {
s * Service
urlParams_ gensupport . URLParams
ctx_ context . Context
header_ http . Header
}
// Tokeninfo:
func ( s * Service ) Tokeninfo ( ) * TokeninfoCall {
c := & TokeninfoCall { s : s , urlParams_ : make ( gensupport . URLParams ) }
return c
}
// AccessToken sets the optional parameter "access_token":
func ( c * TokeninfoCall ) AccessToken ( accessToken string ) * TokeninfoCall {
c . urlParams_ . Set ( "access_token" , accessToken )
return c
}
// IdToken sets the optional parameter "id_token":
func ( c * TokeninfoCall ) IdToken ( idToken string ) * TokeninfoCall {
c . urlParams_ . Set ( "id_token" , idToken )
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func ( c * TokeninfoCall ) Fields ( s ... googleapi . Field ) * TokeninfoCall {
c . urlParams_ . Set ( "fields" , googleapi . CombineFields ( s ) )
return c
}
// 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 ( c * TokeninfoCall ) Context ( ctx context . Context ) * TokeninfoCall {
c . ctx_ = ctx
return c
}
// Header returns an http.Header that can be modified by the caller to
// add HTTP headers to the request.
func ( c * TokeninfoCall ) Header ( ) http . Header {
if c . header_ == nil {
c . header_ = make ( http . Header )
}
return c . header_
}
func ( c * TokeninfoCall ) doRequest ( alt string ) ( * http . Response , error ) {
reqHeaders := make ( http . Header )
2020-10-01 17:06:15 -04:00
reqHeaders . Set ( "x-goog-api-client" , "gl-go/" + gensupport . GoVersion ( ) + " gdcl/20200811" )
2020-07-08 06:30:25 -04:00
for k , v := range c . header_ {
reqHeaders [ k ] = v
}
reqHeaders . Set ( "User-Agent" , c . s . userAgent ( ) )
var body io . Reader = nil
c . urlParams_ . Set ( "alt" , alt )
c . urlParams_ . Set ( "prettyPrint" , "false" )
urls := googleapi . ResolveRelative ( c . s . BasePath , "oauth2/v2/tokeninfo" )
urls += "?" + c . urlParams_ . Encode ( )
req , err := http . NewRequest ( "POST" , urls , body )
if err != nil {
return nil , err
}
req . Header = reqHeaders
return gensupport . SendRequest ( c . ctx_ , c . s . client , req )
}
// 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 ( c * TokeninfoCall ) Do ( opts ... googleapi . CallOption ) ( * Tokeninfo , error ) {
gensupport . SetOptions ( c . urlParams_ , opts ... )
res , err := c . doRequest ( "json" )
if res != nil && res . StatusCode == http . StatusNotModified {
if res . Body != nil {
res . Body . Close ( )
}
return nil , & googleapi . Error {
Code : res . StatusCode ,
Header : res . Header ,
}
}
if err != nil {
return nil , err
}
defer googleapi . CloseBody ( res )
if err := googleapi . CheckResponse ( res ) ; err != nil {
return nil , err
}
ret := & Tokeninfo {
ServerResponse : googleapi . ServerResponse {
Header : res . Header ,
HTTPStatusCode : res . StatusCode ,
} ,
}
target := & ret
if err := gensupport . DecodeResponse ( target , res ) ; err != nil {
return nil , err
}
return ret , nil
// {
// "httpMethod": "POST",
// "id": "oauth2.tokeninfo",
// "parameters": {
// "access_token": {
// "location": "query",
// "type": "string"
// },
// "id_token": {
// "location": "query",
// "type": "string"
// }
// },
// "path": "oauth2/v2/tokeninfo",
// "response": {
// "$ref": "Tokeninfo"
// }
// }
}
// method id "oauth2.userinfo.get":
type UserinfoGetCall struct {
s * Service
urlParams_ gensupport . URLParams
ifNoneMatch_ string
ctx_ context . Context
header_ http . Header
}
// Get:
func ( r * UserinfoService ) Get ( ) * UserinfoGetCall {
c := & UserinfoGetCall { s : r . s , urlParams_ : make ( gensupport . URLParams ) }
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func ( c * UserinfoGetCall ) Fields ( s ... googleapi . Field ) * UserinfoGetCall {
c . urlParams_ . Set ( "fields" , googleapi . CombineFields ( s ) )
return c
}
// 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.
func ( c * UserinfoGetCall ) IfNoneMatch ( entityTag string ) * UserinfoGetCall {
c . ifNoneMatch_ = entityTag
return c
}
// 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 ( c * UserinfoGetCall ) Context ( ctx context . Context ) * UserinfoGetCall {
c . ctx_ = ctx
return c
}
// Header returns an http.Header that can be modified by the caller to
// add HTTP headers to the request.
func ( c * UserinfoGetCall ) Header ( ) http . Header {
if c . header_ == nil {
c . header_ = make ( http . Header )
}
return c . header_
}
func ( c * UserinfoGetCall ) doRequest ( alt string ) ( * http . Response , error ) {
reqHeaders := make ( http . Header )
2020-10-01 17:06:15 -04:00
reqHeaders . Set ( "x-goog-api-client" , "gl-go/" + gensupport . GoVersion ( ) + " gdcl/20200811" )
2020-07-08 06:30:25 -04:00
for k , v := range c . header_ {
reqHeaders [ k ] = v
}
reqHeaders . Set ( "User-Agent" , c . s . userAgent ( ) )
if c . ifNoneMatch_ != "" {
reqHeaders . Set ( "If-None-Match" , c . ifNoneMatch_ )
}
var body io . Reader = nil
c . urlParams_ . Set ( "alt" , alt )
c . urlParams_ . Set ( "prettyPrint" , "false" )
urls := googleapi . ResolveRelative ( c . s . BasePath , "oauth2/v2/userinfo" )
urls += "?" + c . urlParams_ . Encode ( )
req , err := http . NewRequest ( "GET" , urls , body )
if err != nil {
return nil , err
}
req . Header = reqHeaders
return gensupport . SendRequest ( c . ctx_ , c . s . client , req )
}
// Do executes the "oauth2.userinfo.get" call.
2020-10-01 17:06:15 -04:00
// Exactly one of *Userinfo or error will be non-nil. Any non-2xx status
// code is an error. Response headers are in either
// *Userinfo.ServerResponse.Header or (if a response was returned at
2020-07-08 06:30:25 -04:00
// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
// to check whether the returned error was because
// http.StatusNotModified was returned.
2020-10-01 17:06:15 -04:00
func ( c * UserinfoGetCall ) Do ( opts ... googleapi . CallOption ) ( * Userinfo , error ) {
2020-07-08 06:30:25 -04:00
gensupport . SetOptions ( c . urlParams_ , opts ... )
res , err := c . doRequest ( "json" )
if res != nil && res . StatusCode == http . StatusNotModified {
if res . Body != nil {
res . Body . Close ( )
}
return nil , & googleapi . Error {
Code : res . StatusCode ,
Header : res . Header ,
}
}
if err != nil {
return nil , err
}
defer googleapi . CloseBody ( res )
if err := googleapi . CheckResponse ( res ) ; err != nil {
return nil , err
}
2020-10-01 17:06:15 -04:00
ret := & Userinfo {
2020-07-08 06:30:25 -04:00
ServerResponse : googleapi . ServerResponse {
Header : res . Header ,
HTTPStatusCode : res . StatusCode ,
} ,
}
target := & ret
if err := gensupport . DecodeResponse ( target , res ) ; err != nil {
return nil , err
}
return ret , nil
// {
// "httpMethod": "GET",
// "id": "oauth2.userinfo.get",
// "path": "oauth2/v2/userinfo",
// "response": {
2020-10-01 17:06:15 -04:00
// "$ref": "Userinfo"
2020-07-08 06:30:25 -04:00
// },
// "scopes": [
2020-10-01 17:06:15 -04:00
// "openid",
2020-07-08 06:30:25 -04:00
// "https://www.googleapis.com/auth/userinfo.email",
// "https://www.googleapis.com/auth/userinfo.profile"
// ]
// }
}
// method id "oauth2.userinfo.v2.me.get":
type UserinfoV2MeGetCall struct {
s * Service
urlParams_ gensupport . URLParams
ifNoneMatch_ string
ctx_ context . Context
header_ http . Header
}
// Get:
func ( r * UserinfoV2MeService ) Get ( ) * UserinfoV2MeGetCall {
c := & UserinfoV2MeGetCall { s : r . s , urlParams_ : make ( gensupport . URLParams ) }
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func ( c * UserinfoV2MeGetCall ) Fields ( s ... googleapi . Field ) * UserinfoV2MeGetCall {
c . urlParams_ . Set ( "fields" , googleapi . CombineFields ( s ) )
return c
}
// 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.
func ( c * UserinfoV2MeGetCall ) IfNoneMatch ( entityTag string ) * UserinfoV2MeGetCall {
c . ifNoneMatch_ = entityTag
return c
}
// 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 ( c * UserinfoV2MeGetCall ) Context ( ctx context . Context ) * UserinfoV2MeGetCall {
c . ctx_ = ctx
return c
}
// Header returns an http.Header that can be modified by the caller to
// add HTTP headers to the request.
func ( c * UserinfoV2MeGetCall ) Header ( ) http . Header {
if c . header_ == nil {
c . header_ = make ( http . Header )
}
return c . header_
}
func ( c * UserinfoV2MeGetCall ) doRequest ( alt string ) ( * http . Response , error ) {
reqHeaders := make ( http . Header )
2020-10-01 17:06:15 -04:00
reqHeaders . Set ( "x-goog-api-client" , "gl-go/" + gensupport . GoVersion ( ) + " gdcl/20200811" )
2020-07-08 06:30:25 -04:00
for k , v := range c . header_ {
reqHeaders [ k ] = v
}
reqHeaders . Set ( "User-Agent" , c . s . userAgent ( ) )
if c . ifNoneMatch_ != "" {
reqHeaders . Set ( "If-None-Match" , c . ifNoneMatch_ )
}
var body io . Reader = nil
c . urlParams_ . Set ( "alt" , alt )
c . urlParams_ . Set ( "prettyPrint" , "false" )
urls := googleapi . ResolveRelative ( c . s . BasePath , "userinfo/v2/me" )
urls += "?" + c . urlParams_ . Encode ( )
req , err := http . NewRequest ( "GET" , urls , body )
if err != nil {
return nil , err
}
req . Header = reqHeaders
return gensupport . SendRequest ( c . ctx_ , c . s . client , req )
}
// Do executes the "oauth2.userinfo.v2.me.get" call.
2020-10-01 17:06:15 -04:00
// Exactly one of *Userinfo or error will be non-nil. Any non-2xx status
// code is an error. Response headers are in either
// *Userinfo.ServerResponse.Header or (if a response was returned at
2020-07-08 06:30:25 -04:00
// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
// to check whether the returned error was because
// http.StatusNotModified was returned.
2020-10-01 17:06:15 -04:00
func ( c * UserinfoV2MeGetCall ) Do ( opts ... googleapi . CallOption ) ( * Userinfo , error ) {
2020-07-08 06:30:25 -04:00
gensupport . SetOptions ( c . urlParams_ , opts ... )
res , err := c . doRequest ( "json" )
if res != nil && res . StatusCode == http . StatusNotModified {
if res . Body != nil {
res . Body . Close ( )
}
return nil , & googleapi . Error {
Code : res . StatusCode ,
Header : res . Header ,
}
}
if err != nil {
return nil , err
}
defer googleapi . CloseBody ( res )
if err := googleapi . CheckResponse ( res ) ; err != nil {
return nil , err
}
2020-10-01 17:06:15 -04:00
ret := & Userinfo {
2020-07-08 06:30:25 -04:00
ServerResponse : googleapi . ServerResponse {
Header : res . Header ,
HTTPStatusCode : res . StatusCode ,
} ,
}
target := & ret
if err := gensupport . DecodeResponse ( target , res ) ; err != nil {
return nil , err
}
return ret , nil
// {
// "httpMethod": "GET",
// "id": "oauth2.userinfo.v2.me.get",
// "path": "userinfo/v2/me",
// "response": {
2020-10-01 17:06:15 -04:00
// "$ref": "Userinfo"
2020-07-08 06:30:25 -04:00
// },
// "scopes": [
2020-10-01 17:06:15 -04:00
// "openid",
2020-07-08 06:30:25 -04:00
// "https://www.googleapis.com/auth/userinfo.email",
// "https://www.googleapis.com/auth/userinfo.profile"
// ]
// }
}