google-apis-sts_v1 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fffe1e77900186251e2d0765655ed2d0cbe75a9823738c7dff9aa971c09fd9fc
-  data.tar.gz: da94e4cae68bf538adaec4a065a7efbfd17db0ea6e8f75daec73af0d61e534a7
+  metadata.gz: 7d30badf4fa212e56d7a159fc50e1ce28b6bb71328dede34e80b6108a43eb130
+  data.tar.gz: e456e593a732581bc0d799519d85374386671ba56f7beda5b283c4dbb56e6271
 SHA512:
-  metadata.gz: cf8ffd6a8fec67dca0811acc98844c84ca088ee300529f690867c634e45d1803abde1186792ce7ee70a35a29b2ed8fc52a654ae14bcf398c9b935d82f3b55c54
-  data.tar.gz: f11b39eb13c4ac2adf148b017fd168007a151958ae07f55b81d9d45420dc88533f39ea0818420113eca337d08f90cd7f896ea614b6a832193da7984a62ad9cb7
+  metadata.gz: 37fb3b75e2da44b66f16f52fe270f8f5b19d6ece0124f8358d94dcd8b0e92ef02ea7816de64f4b4ed1b5be9a04fea00b0621b7c4f21e75cce0d284d15a9b12e7
+  data.tar.gz: 3db63d86ce9210d2757b27d1d36fc8c3bdf5bebfbba540a17a6abfe4c715e749b1c4cc8bdeff7671a3dcbe28ca10459899afe2ddd46da022c0c46410247f8f77

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-sts_v1
 
+### v0.26.0 (2022-12-09)
+
+* Regenerated from discovery document revision 20221204
+
 ### v0.25.0 (2022-10-20)
 
 * Regenerated using generator version 0.11.0

data/lib/google/apis/sts_v1/classes.rb

@@ -174,6 +174,138 @@ module Google
         end
       end
       
+      # Request message for ExchangeOauthToken
+      class GoogleIdentityStsV1ExchangeOauthTokenRequest
+        include Google::Apis::Core::Hashable
+      
+        # Optional. The client identifier for the OAuth 2.0 client that requested the
+        # provided token. It is REQUIRED when the [client] (https://www.rfc-editor.org/
+        # rfc/rfc6749#section-1.1) is not authenticating with the authorization server,
+        # i.e. when authentication method is [client authentication] (https://www.rfc-
+        # editor.org/rfc/rfc6749#section-3.2.1).
+        # Corresponds to the JSON property `clientId`
+        # @return [String]
+        attr_accessor :client_id
+      
+        # Optional. The authorization code that was previously from workforce identity
+        # federation's `authorize` endpoint. Required if the flow is authorization code
+        # flow, i.e. if grant_type is 'authorization_code'
+        # Corresponds to the JSON property `code`
+        # @return [String]
+        attr_accessor :code
+      
+        # Optional. The code verifier for the PKCE request, Google Cloud CLI originally
+        # generates it before the authorization request. PKCE is used to protect
+        # authorization code from interception attacks. See https://www.rfc-editor.org/
+        # rfc/rfc7636#section-1.1 and https://www.rfc-editor.org/rfc/rfc7636#section-3.
+        # It is required when the flow is authorization code flow, i.e. if grant_type is
+        # 'authorization_code'
+        # Corresponds to the JSON property `codeVerifier`
+        # @return [String]
+        attr_accessor :code_verifier
+      
+        # Required. The grant types are as follows: - 'authorization_code' : an
+        # authorization code flow, i.e. exchange of authorization code for the Oauth
+        # access token - 'refresh_token' : a refresh token flow, i.e. obtain a new
+        # access token by providing the refresh token. See https://www.rfc-editor.org/
+        # rfc/rfc6749#section-6
+        # Corresponds to the JSON property `grantType`
+        # @return [String]
+        attr_accessor :grant_type
+      
+        # Optional. redirect_url is required when the flow is authorization code flow i.
+        # e. if grant_type is `authorization_code` See https://www.rfc-editor.org/rfc/
+        # rfc6749#section-4.1.3
+        # Corresponds to the JSON property `redirectUri`
+        # @return [String]
+        attr_accessor :redirect_uri
+      
+        # Optional. The Refresh token is the credential that is used to obtain a new
+        # access token when the current access token becomes invalid or expires.
+        # Required when using refresh token flow, i.e. if `grant_type` is 'refresh_token'
+        # See https://www.rfc-editor.org/rfc/rfc6749#section-1.5 and https://www.rfc-
+        # editor.org/rfc/rfc6749#section-6
+        # Corresponds to the JSON property `refreshToken`
+        # @return [String]
+        attr_accessor :refresh_token
+      
+        # Optional. An optional list of scopes that are requested for the token to be
+        # returned. See https://www.rfc-editor.org/rfc/rfc6749#section-3.3 Must be a
+        # list of space-delimited, case-sensitive strings. Note: Currently, the scopes
+        # in the request are not supported
+        # Corresponds to the JSON property `scope`
+        # @return [String]
+        attr_accessor :scope
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @client_id = args[:client_id] if args.key?(:client_id)
+          @code = args[:code] if args.key?(:code)
+          @code_verifier = args[:code_verifier] if args.key?(:code_verifier)
+          @grant_type = args[:grant_type] if args.key?(:grant_type)
+          @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
+          @refresh_token = args[:refresh_token] if args.key?(:refresh_token)
+          @scope = args[:scope] if args.key?(:scope)
+        end
+      end
+      
+      # Response message for ExchangeOauthToken. see https://www.rfc-editor.org/rfc/
+      # rfc6749#section-5.1
+      class GoogleIdentityStsV1ExchangeOauthTokenResponse
+        include Google::Apis::Core::Hashable
+      
+        # An OAuth 2.0 security token, issued by Google, in response to the Oauth token
+        # exchange request for the authorization code and refresh token flows. The
+        # returned [access token](https://www.rfc-editor.org/rfc/rfc6749#section-4.1.4).
+        # Tokens can vary in size, depending, in part, on the size of mapped claims, up
+        # to a maximum of 12288 bytes (12 KB). Google reserves the right to change the
+        # token size and the maximum length at any time.
+        # Corresponds to the JSON property `access_token`
+        # @return [String]
+        attr_accessor :access_token
+      
+        # The amount of time, in seconds, between the time when the access token was
+        # issued and the time when the access token will expires.
+        # Corresponds to the JSON property `expires_in`
+        # @return [Fixnum]
+        attr_accessor :expires_in
+      
+        # A refresh token, issued by Google, in response to the OAuth token exchange
+        # request for refresh token flow
+        # Corresponds to the JSON property `refresh_token`
+        # @return [String]
+        attr_accessor :refresh_token
+      
+        # A list of scopes associated with the returned token.
+        # Corresponds to the JSON property `scope`
+        # @return [String]
+        attr_accessor :scope
+      
+        # The type of token. Field reserved for RFC compliance. See https://www.rfc-
+        # editor.org/rfc/rfc6749#section-5.1 Note: No token_type is returned for current
+        # implementation
+        # Corresponds to the JSON property `token_type`
+        # @return [String]
+        attr_accessor :token_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @access_token = args[:access_token] if args.key?(:access_token)
+          @expires_in = args[:expires_in] if args.key?(:expires_in)
+          @refresh_token = args[:refresh_token] if args.key?(:refresh_token)
+          @scope = args[:scope] if args.key?(:scope)
+          @token_type = args[:token_type] if args.key?(:token_type)
+        end
+      end
+      
       # Request message for ExchangeToken.
       class GoogleIdentityStsV1ExchangeTokenRequest
         include Google::Apis::Core::Hashable

