aws-sdk-ssooidc 1.18.0 → 1.21.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,498 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # WARNING ABOUT GENERATED CODE
4
- #
5
- # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
- #
8
- # WARNING ABOUT GENERATED CODE
9
-
10
- module Aws::SSOOIDC
11
- module Types
12
-
13
- # You do not have sufficient access to perform this action.
14
- #
15
- # @!attribute [rw] error
16
- # @return [String]
17
- #
18
- # @!attribute [rw] error_description
19
- # @return [String]
20
- #
21
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/AccessDeniedException AWS API Documentation
22
- #
23
- class AccessDeniedException < Struct.new(
24
- :error,
25
- :error_description)
26
- SENSITIVE = []
27
- include Aws::Structure
28
- end
29
-
30
- # Indicates that a request to authorize a client with an access user
31
- # session token is pending.
32
- #
33
- # @!attribute [rw] error
34
- # @return [String]
35
- #
36
- # @!attribute [rw] error_description
37
- # @return [String]
38
- #
39
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/AuthorizationPendingException AWS API Documentation
40
- #
41
- class AuthorizationPendingException < Struct.new(
42
- :error,
43
- :error_description)
44
- SENSITIVE = []
45
- include Aws::Structure
46
- end
47
-
48
- # @note When making an API call, you may pass CreateTokenRequest
49
- # data as a hash:
50
- #
51
- # {
52
- # client_id: "ClientId", # required
53
- # client_secret: "ClientSecret", # required
54
- # grant_type: "GrantType", # required
55
- # device_code: "DeviceCode", # required
56
- # code: "AuthCode",
57
- # refresh_token: "RefreshToken",
58
- # scope: ["Scope"],
59
- # redirect_uri: "URI",
60
- # }
61
- #
62
- # @!attribute [rw] client_id
63
- # The unique identifier string for each client. This value should come
64
- # from the persisted result of the RegisterClient API.
65
- # @return [String]
66
- #
67
- # @!attribute [rw] client_secret
68
- # A secret string generated for the client. This value should come
69
- # from the persisted result of the RegisterClient API.
70
- # @return [String]
71
- #
72
- # @!attribute [rw] grant_type
73
- # Supports grant types for authorization code, refresh token, and
74
- # device code request.
75
- # @return [String]
76
- #
77
- # @!attribute [rw] device_code
78
- # Used only when calling this API for the device code grant type. This
79
- # short-term code is used to identify this authentication attempt.
80
- # This should come from an in-memory reference to the result of the
81
- # StartDeviceAuthorization API.
82
- # @return [String]
83
- #
84
- # @!attribute [rw] code
85
- # The authorization code received from the authorization service. This
86
- # parameter is required to perform an authorization grant request to
87
- # get access to a token.
88
- # @return [String]
89
- #
90
- # @!attribute [rw] refresh_token
91
- # The token used to obtain an access token in the event that the
92
- # access token is invalid or expired. This token is not issued by the
93
- # service.
94
- # @return [String]
95
- #
96
- # @!attribute [rw] scope
97
- # The list of scopes that is defined by the client. Upon
98
- # authorization, this list is used to restrict permissions when
99
- # granting an access token.
100
- # @return [Array<String>]
101
- #
102
- # @!attribute [rw] redirect_uri
103
- # The location of the application that will receive the authorization
104
- # code. Users authorize the service to send the request to this
105
- # location.
106
- # @return [String]
107
- #
108
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenRequest AWS API Documentation
109
- #
110
- class CreateTokenRequest < Struct.new(
111
- :client_id,
112
- :client_secret,
113
- :grant_type,
114
- :device_code,
115
- :code,
116
- :refresh_token,
117
- :scope,
118
- :redirect_uri)
119
- SENSITIVE = []
120
- include Aws::Structure
121
- end
122
-
123
- # @!attribute [rw] access_token
124
- # An opaque token to access AWS SSO resources assigned to a user.
125
- # @return [String]
126
- #
127
- # @!attribute [rw] token_type
128
- # Used to notify the client that the returned token is an access
129
- # token. The supported type is `BearerToken`.
130
- # @return [String]
131
- #
132
- # @!attribute [rw] expires_in
133
- # Indicates the time in seconds when an access token will expire.
134
- # @return [Integer]
135
- #
136
- # @!attribute [rw] refresh_token
137
- # A token that, if present, can be used to refresh a previously issued
138
- # access token that might have expired.
139
- # @return [String]
140
- #
141
- # @!attribute [rw] id_token
142
- # The identifier of the user that associated with the access token, if
143
- # present.
144
- # @return [String]
145
- #
146
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenResponse AWS API Documentation
147
- #
148
- class CreateTokenResponse < Struct.new(
149
- :access_token,
150
- :token_type,
151
- :expires_in,
152
- :refresh_token,
153
- :id_token)
154
- SENSITIVE = []
155
- include Aws::Structure
156
- end
157
-
158
- # Indicates that the token issued by the service is expired and is no
159
- # longer valid.
160
- #
161
- # @!attribute [rw] error
162
- # @return [String]
163
- #
164
- # @!attribute [rw] error_description
165
- # @return [String]
166
- #
167
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/ExpiredTokenException AWS API Documentation
168
- #
169
- class ExpiredTokenException < Struct.new(
170
- :error,
171
- :error_description)
172
- SENSITIVE = []
173
- include Aws::Structure
174
- end
175
-
176
- # Indicates that an error from the service occurred while trying to
177
- # process a request.
178
- #
179
- # @!attribute [rw] error
180
- # @return [String]
181
- #
182
- # @!attribute [rw] error_description
183
- # @return [String]
184
- #
185
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InternalServerException AWS API Documentation
186
- #
187
- class InternalServerException < Struct.new(
188
- :error,
189
- :error_description)
190
- SENSITIVE = []
191
- include Aws::Structure
192
- end
193
-
194
- # Indicates that the `clientId` or `clientSecret` in the request is
195
- # invalid. For example, this can occur when a client sends an incorrect
196
- # `clientId` or an expired `clientSecret`.
197
- #
198
- # @!attribute [rw] error
199
- # @return [String]
200
- #
201
- # @!attribute [rw] error_description
202
- # @return [String]
203
- #
204
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidClientException AWS API Documentation
205
- #
206
- class InvalidClientException < Struct.new(
207
- :error,
208
- :error_description)
209
- SENSITIVE = []
210
- include Aws::Structure
211
- end
212
-
213
- # Indicates that the client information sent in the request during
214
- # registration is invalid.
215
- #
216
- # @!attribute [rw] error
217
- # @return [String]
218
- #
219
- # @!attribute [rw] error_description
220
- # @return [String]
221
- #
222
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidClientMetadataException AWS API Documentation
223
- #
224
- class InvalidClientMetadataException < Struct.new(
225
- :error,
226
- :error_description)
227
- SENSITIVE = []
228
- include Aws::Structure
229
- end
230
-
231
- # Indicates that a request contains an invalid grant. This can occur if
232
- # a client makes a CreateToken request with an invalid grant type.
233
- #
234
- # @!attribute [rw] error
235
- # @return [String]
236
- #
237
- # @!attribute [rw] error_description
238
- # @return [String]
239
- #
240
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidGrantException AWS API Documentation
241
- #
242
- class InvalidGrantException < Struct.new(
243
- :error,
244
- :error_description)
245
- SENSITIVE = []
246
- include Aws::Structure
247
- end
248
-
249
- # Indicates that something is wrong with the input to the request. For
250
- # example, a required parameter might be missing or out of range.
251
- #
252
- # @!attribute [rw] error
253
- # @return [String]
254
- #
255
- # @!attribute [rw] error_description
256
- # @return [String]
257
- #
258
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidRequestException AWS API Documentation
259
- #
260
- class InvalidRequestException < Struct.new(
261
- :error,
262
- :error_description)
263
- SENSITIVE = []
264
- include Aws::Structure
265
- end
266
-
267
- # Indicates that the scope provided in the request is invalid.
268
- #
269
- # @!attribute [rw] error
270
- # @return [String]
271
- #
272
- # @!attribute [rw] error_description
273
- # @return [String]
274
- #
275
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidScopeException AWS API Documentation
276
- #
277
- class InvalidScopeException < Struct.new(
278
- :error,
279
- :error_description)
280
- SENSITIVE = []
281
- include Aws::Structure
282
- end
283
-
284
- # @note When making an API call, you may pass RegisterClientRequest
285
- # data as a hash:
286
- #
287
- # {
288
- # client_name: "ClientName", # required
289
- # client_type: "ClientType", # required
290
- # scopes: ["Scope"],
291
- # }
292
- #
293
- # @!attribute [rw] client_name
294
- # The friendly name of the client.
295
- # @return [String]
296
- #
297
- # @!attribute [rw] client_type
298
- # The type of client. The service supports only `public` as a client
299
- # type. Anything other than public will be rejected by the service.
300
- # @return [String]
301
- #
302
- # @!attribute [rw] scopes
303
- # The list of scopes that are defined by the client. Upon
304
- # authorization, this list is used to restrict permissions when
305
- # granting an access token.
306
- # @return [Array<String>]
307
- #
308
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClientRequest AWS API Documentation
309
- #
310
- class RegisterClientRequest < Struct.new(
311
- :client_name,
312
- :client_type,
313
- :scopes)
314
- SENSITIVE = []
315
- include Aws::Structure
316
- end
317
-
318
- # @!attribute [rw] client_id
319
- # The unique identifier string for each client. This client uses this
320
- # identifier to get authenticated by the service in subsequent calls.
321
- # @return [String]
322
- #
323
- # @!attribute [rw] client_secret
324
- # A secret string generated for the client. The client will use this
325
- # string to get authenticated by the service in subsequent calls.
326
- # @return [String]
327
- #
328
- # @!attribute [rw] client_id_issued_at
329
- # Indicates the time at which the `clientId` and `clientSecret` were
330
- # issued.
331
- # @return [Integer]
332
- #
333
- # @!attribute [rw] client_secret_expires_at
334
- # Indicates the time at which the `clientId` and `clientSecret` will
335
- # become invalid.
336
- # @return [Integer]
337
- #
338
- # @!attribute [rw] authorization_endpoint
339
- # The endpoint where the client can request authorization.
340
- # @return [String]
341
- #
342
- # @!attribute [rw] token_endpoint
343
- # The endpoint where the client can get an access token.
344
- # @return [String]
345
- #
346
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClientResponse AWS API Documentation
347
- #
348
- class RegisterClientResponse < Struct.new(
349
- :client_id,
350
- :client_secret,
351
- :client_id_issued_at,
352
- :client_secret_expires_at,
353
- :authorization_endpoint,
354
- :token_endpoint)
355
- SENSITIVE = []
356
- include Aws::Structure
357
- end
358
-
359
- # Indicates that the client is making the request too frequently and is
360
- # more than the service can handle.
361
- #
362
- # @!attribute [rw] error
363
- # @return [String]
364
- #
365
- # @!attribute [rw] error_description
366
- # @return [String]
367
- #
368
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/SlowDownException AWS API Documentation
369
- #
370
- class SlowDownException < Struct.new(
371
- :error,
372
- :error_description)
373
- SENSITIVE = []
374
- include Aws::Structure
375
- end
376
-
377
- # @note When making an API call, you may pass StartDeviceAuthorizationRequest
378
- # data as a hash:
379
- #
380
- # {
381
- # client_id: "ClientId", # required
382
- # client_secret: "ClientSecret", # required
383
- # start_url: "URI", # required
384
- # }
385
- #
386
- # @!attribute [rw] client_id
387
- # The unique identifier string for the client that is registered with
388
- # AWS SSO. This value should come from the persisted result of the
389
- # RegisterClient API operation.
390
- # @return [String]
391
- #
392
- # @!attribute [rw] client_secret
393
- # A secret string that is generated for the client. This value should
394
- # come from the persisted result of the RegisterClient API operation.
395
- # @return [String]
396
- #
397
- # @!attribute [rw] start_url
398
- # The URL for the AWS SSO user portal. For more information, see
399
- # [Using the User Portal][1] in the *AWS Single Sign-On User Guide*.
400
- #
401
- #
402
- #
403
- # [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html
404
- # @return [String]
405
- #
406
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorizationRequest AWS API Documentation
407
- #
408
- class StartDeviceAuthorizationRequest < Struct.new(
409
- :client_id,
410
- :client_secret,
411
- :start_url)
412
- SENSITIVE = []
413
- include Aws::Structure
414
- end
415
-
416
- # @!attribute [rw] device_code
417
- # The short-lived code that is used by the device when polling for a
418
- # session token.
419
- # @return [String]
420
- #
421
- # @!attribute [rw] user_code
422
- # A one-time user verification code. This is needed to authorize an
423
- # in-use device.
424
- # @return [String]
425
- #
426
- # @!attribute [rw] verification_uri
427
- # The URI of the verification page that takes the `userCode` to
428
- # authorize the device.
429
- # @return [String]
430
- #
431
- # @!attribute [rw] verification_uri_complete
432
- # An alternate URL that the client can use to automatically launch a
433
- # browser. This process skips the manual step in which the user visits
434
- # the verification page and enters their code.
435
- # @return [String]
436
- #
437
- # @!attribute [rw] expires_in
438
- # Indicates the number of seconds in which the verification code will
439
- # become invalid.
440
- # @return [Integer]
441
- #
442
- # @!attribute [rw] interval
443
- # Indicates the number of seconds the client must wait between
444
- # attempts when polling for a session.
445
- # @return [Integer]
446
- #
447
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorizationResponse AWS API Documentation
448
- #
449
- class StartDeviceAuthorizationResponse < Struct.new(
450
- :device_code,
451
- :user_code,
452
- :verification_uri,
453
- :verification_uri_complete,
454
- :expires_in,
455
- :interval)
456
- SENSITIVE = []
457
- include Aws::Structure
458
- end
459
-
460
- # Indicates that the client is not currently authorized to make the
461
- # request. This can happen when a `clientId` is not issued for a public
462
- # client.
463
- #
464
- # @!attribute [rw] error
465
- # @return [String]
466
- #
467
- # @!attribute [rw] error_description
468
- # @return [String]
469
- #
470
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/UnauthorizedClientException AWS API Documentation
471
- #
472
- class UnauthorizedClientException < Struct.new(
473
- :error,
474
- :error_description)
475
- SENSITIVE = []
476
- include Aws::Structure
477
- end
478
-
479
- # Indicates that the grant type in the request is not supported by the
480
- # service.
481
- #
482
- # @!attribute [rw] error
483
- # @return [String]
484
- #
485
- # @!attribute [rw] error_description
486
- # @return [String]
487
- #
488
- # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/UnsupportedGrantTypeException AWS API Documentation
489
- #
490
- class UnsupportedGrantTypeException < Struct.new(
491
- :error,
492
- :error_description)
493
- SENSITIVE = []
494
- include Aws::Structure
495
- end
496
-
497
- end
498
- end