Movatterモバイル変換

[0]ホーム
URL:

oauth2

package
v0.257.0Latest Latest
Warning

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

Go to latest Published: Dec 2, 2025 License:BSD-3-ClauseImports:15Imported by:23

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package oauth2 provides access to the Google OAuth2 API.

For product documentation, see:https://developers.google.com/accounts/docs/OAuth2

Creating a client

Usage example:

import "google.golang.org/api/oauth2/v1"...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, seehttps://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:

oauth2Service, err := oauth2.NewService(ctx, option.WithScopes(oauth2.UserinfoProfileScope))

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

Seehttps://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (// Associate you with your personal info on GooglePlusMeScope = "https://www.googleapis.com/auth/plus.me"// View your email addressUserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"// See your personal info, including any personal info you've made// publicly availableUserinfoProfileScope = "https://www.googleapis.com/auth/userinfo.profile")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentUserinfo *UserinfoService// contains filtered or unexported fields}

funcNewdeprecated

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

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.

funcNewServiceadded inv0.3.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

func (*Service)Tokeninfo

func (s *Service) Tokeninfo() *TokeninfoCall

Tokeninfo: Get token info

typeTokeninfo

type Tokeninfo struct {// AccessType: The access type granted with this token. It can be// offline or online.AccessTypestring `json:"access_type,omitempty"`// Audience: Who is the intended audience for this token. In general the// same as issued_to.Audiencestring `json:"audience,omitempty"`// Email: The email address of the user. Present only if the email scope// is present in the request.Emailstring `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.EmailVerifiedbool `json:"email_verified,omitempty"`// ExpiresIn: The expiry time of the token, as number of seconds left// until expiry.ExpiresInint64 `json:"expires_in,omitempty"`// IssuedAt: The issue time of the token, as number of seconds.IssuedAtint64 `json:"issued_at,omitempty"`// IssuedTo: To whom was the token issued to. In general the same as// audience.IssuedTostring `json:"issued_to,omitempty"`// Issuer: Who issued the token.Issuerstring `json:"issuer,omitempty"`// Nonce: Nonce of the id token.Noncestring `json:"nonce,omitempty"`// Scope: The space separated list of scopes granted to this token.Scopestring `json:"scope,omitempty"`// UserId: The obfuscated user id.UserIdstring `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.VerifiedEmailbool `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:"-"`// NullFields is a list of field names (e.g. "AccessType") 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:"-"`}

func (*Tokeninfo)MarshalJSON

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

typeTokeninfoCall

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

func (*TokeninfoCall)AccessToken

func (c *TokeninfoCall) AccessToken(accessTokenstring) *TokeninfoCall

AccessToken sets the optional parameter "access_token": The oauth2access token

func (*TokeninfoCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*TokeninfoCall)Do

Do executes the "oauth2.tokeninfo" call.Exactly one of *Tokeninfo or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Tokeninfo.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*TokeninfoCall)Fields

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*TokeninfoCall)Header

func (c *TokeninfoCall) Header()http.Header

Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.

func (*TokeninfoCall)IdToken

func (c *TokeninfoCall) IdToken(idTokenstring) *TokeninfoCall

IdToken sets the optional parameter "id_token": The ID token

typeUserinfoGetCall

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

func (*UserinfoGetCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*UserinfoGetCall)Do

Do executes the "oauth2.userinfo.get" call.Exactly one of *Userinfoplus or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Userinfoplus.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*UserinfoGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*UserinfoGetCall)Header

func (c *UserinfoGetCall) Header()http.Header

Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.

func (*UserinfoGetCall)IfNoneMatch

func (c *UserinfoGetCall) IfNoneMatch(entityTagstring) *UserinfoGetCall

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

typeUserinfoService

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

funcNewUserinfoService

func NewUserinfoService(s *Service) *UserinfoService

func (*UserinfoService)Get

Get: Get user info

typeUserinfoV2MeGetCall

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

func (*UserinfoV2MeGetCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*UserinfoV2MeGetCall)Do

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

func (*UserinfoV2MeGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*UserinfoV2MeGetCall)Header

func (c *UserinfoV2MeGetCall) Header()http.Header

Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.

func (*UserinfoV2MeGetCall)IfNoneMatch

func (c *UserinfoV2MeGetCall) IfNoneMatch(entityTagstring) *UserinfoV2MeGetCall

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

typeUserinfoV2MeService

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

funcNewUserinfoV2MeService

func NewUserinfoV2MeService(s *Service) *UserinfoV2MeService

func (*UserinfoV2MeService)Get

Get: Get user info

typeUserinfoV2Service

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

funcNewUserinfoV2Service

func NewUserinfoV2Service(s *Service) *UserinfoV2Service

typeUserinfoplus

type Userinfoplus struct {// Email: The user's email address.Emailstring `json:"email,omitempty"`// FamilyName: The user's last name.FamilyNamestring `json:"family_name,omitempty"`// Gender: The user's gender.Genderstring `json:"gender,omitempty"`// GivenName: The user's first name.GivenNamestring `json:"given_name,omitempty"`// Hd: The hosted domain e.g. example.com if the user is Google apps// user.Hdstring `json:"hd,omitempty"`// Id: The obfuscated ID of the user.Idstring `json:"id,omitempty"`// Link: URL of the profile page.Linkstring `json:"link,omitempty"`// Locale: The user's preferred locale.Localestring `json:"locale,omitempty"`// Name: The user's full name.Namestring `json:"name,omitempty"`// Picture: URL of the user's picture image.Picturestring `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: trueVerifiedEmail *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:"-"`}

func (*Userinfoplus)MarshalJSON

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.
[8]ページ先頭
©2009-2025 Movatter.jp