google-apis-sts_v1 0.33.0 → 0.34.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 691e732935fa65cd126f5fab9a8b055f09311b6516b08e02469ee123d3af4060
4
- data.tar.gz: 5ea49d2a580e8dff2327585fb6642ae63d4ef318d248c1e43030548801220989
3
+ metadata.gz: cea65ecb0bfde0cbeaac2d45f30c29828a0ece60a18e7c0c0409b4d1ea93731c
4
+ data.tar.gz: d80a84206052cef16ed3a96a69315b721f75b30291005b7e4bf0c3d9efe89855
5
5
  SHA512:
6
- metadata.gz: 0ab7238f262a8e929a24b862f564aef623c63fd7205cfc24b65e8f67ec38a9024b52c8cb8fc324e36b40963381f2a6e4fc3744817593db274fa07a7e97adb28b
7
- data.tar.gz: ae8151f51ed7d1a3984b2e09bb1395ab08be8f7e370a6047246a8c49461c2733d70731e4fc504b2e160873db51bbcd96f9073756ce86fbd8ec5bb075e30a44b1
6
+ metadata.gz: ced2b99a87d077209226c131d7cd235425c317c1aa0e2c590f9158e00f7dd10215b2c1546de8e7fa30fd1ae5b51a3a409dda694e39718fa9cc8aba5e8a0098a0
7
+ data.tar.gz: 5826660fa028d25e3d269a2be203e95aba6f8a10d45c976b3aaebc73e511f6a233cdd1ca9dc65a338b9d7ff79e98663815d820223fdba4d54a38c7ad553b015d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-sts_v1
2
2
 
3
+ ### v0.34.0 (2024-03-17)
4
+
5
+ * Regenerated from discovery document revision 20240307
6
+
3
7
  ### v0.33.0 (2024-02-24)
4
8
 
5
9
  * Regenerated using generator version 0.14.0
@@ -199,144 +199,6 @@ module Google
199
199
  end
200
200
  end
201
201
 
