google-api-client 0.42.1 → 0.44.2

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

@@ -0,0 +1,59 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module StsV1
+      
+      class GoogleIdentityStsV1ExchangeTokenRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleIdentityStsV1ExchangeTokenResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleIdentityStsV1ExchangeTokenRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :grant_type, as: 'grantType'
+          property :options, as: 'options'
+          property :requested_token_type, as: 'requestedTokenType'
+          property :subject_token, as: 'subjectToken'
+          property :subject_token_type, as: 'subjectTokenType'
+        end
+      end
+      
+      class GoogleIdentityStsV1ExchangeTokenResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :access_token, as: 'access_token'
+          property :expires_in, as: 'expires_in'
+          property :issued_token_type, as: 'issued_token_type'
+          property :token_type, as: 'token_type'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module StsV1
+      # Security Token Service API
+      #
+      # The Security Token Service exchanges Google or third-party credentials for a
+      #  short-lived access token to Google Cloud resources.
+      #
+      # @example
+      #    require 'google/apis/sts_v1'
+      #
+      #    Sts = Google::Apis::StsV1 # Alias the module
+      #    service = Sts::CloudSecurityTokenService.new
+      #
+      # @see http://cloud.google.com/iam/docs/workload-identity-federation
+      class CloudSecurityTokenService < Google::Apis::Core::BaseService
+        # @return [String]
+        #  API key. Your API key identifies your project and provides you with API access,
+        #  quota, and reports. Required unless you provide an OAuth 2.0 token.
+        attr_accessor :key
+
+        # @return [String]
+        #  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.
+        attr_accessor :quota_user
+
+        def initialize
+          super('https://sts.googleapis.com/', '')
+          @batch_path = 'batch'
+        end
+        
+        # Exchanges a credential for a Google OAuth 2.0 access token.
+        # @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.
+        # @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::GoogleIdentityStsV1ExchangeTokenResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenResponse]
+        #
+        # @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 token(google_identity_sts_v1_exchange_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/token', options)
+          command.request_representation = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenRequest::Representation
+          command.request_object = google_identity_sts_v1_exchange_token_request_object
+          command.response_representation = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenResponse::Representation
+          command.response_class = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenResponse
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+
+        protected
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        end
+      end
+    end
+  end
+end

data/generated/google/apis/sts_v1beta.rb

@@ -0,0 +1,32 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/sts_v1beta/service.rb'
+require 'google/apis/sts_v1beta/classes.rb'
+require 'google/apis/sts_v1beta/representations.rb'
+
+module Google
+  module Apis
+    # Security Token Service API
+    #
+    # The Security Token Service exchanges Google or third-party credentials for a
+    # short-lived access token to Google Cloud resources.
+    #
+    # @see http://cloud.google.com/iam/docs/workload-identity-federation
+    module StsV1beta
+      VERSION = 'V1beta'
+      REVISION = '20200908'
+    end
+  end
+end

data/generated/google/apis/sts_v1beta/classes.rb