data/lib/google/apis/sts_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module StsV1
       # Version of the google-apis-sts_v1 gem
-      GEM_VERSION = "0.25.0"
+      GEM_VERSION = "0.26.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.11.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220916"
+      REVISION = "20221204"
     end
   end
 end

data/lib/google/apis/sts_v1/representations.rb

@@ -40,6 +40,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleIdentityStsV1ExchangeOauthTokenRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleIdentityStsV1ExchangeOauthTokenResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleIdentityStsV1ExchangeTokenRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -122,6 +134,30 @@ module Google
         end
       end
       
+      class GoogleIdentityStsV1ExchangeOauthTokenRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :client_id, as: 'clientId'
+          property :code, as: 'code'
+          property :code_verifier, as: 'codeVerifier'
+          property :grant_type, as: 'grantType'
+          property :redirect_uri, as: 'redirectUri'
+          property :refresh_token, as: 'refreshToken'
+          property :scope, as: 'scope'
+        end
+      end
+      
+      class GoogleIdentityStsV1ExchangeOauthTokenResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :access_token, as: 'access_token'
+          property :expires_in, as: 'expires_in'
+          property :refresh_token, as: 'refresh_token'
+          property :scope, as: 'scope'
+          property :token_type, as: 'token_type'
+        end
+      end
+      
       class GoogleIdentityStsV1ExchangeTokenRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/sts_v1/service.rb

@@ -82,13 +82,51 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Exchanges a credential that represents the resource owner's authorization for
+        # a Google-generated [OAuth 2.0 access token] (https://www.rfc-editor.org/rfc/
+        # rfc6749#section-5) or [refreshes an accesstoken] (https://www.rfc-editor.org/
+        # rfc/rfc6749#section-6) following [the OAuth 2.0 authorization framework] (
+        # https://tools.ietf.org/html/rfc8693) The credential can be one of the
+        # following: - An authorization code issued by the workforce identity federation
+        # authorization endpoint - A [refresh token](https://www.rfc-editor.org/rfc/
+        # rfc6749#section-10.4) issued by this endpoint This endpoint is only meant to
+        # be called by the Google Cloud CLI. Also note that this API only accepts the
+        # authorization code issued for workforce pools.
+        # @param [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenRequest] google_identity_sts_v1_exchange_oauth_token_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def oauthtoken(google_identity_sts_v1_exchange_oauth_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/oauthtoken', options)
+          command.request_representation = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenRequest::Representation
+          command.request_object = google_identity_sts_v1_exchange_oauth_token_request_object
+          command.response_representation = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenResponse::Representation
+          command.response_class = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenResponse
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Exchanges a credential for a Google OAuth 2.0 access token. The token asserts
         # an external identity within an identity pool, or it applies a Credential
         # Access Boundary to a Google access token. Note that workforce pools do not
-        # support Credential Access Boundary at the moment. When you call this method,
-        # do not send the `Authorization` HTTP header in the request. This method does
-        # not require the `Authorization` header, and using the header can cause the
-        # request to fail.
+        # support Credential Access Boundaries. When you call this method, do not send
+        # the `Authorization` HTTP header in the request. This method does not require
+        # the `Authorization` header, and using the header can cause the request to fail.
         # @param [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenRequest] google_identity_sts_v1_exchange_token_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-sts_v1
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-21 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-sts_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-sts_v1/v0.25.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-sts_v1/v0.26.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-sts_v1
 post_install_message: 
 rdoc_options: []