202
- # Request message for ExchangeOauthToken
203
- class GoogleIdentityStsV1ExchangeOauthTokenRequest
204
- include Google::Apis::Core::Hashable
205
-
206
- # Optional. The client identifier for the OAuth 2.0 client that requested the
207
- # provided token. It is REQUIRED when the [client] (https://www.rfc-editor.org/
208
- # rfc/rfc6749#section-1.1) is not authenticating with the authorization server,
209
- # i.e. when authentication method is [client authentication] (https://www.rfc-
210
- # editor.org/rfc/rfc6749#section-3.2.1).
211
- # Corresponds to the JSON property `clientId`
212
- # @return [String]
213
- attr_accessor :client_id
214
-
215
- # Optional. The authorization code that was previously from workforce identity
216
- # federation's `authorize` endpoint. Required if the flow is authorization code
217
- # flow, i.e. if grant_type is 'authorization_code'
218
- # Corresponds to the JSON property `code`
219
- # @return [String]
220
- attr_accessor :code
221
-
222
- # Optional. The code verifier for the PKCE request, Google Cloud CLI originally
223
- # generates it before the authorization request. PKCE is used to protect
224
- # authorization code from interception attacks. See https://www.rfc-editor.org/
225
- # rfc/rfc7636#section-1.1 and https://www.rfc-editor.org/rfc/rfc7636#section-3.
226
- # It is required when the flow is authorization code flow, i.e. if grant_type is
227
- # 'authorization_code'
228
- # Corresponds to the JSON property `codeVerifier`
229
- # @return [String]
230
- attr_accessor :code_verifier
231
-
232
- # Required. The grant types are as follows: - 'authorization_code' : an
233
- # authorization code flow, i.e. exchange of authorization code for the Oauth
234
- # access token - 'refresh_token' : a refresh token flow, i.e. obtain a new
235
- # access token by providing the refresh token. See https://www.rfc-editor.org/
236
- # rfc/rfc6749#section-6
237
- # Corresponds to the JSON property `grantType`
238
- # @return [String]
239
- attr_accessor :grant_type
240
-
241
- # Optional. redirect_url is required when the flow is authorization code flow i.
242
- # e. if grant_type is `authorization_code` See https://www.rfc-editor.org/rfc/
243
- # rfc6749#section-4.1.3
244
- # Corresponds to the JSON property `redirectUri`
245
- # @return [String]
246
- attr_accessor :redirect_uri
247
-
248
- # Optional. The Refresh token is the credential that is used to obtain a new
249
- # access token when the current access token becomes invalid or expires.
250
- # Required when using refresh token flow, i.e. if `grant_type` is 'refresh_token'
251
- # See https://www.rfc-editor.org/rfc/rfc6749#section-1.5 and https://www.rfc-
252
- # editor.org/rfc/rfc6749#section-6
253
- # Corresponds to the JSON property `refreshToken`
254
- # @return [String]
255
- attr_accessor :refresh_token
256
-
257
- # Optional. An optional list of scopes that are requested for the token to be
258
- # returned. See https://www.rfc-editor.org/rfc/rfc6749#section-3.3 Must be a
259
- # list of space-delimited, case-sensitive strings. Note: Currently, the scopes
260
- # in the request are not supported
261
- # Corresponds to the JSON property `scope`
262
- # @return [String]
263
- attr_accessor :scope
264
-
265
- def initialize(**args)
266
- update!(**args)
267
- end
268
-
269
- # Update properties of this object
270
- def update!(**args)
271
- @client_id = args[:client_id] if args.key?(:client_id)
272
- @code = args[:code] if args.key?(:code)
273
- @code_verifier = args[:code_verifier] if args.key?(:code_verifier)
274
- @grant_type = args[:grant_type] if args.key?(:grant_type)
275
- @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
276
- @refresh_token = args[:refresh_token] if args.key?(:refresh_token)
277
- @scope = args[:scope] if args.key?(:scope)
278
- end
279
- end
280
-
281
- # Response message for ExchangeOauthToken. see https://www.rfc-editor.org/rfc/
282
- # rfc6749#section-5.1
283
- class GoogleIdentityStsV1ExchangeOauthTokenResponse
284
- include Google::Apis::Core::Hashable
285
-
286
- # An OAuth 2.0 security token, issued by Google, in response to the Oauth token
287
- # exchange request for the authorization code and refresh token flows. The
288
- # returned [access token](https://www.rfc-editor.org/rfc/rfc6749#section-4.1.4).
289
- # Tokens can vary in size, depending, in part, on the size of mapped claims, up
290
- # to a maximum of 12288 bytes (12 KB). Google reserves the right to change the
291
- # token size and the maximum length at any time.
292
- # Corresponds to the JSON property `access_token`
293
- # @return [String]
294
- attr_accessor :access_token
295
-
296
- # The amount of time, in seconds, between the time when the access token was
297
- # issued and the time when the access token will expires.
298
- # Corresponds to the JSON property `expires_in`
299
- # @return [Fixnum]
300
- attr_accessor :expires_in
301
-
302
- # Google issued ID token in response to the OAuth token exchange request for ID
303
- # token flow.
304
- # Corresponds to the JSON property `id_token`
305
- # @return [String]
306
- attr_accessor :id_token
307
-
308
- # A refresh token, issued by Google, in response to the OAuth token exchange
309
- # request for refresh token flow
310
- # Corresponds to the JSON property `refresh_token`
311
- # @return [String]
312
- attr_accessor :refresh_token
313
-
314
- # A list of scopes associated with the returned token.
315
- # Corresponds to the JSON property `scope`
316
- # @return [String]
317
- attr_accessor :scope
318
-
319
- # The type of token. Field reserved for RFC compliance. See https://www.rfc-
320
- # editor.org/rfc/rfc6749#section-5.1
321
- # Corresponds to the JSON property `token_type`
322
- # @return [String]
323
- attr_accessor :token_type
324
-
325
- def initialize(**args)
326
- update!(**args)
327
- end
328
-
329
- # Update properties of this object
330
- def update!(**args)
331
- @access_token = args[:access_token] if args.key?(:access_token)
332
- @expires_in = args[:expires_in] if args.key?(:expires_in)
333
- @id_token = args[:id_token] if args.key?(:id_token)
334
- @refresh_token = args[:refresh_token] if args.key?(:refresh_token)
335
- @scope = args[:scope] if args.key?(:scope)
336
- @token_type = args[:token_type] if args.key?(:token_type)
337
- end
338
- end
339
-
340
202
  # Request message for ExchangeToken.
341
203
  class GoogleIdentityStsV1ExchangeTokenRequest
342
204
  include Google::Apis::Core::Hashable
@@ -525,108 +387,6 @@ module Google
525
387
  end
526
388
  end
