Documentation

Overview

Package sts provides access to the Security Token Service API.

For product documentation, see: http://cloud.google.com/iam/docs/workload-identity-federation

Creating a client

Usage example:

import "google.golang.org/api/sts/v1"
...
ctx := context.Background()
stsService, err := sts.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

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

stsService, err := sts.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, ...)
stsService, err := sts.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GoogleIdentityStsV1ExchangeTokenRequest

type GoogleIdentityStsV1ExchangeTokenRequest struct {
	// GrantType: Required. The grant type. Must be
	// `urn:ietf:params:oauth:grant-type:token-exchange`, which indicates a
	// token exchange.
	GrantType string `json:"grantType,omitempty"`

	// Options: A set of features that Security Token Service supports, in
	// addition to the standard OAuth 2.0 token exchange, formatted as a
	// serialized JSON object of Options.
	Options string `json:"options,omitempty"`

	// RequestedTokenType: Required. An identifier for the type of requested
	// security token. Must be
	// `urn:ietf:params:oauth:token-type:access_token`.
	RequestedTokenType string `json:"requestedTokenType,omitempty"`

	// SubjectToken: Required. The input token. You can use a Google-issued
	// OAuth 2.0 access token with this field to obtain an access token with
	// new security attributes applied, such as a Credential Access
	// Boundary. If an access token already contains security attributes,
	// you cannot apply additional security attributes.
	SubjectToken string `json:"subjectToken,omitempty"`

	// SubjectTokenType: Required. An identifier that indicates the type of
	// the security token in the `subject_token` parameter. Must be
	// `urn:ietf:params:oauth:token-type:access_token`.
	SubjectTokenType string `json:"subjectTokenType,omitempty"`

	// ForceSendFields is a list of field names (e.g. "GrantType") 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. "GrantType") 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:"-"`
}

    GoogleIdentityStsV1ExchangeTokenRequest: Request message for ExchangeToken.

    func (*GoogleIdentityStsV1ExchangeTokenRequest) MarshalJSON

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

    type GoogleIdentityStsV1ExchangeTokenResponse

    type GoogleIdentityStsV1ExchangeTokenResponse struct {
    	// AccessToken: An OAuth 2.0 security token, issued by Google, in
    	// response to the token exchange request.
    	AccessToken string `json:"access_token,omitempty"`
    
    	// ExpiresIn: The amount of time, in seconds, between the time when the
    	// `access_token` was issued and the time when the `access_token` will
    	// expire. This field is absent when the `subject_token` in the request
    	// is a Google-issued, short-lived access token. In this case, the
    	// `access_token` has the same expiration time as the `subject_token`.
    	ExpiresIn int64 `json:"expires_in,omitempty"`
    
    	// IssuedTokenType: The token type. Always matches the value of
    	// `requested_token_type` from the request.
    	IssuedTokenType string `json:"issued_token_type,omitempty"`
    
    	// TokenType: The type of `access_token`. Always has the value `Bearer`.
    	TokenType string `json:"token_type,omitempty"`
    
    	// ServerResponse contains the HTTP response code and headers from the
    	// server.
    	googleapi.ServerResponse `json:"-"`
    
    	// ForceSendFields is a list of field names (e.g. "AccessToken") 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. "AccessToken") 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:"-"`
    }

      GoogleIdentityStsV1ExchangeTokenResponse: Response message for ExchangeToken.

      func (*GoogleIdentityStsV1ExchangeTokenResponse) MarshalJSON

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

      type Service

      type Service struct {
      	BasePath  string // API endpoint base URL
      	UserAgent string // optional additional User-Agent fragment
      
      	V1 *V1Service
      	// contains filtered or unexported fields
      }

      func New

      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.

        func NewService

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

          NewService creates a new Service.

          type V1Service

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

          func NewV1Service

          func NewV1Service(s *Service) *V1Service

          func (*V1Service) Token

          func (r *V1Service) Token(googleidentitystsv1exchangetokenrequest *GoogleIdentityStsV1ExchangeTokenRequest) *V1TokenCall

            Token: Exchanges a credential for a Google OAuth 2.0 access token.

            type V1TokenCall

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

            func (*V1TokenCall) Context

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

              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 (*V1TokenCall) Do

                Do executes the "sts.token" call. Exactly one of *GoogleIdentityStsV1ExchangeTokenResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleIdentityStsV1ExchangeTokenResponse.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 (*V1TokenCall) Fields

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

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

                  func (*V1TokenCall) Header

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

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

                    Source Files