@@ -0,0 +1,191 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module StsV1beta
+      
+      # Request message for ExchangeToken.
+      class GoogleIdentityStsV1betaExchangeTokenRequest
+        include Google::Apis::Core::Hashable
+      
+        # The full resource name of the identity provider; for example: `https://iam.
+        # googleapis.com/projects/`PROJECT_ID`/workloadIdentityPools/`POOL_ID`/providers/
+        # `PROVIDER_ID``. Required when exchanging an external credential for a Google
+        # access token.
+        # Corresponds to the JSON property `audience`
+        # @return [String]
+        attr_accessor :audience
+      
+        # Required. The grant type. Must be `urn:ietf:params:oauth:grant-type:token-
+        # exchange`, which indicates a token exchange is requested.
+        # Corresponds to the JSON property `grantType`
+        # @return [String]
+        attr_accessor :grant_type
+      
+        # 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.
+        # Corresponds to the JSON property `options`
+        # @return [String]
+        attr_accessor :options
+      
+        # Required. An identifier for the type of requested security token. Must be `urn:
+        # ietf:params:oauth:token-type:access_token`.
+        # Corresponds to the JSON property `requestedTokenType`
+        # @return [String]
+        attr_accessor :requested_token_type
+      
+        # The OAuth 2.0 scopes to include on the resulting access token, formatted as a
+        # list of space-delimited, case-sensitive strings. Required when exchanging an
+        # external credential for a Google access token.
+        # Corresponds to the JSON property `scope`
+        # @return [String]
+        attr_accessor :scope
+      
+        # Required. The input token. This is a either an external credential issued by a
+        # WorkloadIdentityPoolProvider, or a short-lived access token issued by Google.
+        # If the token is an OIDC JWT, it must use the JWT format defined in [RFC 7523](
+        # https://tools.ietf.org/html/rfc7523), and `subject_token_type` must be `urn:
+        # ietf:params:oauth:token-type:jwt`. The following headers are required: - **`
+        # kid`**: The identifier of the signing key securing the JWT. - **`alg`**: The
+        # cryptographic algorithm securing the JWT. Must be `RS256`. The following
+        # payload fields are required. For more information, see [RFC 7523, Section 3](
+        # https://tools.ietf.org/html/rfc7523#section-3). - **`iss`**: The issuer of the
+        # token. The issuer must provide a discovery document at `/.well-known/openid-
+        # configuration`, formatted according to section 4.2 of the [OIDC 1.0 Discovery
+        # specification](https://openid.net/specs/openid-connect-discovery-1_0.html#
+        # ProviderConfigurationResponse). - **`iat`**: The issue time, in seconds, since
+        # epoch. Must be in the past. - **`exp`**: The expiration time, in seconds,
+        # since epoch. Must be fewer than 48 hours after `iat`. Shorter expiration times
+        # are more. secure. If possible, we recommend setting an expiration time fewer
+        # than 6 hours. - **`sub`**: The identity asserted in the JWT. - **`aud`**:
+        # Configured by the mapper policy. The default value is the service account's
+        # unique ID. Example header: ``` ` "alg": "RS256", "kid": "us-east-11" ` ```
+        # Example payload: ``` ` "iss": "https://accounts.google.com", "iat": 1517963104,
+        # "exp": 1517966704, "aud": "113475438248934895348", "sub": "
+        # 113475438248934895348", "my_claims": ` "additional_claim": "value" ` ` ``` If `
+        # subject_token` is an AWS token, it must be a serialized, [signed](https://docs.
+        # aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) request to the
+        # AWS [`GetCallerIdentity()`](https://docs.aws.amazon.com/STS/latest/
+        # APIReference/API_GetCallerIdentity) method. Format the request as URL-encoded
+        # JSON, and set the `subject_token_type` parameter to `urn:ietf:params:aws:token-
+        # type:aws4_request`. The following parameters are required: - **`url`**: The
+        # URL of the AWS STS endpoint for `GetCallerIdentity()`, such as `https://sts.
+        # amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15`. Regional endpoints
+        # are also supported. - **`method`:** The HTTP request method: `POST`. - **`
+        # headers`**: The HTTP request headers, which must include: - **`Authorization`**
+        # : The request signature. - **`x-amz-date`**`: The time you will send the
+        # request, formatted as an [ISO8601 Basic](https://docs.aws.amazon.com/general/
+        # latest/gr/sigv4_elements.html#sigv4_elements_date) string. This is typically
+        # set to the current time, and used to prevent replay attacks. - **`host`**: The
+        # hostname of the `url` field; for example, `sts.amazonaws.com`. - **`x-goog-
+        # cloud-target-resource`**: The full, canonical resource name of the
+        # WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ``
+        # ` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/
+        # https://iam.googleapis.com/projects//locations//workloadIdentityPools//
+        # providers/ ``` Signing this header as part of the signature is recommended to
+        # ensure data integrity. If you are using temporary security credentials
+        # provided by AWS, you must also include the header `x-amz-security-token`, with
+        # the value `[SESSION_TOKEN]`. The following is an example of a signed,
+        # serialized request: ``` ` "headers":[ `"key": "x-amz-date", "value": "
+        # 20200815T015049Z"`, `"key": "Authorization", "value": "AWS4-HMAC-SHA256+
+        # Credential=$credential,+SignedHeaders=host;x-amz-date;x-goog-cloud-target-
+        # resource,+Signature=$signature"`, `"key": "x-goog-cloud-target-resource", "
+        # value": "//iam.googleapis.com/projects//locations//workloadIdentityPools//
+        # providers/"`, `"key": "host", "value": "sts.amazonaws.com"` . ], "method":"
+        # POST", "url":"https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-
+        # 06-15" ` ``` You can also use a Google-issued OAuth 2.0 access token with this
+        # field to obtain an access token with new security attributes applied, such as
+        # an AccessBoundary. In this case, set `subject_token_type` to `urn:ietf:params:
+        # oauth:token-type:access_token`. Applying additional security attributes on
+        # access tokens that already contain security attributes is not allowed.
+        # Corresponds to the JSON property `subjectToken`
+        # @return [String]
+        attr_accessor :subject_token
+      
+        # Required. An identifier that indicates the type of the security token in the `
+        # subject_token` parameter. Supported values are `urn:ietf:params:oauth:token-
+        # type:jwt`, `urn:ietf:params:aws:token-type:aws4_request` and `urn:ietf:params:
+        # oauth:token-type:access_token`.
+        # Corresponds to the JSON property `subjectTokenType`
+        # @return [String]
+        attr_accessor :subject_token_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @audience = args[:audience] if args.key?(:audience)
+          @grant_type = args[:grant_type] if args.key?(:grant_type)
+          @options = args[:options] if args.key?(:options)
+          @requested_token_type = args[:requested_token_type] if args.key?(:requested_token_type)
+          @scope = args[:scope] if args.key?(:scope)
+          @subject_token = args[:subject_token] if args.key?(:subject_token)
+          @subject_token_type = args[:subject_token_type] if args.key?(:subject_token_type)
+        end
+      end
+      
+      # Response message for ExchangeToken.
+      class GoogleIdentityStsV1betaExchangeTokenResponse
+        include Google::Apis::Core::Hashable
+      
+        # An OAuth 2.0 security token, issued by Google, in response to the token
+        # exchange request.
+        # Corresponds to the JSON property `access_token`
+        # @return [String]
+        attr_accessor :access_token
+      
+        # The expiration time of `access_token`, in seconds, from the time of issuance.
+        # This field is absent when the `subject_token` in the request is a Google-
+        # issued, short-lived access token. In this case, the expiration time of the `
+        # access_token` is the same as the `subject_token`.
+        # Corresponds to the JSON property `expires_in`
+        # @return [Fixnum]
+        attr_accessor :expires_in
+      
+        # The token type. Always matches the value of `requested_token_type` from the
+        # request.
+        # Corresponds to the JSON property `issued_token_type`
+        # @return [String]
+        attr_accessor :issued_token_type
+      
+        # The type of `access_token`. Always has the value `Bearer`.
+        # 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)
+          @issued_token_type = args[:issued_token_type] if args.key?(:issued_token_type)
+          @token_type = args[:token_type] if args.key?(:token_type)
+        end
+      end
+    end
+  end
+end

