File: classes.rb

package info (click to toggle)
ruby-google-apis-iamcredentials-v1 0.16.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 132 kB
  • sloc: ruby: 293; makefile: 4
file content (302 lines) | stat: -rw-r--r-- 12,876 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# Copyright 2020 Google LLC
#
# 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 IamcredentialsV1
      
      # 
      class GenerateAccessTokenRequest
        include Google::Apis::Core::Hashable
      
        # The sequence of service accounts in a delegation chain. This field is required
        # for [delegated requests](https://cloud.google.com/iam/help/credentials/
        # delegated-request). For [direct requests](https://cloud.google.com/iam/help/
        # credentials/direct-request), which are more common, do not specify this field.
        # Each service account must be granted the `roles/iam.serviceAccountTokenCreator`
        # role on its next service account in the chain. The last service account in
        # the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on
        # the service account that is specified in the `name` field of the request. The
        # delegates must have the following format: `projects/-/serviceAccounts/`
        # ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard character is required; replacing
        # it with a project ID is invalid.
        # Corresponds to the JSON property `delegates`
        # @return [Array<String>]
        attr_accessor :delegates
      
        # The desired lifetime duration of the access token in seconds. By default, the
        # maximum allowed value is 1 hour. To set a lifetime of up to 12 hours, you can
        # add the service account as an allowed value in an Organization Policy that
        # enforces the `constraints/iam.allowServiceAccountCredentialLifetimeExtension`
        # constraint. See detailed instructions at https://cloud.google.com/iam/help/
        # credentials/lifetime If a value is not specified, the token's lifetime will be
        # set to a default value of 1 hour.
        # Corresponds to the JSON property `lifetime`
        # @return [String]
        attr_accessor :lifetime
      
        # Required. Code to identify the scopes to be included in the OAuth 2.0 access
        # token. See https://developers.google.com/identity/protocols/googlescopes for
        # more information. At least one value required.
        # Corresponds to the JSON property `scope`
        # @return [Array<String>]
        attr_accessor :scope
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @delegates = args[:delegates] if args.key?(:delegates)
          @lifetime = args[:lifetime] if args.key?(:lifetime)
          @scope = args[:scope] if args.key?(:scope)
        end
      end
      
      # 
      class GenerateAccessTokenResponse
        include Google::Apis::Core::Hashable
      
        # The OAuth 2.0 access token.
        # Corresponds to the JSON property `accessToken`
        # @return [String]
        attr_accessor :access_token
      
        # Token expiration time. The expiration time is always set.
        # Corresponds to the JSON property `expireTime`
        # @return [String]
        attr_accessor :expire_time
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @access_token = args[:access_token] if args.key?(:access_token)
          @expire_time = args[:expire_time] if args.key?(:expire_time)
        end
      end
      
      # 
      class GenerateIdTokenRequest
        include Google::Apis::Core::Hashable
      
        # Required. The audience for the token, such as the API or account that this
        # token grants access to.
        # Corresponds to the JSON property `audience`
        # @return [String]
        attr_accessor :audience
      
        # The sequence of service accounts in a delegation chain. Each service account
        # must be granted the `roles/iam.serviceAccountTokenCreator` role on its next
        # service account in the chain. The last service account in the chain must be
        # granted the `roles/iam.serviceAccountTokenCreator` role on the service account
        # that is specified in the `name` field of the request. The delegates must have
        # the following format: `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``.
        # The `-` wildcard character is required; replacing it with a project ID is
        # invalid.
        # Corresponds to the JSON property `delegates`
        # @return [Array<String>]
        attr_accessor :delegates
      
        # Include the service account email in the token. If set to `true`, the token
        # will contain `email` and `email_verified` claims.
        # Corresponds to the JSON property `includeEmail`
        # @return [Boolean]
        attr_accessor :include_email
        alias_method :include_email?, :include_email
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @audience = args[:audience] if args.key?(:audience)
          @delegates = args[:delegates] if args.key?(:delegates)
          @include_email = args[:include_email] if args.key?(:include_email)
        end
      end
      
      # 
      class GenerateIdTokenResponse
        include Google::Apis::Core::Hashable
      
        # The OpenId Connect ID token.
        # Corresponds to the JSON property `token`
        # @return [String]
        attr_accessor :token
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @token = args[:token] if args.key?(:token)
        end
      end
      
      # 
      class SignBlobRequest
        include Google::Apis::Core::Hashable
      
        # The sequence of service accounts in a delegation chain. Each service account
        # must be granted the `roles/iam.serviceAccountTokenCreator` role on its next
        # service account in the chain. The last service account in the chain must be
        # granted the `roles/iam.serviceAccountTokenCreator` role on the service account
        # that is specified in the `name` field of the request. The delegates must have
        # the following format: `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``.
        # The `-` wildcard character is required; replacing it with a project ID is
        # invalid.
        # Corresponds to the JSON property `delegates`
        # @return [Array<String>]
        attr_accessor :delegates
      
        # Required. The bytes to sign.
        # Corresponds to the JSON property `payload`
        # NOTE: Values are automatically base64 encoded/decoded in the client library.
        # @return [String]
        attr_accessor :payload
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @delegates = args[:delegates] if args.key?(:delegates)
          @payload = args[:payload] if args.key?(:payload)
        end
      end
      
      # 
      class SignBlobResponse
        include Google::Apis::Core::Hashable
      
        # The ID of the key used to sign the blob. The key used for signing will remain
        # valid for at least 12 hours after the blob is signed. To verify the signature,
        # you can retrieve the public key in several formats from the following
        # endpoints: - RSA public key wrapped in an X.509 v3 certificate: `https://www.
        # googleapis.com/service_accounts/v1/metadata/x509/`ACCOUNT_EMAIL`` - Raw key in
        # JSON format: `https://www.googleapis.com/service_accounts/v1/metadata/raw/`
        # ACCOUNT_EMAIL`` - JSON Web Key (JWK): `https://www.googleapis.com/
        # service_accounts/v1/metadata/jwk/`ACCOUNT_EMAIL``
        # Corresponds to the JSON property `keyId`
        # @return [String]
        attr_accessor :key_id
      
        # The signature for the blob. Does not include the original blob. After the key
        # pair referenced by the `key_id` response field expires, Google no longer
        # exposes the public key that can be used to verify the blob. As a result, the
        # receiver can no longer verify the signature.
        # Corresponds to the JSON property `signedBlob`
        # NOTE: Values are automatically base64 encoded/decoded in the client library.
        # @return [String]
        attr_accessor :signed_blob
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @key_id = args[:key_id] if args.key?(:key_id)
          @signed_blob = args[:signed_blob] if args.key?(:signed_blob)
        end
      end
      
      # 
      class SignJwtRequest
        include Google::Apis::Core::Hashable
      
        # The sequence of service accounts in a delegation chain. Each service account
        # must be granted the `roles/iam.serviceAccountTokenCreator` role on its next
        # service account in the chain. The last service account in the chain must be
        # granted the `roles/iam.serviceAccountTokenCreator` role on the service account
        # that is specified in the `name` field of the request. The delegates must have
        # the following format: `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``.
        # The `-` wildcard character is required; replacing it with a project ID is
        # invalid.
        # Corresponds to the JSON property `delegates`
        # @return [Array<String>]
        attr_accessor :delegates
      
        # Required. The JWT payload to sign. Must be a serialized JSON object that
        # contains a JWT Claims Set. For example: ``"sub": "user@example.com", "iat":
        # 313435`` If the JWT Claims Set contains an expiration time (`exp`) claim, it
        # must be an integer timestamp that is not in the past and no more than 12 hours
        # in the future.
        # Corresponds to the JSON property `payload`
        # @return [String]
        attr_accessor :payload
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @delegates = args[:delegates] if args.key?(:delegates)
          @payload = args[:payload] if args.key?(:payload)
        end
      end
      
      # 
      class SignJwtResponse
        include Google::Apis::Core::Hashable
      
        # The ID of the key used to sign the JWT. The key used for signing will remain
        # valid for at least 12 hours after the JWT is signed. To verify the signature,
        # you can retrieve the public key in several formats from the following
        # endpoints: - RSA public key wrapped in an X.509 v3 certificate: `https://www.
        # googleapis.com/service_accounts/v1/metadata/x509/`ACCOUNT_EMAIL`` - Raw key in
        # JSON format: `https://www.googleapis.com/service_accounts/v1/metadata/raw/`
        # ACCOUNT_EMAIL`` - JSON Web Key (JWK): `https://www.googleapis.com/
        # service_accounts/v1/metadata/jwk/`ACCOUNT_EMAIL``
        # Corresponds to the JSON property `keyId`
        # @return [String]
        attr_accessor :key_id
      
        # The signed JWT. Contains the automatically generated header; the client-
        # supplied payload; and the signature, which is generated using the key
        # referenced by the `kid` field in the header. After the key pair referenced by
        # the `key_id` response field expires, Google no longer exposes the public key
        # that can be used to verify the JWT. As a result, the receiver can no longer
        # verify the signature.
        # Corresponds to the JSON property `signedJwt`
        # @return [String]
        attr_accessor :signed_jwt
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @key_id = args[:key_id] if args.key?(:key_id)
          @signed_jwt = args[:signed_jwt] if args.key?(:signed_jwt)
        end
      end
    end
  end
end