527
389
 
528
- # Request message for IntrospectToken.
529
- class GoogleIdentityStsV1IntrospectTokenRequest
530
- include Google::Apis::Core::Hashable
531
-
532
- # Required. The OAuth 2.0 security token issued by the Security Token Service
533
- # API.
534
- # Corresponds to the JSON property `token`
535
- # @return [String]
536
- attr_accessor :token
537
-
538
- # Optional. The type of the given token. Supported values are `urn:ietf:params:
539
- # oauth:token-type:access_token` and `access_token`.
540
- # Corresponds to the JSON property `tokenTypeHint`
541
- # @return [String]
542
- attr_accessor :token_type_hint
543
-
544
- def initialize(**args)
545
- update!(**args)
546
- end
547
-
548
- # Update properties of this object
549
- def update!(**args)
550
- @token = args[:token] if args.key?(:token)
551
- @token_type_hint = args[:token_type_hint] if args.key?(:token_type_hint)
552
- end
553
- end
554
-
555
- # Response message for IntrospectToken.
556
- class GoogleIdentityStsV1IntrospectTokenResponse
557
- include Google::Apis::Core::Hashable
558
-
559
- # A boolean value that indicates whether the provided access token is currently
560
- # active.
561
- # Corresponds to the JSON property `active`
562
- # @return [Boolean]
563
- attr_accessor :active
564
- alias_method :active?, :active
565
-
566
- # The client identifier for the OAuth 2.0 client that requested the provided
567
- # token.
568
- # Corresponds to the JSON property `client_id`
569
- # @return [String]
570
- attr_accessor :client_id
571
-
572
- # The expiration timestamp, measured in the number of seconds since January 1
573
- # 1970 UTC, indicating when this token will expire.
574
- # Corresponds to the JSON property `exp`
575
- # @return [Fixnum]
576
- attr_accessor :exp
577
-
578
- # The issued timestamp, measured in the number of seconds since January 1 1970
579
- # UTC, indicating when this token was originally issued.
580
- # Corresponds to the JSON property `iat`
581
- # @return [Fixnum]
582
- attr_accessor :iat
583
-
584
- # The issuer of the provided token.
585
- # Corresponds to the JSON property `iss`
586
- # @return [String]
587
- attr_accessor :iss
588
-
589
- # A list of scopes associated with the provided token.
590
- # Corresponds to the JSON property `scope`
591
- # @return [String]
592
- attr_accessor :scope
593
-
594
- # The unique user ID associated with the provided token. For Google Accounts,
595
- # this value is based on the Google Account's user ID. For federated identities,
596
- # this value is based on the identity pool ID and the value of the mapped `
597
- # google.subject` attribute.
598
- # Corresponds to the JSON property `sub`
599
- # @return [String]
600
- attr_accessor :sub
601
-
602
- # The human-readable identifier for the token principal subject. For example, if
603
- # the provided token is associated with a workload identity pool, this field
604
- # contains a value in the following format: `principal://iam.googleapis.com/
605
- # projects//locations/global/workloadIdentityPools//subject/`. If the provided
606
- # token is associated with a workforce pool, this field contains a value in the
607
- # following format: `principal://iam.googleapis.com/locations/global/
608
- # workforcePools//subject/`.
609
- # Corresponds to the JSON property `username`
610
- # @return [String]
611
- attr_accessor :username
612
-
613
- def initialize(**args)
614
- update!(**args)
615
- end
616
-
617
- # Update properties of this object
618
- def update!(**args)
619
- @active = args[:active] if args.key?(:active)
620
- @client_id = args[:client_id] if args.key?(:client_id)
621
- @exp = args[:exp] if args.key?(:exp)
622
- @iat = args[:iat] if args.key?(:iat)
623
- @iss = args[:iss] if args.key?(:iss)
624
- @scope = args[:scope] if args.key?(:scope)
625
- @sub = args[:sub] if args.key?(:sub)
626
- @username = args[:username] if args.key?(:username)
627
- end
628
- end
629
-
630
390
  # An `Options` object configures features that the Security Token Service
631
391
  # supports, but that are not supported by standard OAuth 2.0 token exchange
632
392
  # endpoints, as defined in https://tools.ietf.org/html/rfc8693.
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module StsV1
18
18
  # Version of the google-apis-sts_v1 gem
19
- GEM_VERSION = "0.33.0"
19
+ GEM_VERSION = "0.34.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.14.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240129"
25
+ REVISION = "20240307"
26
26
  end