data/generated/google/apis/{oauth2_v2 → sts_v1beta}/representations.rb

@@ -20,47 +20,40 @@ require 'google/apis/errors'
 
 module Google
   module Apis
-    module Oauth2V2
+    module StsV1beta
       
-      class Tokeninfo
+      class GoogleIdentityStsV1betaExchangeTokenRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class Userinfo
+      class GoogleIdentityStsV1betaExchangeTokenResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class Tokeninfo
+      class GoogleIdentityStsV1betaExchangeTokenRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :audience, as: 'audience'
-          property :email, as: 'email'
-          property :expires_in, as: 'expires_in'
-          property :issued_to, as: 'issued_to'
+          property :grant_type, as: 'grantType'
+          property :options, as: 'options'
+          property :requested_token_type, as: 'requestedTokenType'
           property :scope, as: 'scope'
-          property :user_id, as: 'user_id'
-          property :verified_email, as: 'verified_email'
+          property :subject_token, as: 'subjectToken'
+          property :subject_token_type, as: 'subjectTokenType'
         end
       end
       
-      class Userinfo
+      class GoogleIdentityStsV1betaExchangeTokenResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
-          property :email, as: 'email'
-          property :family_name, as: 'family_name'
-          property :gender, as: 'gender'
-          property :given_name, as: 'given_name'
-          property :hd, as: 'hd'
-          property :id, as: 'id'
-          property :link, as: 'link'
-          property :locale, as: 'locale'
-          property :name, as: 'name'
-          property :picture, as: 'picture'
-          property :verified_email, as: 'verified_email'
+          property :access_token, as: 'access_token'
+          property :expires_in, as: 'expires_in'
+          property :issued_token_type, as: 'issued_token_type'
+          property :token_type, as: 'token_type'
         end
       end
     end

data/generated/google/apis/sts_v1beta/service.rb

@@ -0,0 +1,92 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module StsV1beta
+      # Security Token Service API
+      #
+      # The Security Token Service exchanges Google or third-party credentials for a
+      #  short-lived access token to Google Cloud resources.
+      #
+      # @example
+      #    require 'google/apis/sts_v1beta'
+      #
+      #    Sts = Google::Apis::StsV1beta # Alias the module
+      #    service = Sts::CloudSecurityTokenService.new
+      #
+      # @see http://cloud.google.com/iam/docs/workload-identity-federation
+      class CloudSecurityTokenService < Google::Apis::Core::BaseService
+        # @return [String]
+        #  API key. Your API key identifies your project and provides you with API access,
+        #  quota, and reports. Required unless you provide an OAuth 2.0 token.
+        attr_accessor :key
+
+        # @return [String]
+        #  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.
+        attr_accessor :quota_user
+
+        def initialize
+          super('https://sts.googleapis.com/', '')
+          @batch_path = 'batch'
+        end
+        
+        # Exchanges a credential for a Google OAuth 2.0 access token. The token asserts
+        # an external identity within a WorkloadIdentityPool, or applies an Access
+        # Boundary on a Google access token.
+        # @param [Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenRequest] google_identity_sts_v1beta_exchange_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::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse]
+        #
+        # @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 token(google_identity_sts_v1beta_exchange_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/token', options)
+          command.request_representation = Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenRequest::Representation
+          command.request_object = google_identity_sts_v1beta_exchange_token_request_object
+          command.response_representation = Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse::Representation
+          command.response_class = Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+
+        protected
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        end
+      end
+    end
+  end
+end