oauth2 - ActiveState ActiveGo 1.8
...

Package oauth2

import "google.golang.org/api/oauth2/v2"
Overview
Index

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) Context(ctx context.Context) *GetCertForOpenIdConnectCall
    func (c *GetCertForOpenIdConnectCall) Do(opts ...googleapi.CallOption) (*Jwk, error)
    func (c *GetCertForOpenIdConnectCall) Fields(s ...googleapi.Field) *GetCertForOpenIdConnectCall
    func (c *GetCertForOpenIdConnectCall) Header() http.Header
    func (c *GetCertForOpenIdConnectCall) IfNoneMatch(entityTag string) *GetCertForOpenIdConnectCall
type Jwk
    func (s *Jwk) MarshalJSON() ([]byte, error)
type JwkKeys
    func (s *JwkKeys) MarshalJSON() ([]byte, error)
type Service
    func New(client *http.Client) (*Service, error)
    func (s *Service) GetCertForOpenIdConnect() *GetCertForOpenIdConnectCall
    func (s *Service) Tokeninfo() *TokeninfoCall
type Tokeninfo
    func (s *Tokeninfo) MarshalJSON() ([]byte, error)
type TokeninfoCall
    func (c *TokeninfoCall) AccessToken(accessToken string) *TokeninfoCall
    func (c *TokeninfoCall) Context(ctx context.Context) *TokeninfoCall
    func (c *TokeninfoCall) Do(opts ...googleapi.CallOption) (*Tokeninfo, error)
    func (c *TokeninfoCall) Fields(s ...googleapi.Field) *TokeninfoCall
    func (c *TokeninfoCall) Header() http.Header
    func (c *TokeninfoCall) IdToken(idToken string) *TokeninfoCall
    func (c *TokeninfoCall) TokenHandle(tokenHandle string) *TokeninfoCall
type UserinfoGetCall
    func (c *UserinfoGetCall) Context(ctx context.Context) *UserinfoGetCall
    func (c *UserinfoGetCall) Do(opts ...googleapi.CallOption) (*Userinfoplus, error)
    func (c *UserinfoGetCall) Fields(s ...googleapi.Field) *UserinfoGetCall
    func (c *UserinfoGetCall) Header() http.Header
    func (c *UserinfoGetCall) IfNoneMatch(entityTag string) *UserinfoGetCall
type UserinfoService
    func NewUserinfoService(s *Service) *UserinfoService
    func (r *UserinfoService) Get() *UserinfoGetCall
type UserinfoV2MeGetCall
    func (c *UserinfoV2MeGetCall) Context(ctx context.Context) *UserinfoV2MeGetCall
    func (c *UserinfoV2MeGetCall) Do(opts ...googleapi.CallOption) (*Userinfoplus, error)
    func (c *UserinfoV2MeGetCall) Fields(s ...googleapi.Field) *UserinfoV2MeGetCall
    func (c *UserinfoV2MeGetCall) Header() http.Header
    func (c *UserinfoV2MeGetCall) IfNoneMatch(entityTag string) *UserinfoV2MeGetCall
type UserinfoV2MeService
    func NewUserinfoV2MeService(s *Service) *UserinfoV2MeService
    func (r *UserinfoV2MeService) Get() *UserinfoV2MeGetCall
type UserinfoV2Service
    func NewUserinfoV2Service(s *Service) *UserinfoV2Service
type Userinfoplus
    func (s *Userinfoplus) MarshalJSON() ([]byte, error)

Package files

oauth2-gen.go

Constants

OAuth2 scopes used by this API.

const (
    // Know the list of people in your circles, your age range, and language
    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"
)

type GetCertForOpenIdConnectCall

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

func (*GetCertForOpenIdConnectCall) Context

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

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

func (c *GetCertForOpenIdConnectCall) Do(opts ...googleapi.CallOption) (*Jwk, error)

Do executes the "oauth2.getCertForOpenIdConnect" 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 (*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.

func (*GetCertForOpenIdConnectCall) Header

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

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

func (*GetCertForOpenIdConnectCall) IfNoneMatch

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

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

    // NullFields is a list of field names (e.g. "Keys") 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 (*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:"-"`

    // NullFields is a list of field names (e.g. "Alg") 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 (*JwkKeys) MarshalJSON

func (s *JwkKeys) 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) 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"`

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

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) 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(opts ...googleapi.CallOption) (*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) Header

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

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

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

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

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(opts ...googleapi.CallOption) (*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

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.

func (*UserinfoGetCall) Header

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

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

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:

type UserinfoV2MeGetCall

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

func (*UserinfoV2MeGetCall) Context

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

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

func (c *UserinfoV2MeGetCall) Do(opts ...googleapi.CallOption) (*Userinfoplus, error)

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

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.

func (*UserinfoV2MeGetCall) Header

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

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

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

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

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