27
27
  end
28
28
  end
@@ -40,18 +40,6 @@ module Google
40
40
  include Google::Apis::Core::JsonObjectSupport
41
41
  end
42
42
 
43
- class GoogleIdentityStsV1ExchangeOauthTokenRequest
44
- class Representation < Google::Apis::Core::JsonRepresentation; end
45
-
46
- include Google::Apis::Core::JsonObjectSupport
47
- end
48
-
49
- class GoogleIdentityStsV1ExchangeOauthTokenResponse
50
- class Representation < Google::Apis::Core::JsonRepresentation; end
51
-
52
- include Google::Apis::Core::JsonObjectSupport
53
- end
54
-
55
43
  class GoogleIdentityStsV1ExchangeTokenRequest
56
44
  class Representation < Google::Apis::Core::JsonRepresentation; end
57
45
 
@@ -64,18 +52,6 @@ module Google
64
52
  include Google::Apis::Core::JsonObjectSupport
65
53
  end
66
54
 
67
- class GoogleIdentityStsV1IntrospectTokenRequest
68
- class Representation < Google::Apis::Core::JsonRepresentation; end
69
-
70
- include Google::Apis::Core::JsonObjectSupport
71
- end
72
-
73
- class GoogleIdentityStsV1IntrospectTokenResponse
74
- class Representation < Google::Apis::Core::JsonRepresentation; end
75
-
76
- include Google::Apis::Core::JsonObjectSupport
77
- end
78
-
79
55
  class GoogleIdentityStsV1Options
80
56
  class Representation < Google::Apis::Core::JsonRepresentation; end
81
57
 
@@ -134,31 +110,6 @@ module Google
134
110
  end
135
111
  end
136
112
 
137
- class GoogleIdentityStsV1ExchangeOauthTokenRequest
138
- # @private
139
- class Representation < Google::Apis::Core::JsonRepresentation
140
- property :client_id, as: 'clientId'
141
- property :code, as: 'code'
142
- property :code_verifier, as: 'codeVerifier'
143
- property :grant_type, as: 'grantType'
144
- property :redirect_uri, as: 'redirectUri'
145
- property :refresh_token, as: 'refreshToken'
146
- property :scope, as: 'scope'
147
- end
148
- end
149
-
150
- class GoogleIdentityStsV1ExchangeOauthTokenResponse
151
- # @private
152
- class Representation < Google::Apis::Core::JsonRepresentation
153
- property :access_token, as: 'access_token'
154
- property :expires_in, as: 'expires_in'
155
- property :id_token, as: 'id_token'
156
- property :refresh_token, as: 'refresh_token'
157
- property :scope, as: 'scope'
158
- property :token_type, as: 'token_type'
159
- end
160
- end
161
-
162
113
  class GoogleIdentityStsV1ExchangeTokenRequest
163
114
  # @private
164
115
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -182,28 +133,6 @@ module Google
182
133
  end
183
134
  end
184
135
 
185
- class GoogleIdentityStsV1IntrospectTokenRequest
186
- # @private
187
- class Representation < Google::Apis::Core::JsonRepresentation
188
- property :token, as: 'token'
189
- property :token_type_hint, as: 'tokenTypeHint'
190
- end
191
- end
192
-
193
- class GoogleIdentityStsV1IntrospectTokenResponse
194
- # @private
195
- class Representation < Google::Apis::Core::JsonRepresentation
196
- property :active, as: 'active'
197
- property :client_id, as: 'client_id'
198
- property :exp, :numeric_string => true, as: 'exp'
199
- property :iat, :numeric_string => true, as: 'iat'
200
- property :iss, as: 'iss'
201
- property :scope, as: 'scope'
202
- property :sub, as: 'sub'
203
- property :username, as: 'username'
204
- end
205
- end
206
-
207
136
  class GoogleIdentityStsV1Options
208
137
  # @private
209
138
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -52,77 +52,6 @@ module Google
52
52
  @batch_path = 'batch'
53
53
  end
54
54
 
55
- # Gets information about a Google OAuth 2.0 access token issued by the Google
56
- # Cloud [Security Token Service API](https://cloud.google.com/iam/docs/reference/
57
- # sts/rest).
58
- # @param [Google::Apis::StsV1::GoogleIdentityStsV1IntrospectTokenRequest] google_identity_sts_v1_introspect_token_request_object
59
- # @param [String] fields
60
- # Selector specifying which fields to include in a partial response.
61
- # @param [String] quota_user
62
- # Available to use for quota purposes for server-side applications. Can be any
63
- # arbitrary string assigned to a user, but should not exceed 40 characters.
64
- # @param [Google::Apis::RequestOptions] options
65
- # Request-specific options
66
- #
67
- # @yield [result, err] Result & error if block supplied
68
- # @yieldparam result [Google::Apis::StsV1::GoogleIdentityStsV1IntrospectTokenResponse] parsed result object
69
- # @yieldparam err [StandardError] error object if request failed
70
- #
71
- # @return [Google::Apis::StsV1::GoogleIdentityStsV1IntrospectTokenResponse]
72
- #
73
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
74
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
75
- # @raise [Google::Apis::AuthorizationError] Authorization is required
76
- def introspect(google_identity_sts_v1_introspect_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
77
- command = make_simple_command(:post, 'v1/introspect', options)
78
- command.request_representation = Google::Apis::StsV1::GoogleIdentityStsV1IntrospectTokenRequest::Representation
79
- command.request_object = google_identity_sts_v1_introspect_token_request_object
80
- command.response_representation = Google::Apis::StsV1::GoogleIdentityStsV1IntrospectTokenResponse::Representation
81
- command.response_class = Google::Apis::StsV1::GoogleIdentityStsV1IntrospectTokenResponse
82
- command.query['fields'] = fields unless fields.nil?
83
- command.query['quotaUser'] = quota_user unless quota_user.nil?
84
- execute_or_queue_command(command, &block)
85
- end
86
-
87
- # Exchanges a credential that represents the resource owner's authorization for
88
- # a Google-generated [OAuth 2.0 access token] (https://www.rfc-editor.org/rfc/
89
- # rfc6749#section-5) or [refreshes an accesstoken] (https://www.rfc-editor.org/
90
- # rfc/rfc6749#section-6) following [the OAuth 2.0 authorization framework] (
91
- # https://tools.ietf.org/html/rfc8693) The credential can be one of the
92
- # following: - An authorization code issued by the workforce identity federation
93
- # authorization endpoint - A [refresh token](https://www.rfc-editor.org/rfc/
94
- # rfc6749#section-10.4) issued by this endpoint This endpoint is only meant to
95
- # be called by the Google Cloud CLI. Also note that this API only accepts the
96
- # authorization code issued for workforce pools.
97
- # @param [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenRequest] google_identity_sts_v1_exchange_oauth_token_request_object
98
- # @param [String] fields
99
- # Selector specifying which fields to include in a partial response.
100
- # @param [String] quota_user
101
- # Available to use for quota purposes for server-side applications. Can be any
102
- # arbitrary string assigned to a user, but should not exceed 40 characters.
103
- # @param [Google::Apis::RequestOptions] options
104
- # Request-specific options
105
- #
106
- # @yield [result, err] Result & error if block supplied
107
- # @yieldparam result [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenResponse] parsed result object
108
- # @yieldparam err [StandardError] error object if request failed
109
- #
110
- # @return [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenResponse]
111
- #
112
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
113
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
114
- # @raise [Google::Apis::AuthorizationError] Authorization is required
115
- def oauthtoken(google_identity_sts_v1_exchange_oauth_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
116
- command = make_simple_command(:post, 'v1/oauthtoken', options)
117
- command.request_representation = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenRequest::Representation
118
- command.request_object = google_identity_sts_v1_exchange_oauth_token_request_object
119
- command.response_representation = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenResponse::Representation
120
- command.response_class = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeOauthTokenResponse
121
- command.query['fields'] = fields unless fields.nil?
122
- command.query['quotaUser'] = quota_user unless quota_user.nil?
123
- execute_or_queue_command(command, &block)
124
- end
125
-
126
55
  # Exchanges a credential for a Google OAuth 2.0 access token. The token asserts
127
56
  # an external identity within an identity pool, or it applies a Credential
128
57
  # Access Boundary to a Google access token. Note that workforce pools do not
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-sts_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.33.0
4
+ version: 0.34.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-02-25 00:00:00.000000000 Z
11
+ date: 2024-03-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-sts_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-sts_v1/v0.33.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-sts_v1/v0.34.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-sts_v1
63
63
  post_install_message:
64
64
  rdoc_options: []