@aws-sdk/client-sso-oidc 3.137.0 → 3.145.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  import { __assign, __awaiter, __generator } from "tslib";
2
2
  import { HttpRequest as __HttpRequest } from "@aws-sdk/protocol-http";
3
- import { decorateServiceException as __decorateServiceException, expectInt32 as __expectInt32, expectLong as __expectLong, expectNonNull as __expectNonNull, expectObject as __expectObject, expectString as __expectString, } from "@aws-sdk/smithy-client";
3
+ import { decorateServiceException as __decorateServiceException, expectInt32 as __expectInt32, expectLong as __expectLong, expectNonNull as __expectNonNull, expectObject as __expectObject, expectString as __expectString, map as __map, throwDefaultError, } from "@aws-sdk/smithy-client";
4
4
  import { AccessDeniedException, AuthorizationPendingException, ExpiredTokenException, InternalServerException, InvalidClientException, InvalidClientMetadataException, InvalidGrantException, InvalidRequestException, InvalidScopeException, SlowDownException, UnauthorizedClientException, UnsupportedGrantTypeException, } from "../models/models_0";
5
5
  import { SSOOIDCServiceException as __BaseException } from "../models/SSOOIDCServiceException";
6
6
  export var serializeAws_restJson1CreateTokenCommand = function (input, context) { return __awaiter(void 0, void 0, void 0, function () {
@@ -83,40 +83,35 @@ export var deserializeAws_restJson1CreateTokenCommand = function (output, contex
83
83
  if (output.statusCode !== 200 && output.statusCode >= 300) {
84
84
  return [2, deserializeAws_restJson1CreateTokenCommandError(output, context)];
85
85
  }
86
- contents = {
86
+ contents = map({
87
87
  $metadata: deserializeMetadata(output),
88
- accessToken: undefined,
89
- expiresIn: undefined,
90
- idToken: undefined,
91
- refreshToken: undefined,
92
- tokenType: undefined,
93
- };
88
+ });
94
89
  _a = __expectNonNull;
95
90
  _b = __expectObject;
96
91
  return [4, parseBody(output.body, context)];
97
92
  case 1:
98
93
  data = _a.apply(void 0, [_b.apply(void 0, [_c.sent()]), "body"]);
99
- if (data.accessToken !== undefined && data.accessToken !== null) {
94
+ if (data.accessToken != null) {
100
95
  contents.accessToken = __expectString(data.accessToken);
101
96
  }
102
- if (data.expiresIn !== undefined && data.expiresIn !== null) {
97
+ if (data.expiresIn != null) {
103
98
  contents.expiresIn = __expectInt32(data.expiresIn);
104
99
  }
105
- if (data.idToken !== undefined && data.idToken !== null) {
100
+ if (data.idToken != null) {
106
101
  contents.idToken = __expectString(data.idToken);
107
102
  }
108
- if (data.refreshToken !== undefined && data.refreshToken !== null) {
103
+ if (data.refreshToken != null) {
109
104
  contents.refreshToken = __expectString(data.refreshToken);
110
105
  }
111
- if (data.tokenType !== undefined && data.tokenType !== null) {
106
+ if (data.tokenType != null) {
112
107
  contents.tokenType = __expectString(data.tokenType);
113
108
  }
114
- return [2, Promise.resolve(contents)];
109
+ return [2, contents];
115
110
  }
116
111
  });
117
112
  }); };
118
113
  var deserializeAws_restJson1CreateTokenCommandError = function (output, context) { return __awaiter(void 0, void 0, void 0, function () {
119
- var parsedOutput, _a, response, errorCode, _b, parsedBody, $metadata, statusCode;
114
+ var parsedOutput, _a, errorCode, _b, parsedBody;
120
115
  var _c;
121
116
  return __generator(this, function (_d) {
122
117
  switch (_d.label) {
@@ -177,14 +172,14 @@ var deserializeAws_restJson1CreateTokenCommandError = function (output, context)
177
172
  case 23: throw _d.sent();
178
173
  case 24:
179
174
  parsedBody = parsedOutput.body;
180
- $metadata = deserializeMetadata(output);
181
- statusCode = $metadata.httpStatusCode ? $metadata.httpStatusCode + "" : undefined;
182
- response = new __BaseException({
183
- name: parsedBody.code || parsedBody.Code || errorCode || statusCode || "UnknowError",
184
- $fault: "client",
185
- $metadata: $metadata,
175
+ throwDefaultError({
176
+ output: output,
177
+ parsedBody: parsedBody,
178
+ exceptionCtor: __BaseException,
179
+ errorCode: errorCode,
186
180
  });
187
- throw __decorateServiceException(response, parsedBody);
181
+ _d.label = 25;
182
+ case 25: return [2];
188
183
  }
189
184
  });
190
185
  }); };
@@ -196,44 +191,38 @@ export var deserializeAws_restJson1RegisterClientCommand = function (output, con
196
191
  if (output.statusCode !== 200 && output.statusCode >= 300) {
197
192
  return [2, deserializeAws_restJson1RegisterClientCommandError(output, context)];
198
193
  }
199
- contents = {
194
+ contents = map({
200
195
  $metadata: deserializeMetadata(output),
201
- authorizationEndpoint: undefined,
202
- clientId: undefined,
203
- clientIdIssuedAt: undefined,
204
- clientSecret: undefined,
205
- clientSecretExpiresAt: undefined,
206
- tokenEndpoint: undefined,
207
- };
196
+ });
208
197
  _a = __expectNonNull;
209
198
  _b = __expectObject;
210
199
  return [4, parseBody(output.body, context)];
211
200
  case 1:
212
201
  data = _a.apply(void 0, [_b.apply(void 0, [_c.sent()]), "body"]);
213
- if (data.authorizationEndpoint !== undefined && data.authorizationEndpoint !== null) {
202
+ if (data.authorizationEndpoint != null) {
214
203
  contents.authorizationEndpoint = __expectString(data.authorizationEndpoint);
215
204
  }
216
- if (data.clientId !== undefined && data.clientId !== null) {
205
+ if (data.clientId != null) {
217
206
  contents.clientId = __expectString(data.clientId);
218
207
  }
219
- if (data.clientIdIssuedAt !== undefined && data.clientIdIssuedAt !== null) {
208
+ if (data.clientIdIssuedAt != null) {
220
209
  contents.clientIdIssuedAt = __expectLong(data.clientIdIssuedAt);
221
210
  }
222
- if (data.clientSecret !== undefined && data.clientSecret !== null) {
211
+ if (data.clientSecret != null) {
223
212
  contents.clientSecret = __expectString(data.clientSecret);
224
213
  }
225
- if (data.clientSecretExpiresAt !== undefined && data.clientSecretExpiresAt !== null) {
214
+ if (data.clientSecretExpiresAt != null) {
226
215
  contents.clientSecretExpiresAt = __expectLong(data.clientSecretExpiresAt);
227
216
  }
228
- if (data.tokenEndpoint !== undefined && data.tokenEndpoint !== null) {
217
+ if (data.tokenEndpoint != null) {
229
218
  contents.tokenEndpoint = __expectString(data.tokenEndpoint);
230
219
  }
231
- return [2, Promise.resolve(contents)];
220
+ return [2, contents];
232
221
  }
233
222
  });
234
223
  }); };
235
224
  var deserializeAws_restJson1RegisterClientCommandError = function (output, context) { return __awaiter(void 0, void 0, void 0, function () {
236
- var parsedOutput, _a, response, errorCode, _b, parsedBody, $metadata, statusCode;
225
+ var parsedOutput, _a, errorCode, _b, parsedBody;
237
226
  var _c;
238
227
  return __generator(this, function (_d) {
239
228
  switch (_d.label) {
@@ -266,14 +255,14 @@ var deserializeAws_restJson1RegisterClientCommandError = function (output, conte
266
255
  case 9: throw _d.sent();
267
256
  case 10:
268
257
  parsedBody = parsedOutput.body;
269
- $metadata = deserializeMetadata(output);
270
- statusCode = $metadata.httpStatusCode ? $metadata.httpStatusCode + "" : undefined;
271
- response = new __BaseException({
272
- name: parsedBody.code || parsedBody.Code || errorCode || statusCode || "UnknowError",
273
- $fault: "client",
274
- $metadata: $metadata,
258
+ throwDefaultError({
259
+ output: output,
260
+ parsedBody: parsedBody,
261
+ exceptionCtor: __BaseException,
262
+ errorCode: errorCode,
275
263
  });
276
- throw __decorateServiceException(response, parsedBody);
264
+ _d.label = 11;
265
+ case 11: return [2];
277
266
  }
278
267
  });
279
268
  }); };
@@ -285,44 +274,38 @@ export var deserializeAws_restJson1StartDeviceAuthorizationCommand = function (o
285
274
  if (output.statusCode !== 200 && output.statusCode >= 300) {
286
275
  return [2, deserializeAws_restJson1StartDeviceAuthorizationCommandError(output, context)];
287
276
  }
288
- contents = {
277
+ contents = map({
289
278
  $metadata: deserializeMetadata(output),
290
- deviceCode: undefined,
291
- expiresIn: undefined,
292
- interval: undefined,
293
- userCode: undefined,
294
- verificationUri: undefined,
295
- verificationUriComplete: undefined,
296
- };
279
+ });
297
280
  _a = __expectNonNull;
298
281
  _b = __expectObject;
299
282
  return [4, parseBody(output.body, context)];
300
283
  case 1:
301
284
  data = _a.apply(void 0, [_b.apply(void 0, [_c.sent()]), "body"]);
302
- if (data.deviceCode !== undefined && data.deviceCode !== null) {
285
+ if (data.deviceCode != null) {
303
286
  contents.deviceCode = __expectString(data.deviceCode);
304
287
  }
305
- if (data.expiresIn !== undefined && data.expiresIn !== null) {
288
+ if (data.expiresIn != null) {
306
289
  contents.expiresIn = __expectInt32(data.expiresIn);
307
290
  }
308
- if (data.interval !== undefined && data.interval !== null) {
291
+ if (data.interval != null) {
309
292
  contents.interval = __expectInt32(data.interval);
310
293
  }
311
- if (data.userCode !== undefined && data.userCode !== null) {
294
+ if (data.userCode != null) {
312
295
  contents.userCode = __expectString(data.userCode);
313
296
  }
314
- if (data.verificationUri !== undefined && data.verificationUri !== null) {
297
+ if (data.verificationUri != null) {
315
298
  contents.verificationUri = __expectString(data.verificationUri);
316
299
  }
317
- if (data.verificationUriComplete !== undefined && data.verificationUriComplete !== null) {
300
+ if (data.verificationUriComplete != null) {
318
301
  contents.verificationUriComplete = __expectString(data.verificationUriComplete);
319
302
  }
320
- return [2, Promise.resolve(contents)];
303
+ return [2, contents];
321
304
  }
322
305
  });
323
306
  }); };
324
307
  var deserializeAws_restJson1StartDeviceAuthorizationCommandError = function (output, context) { return __awaiter(void 0, void 0, void 0, function () {
325
- var parsedOutput, _a, response, errorCode, _b, parsedBody, $metadata, statusCode;
308
+ var parsedOutput, _a, errorCode, _b, parsedBody;
326
309
  var _c;
327
310
  return __generator(this, function (_d) {
328
311
  switch (_d.label) {
@@ -359,26 +342,27 @@ var deserializeAws_restJson1StartDeviceAuthorizationCommandError = function (out
359
342
  case 11: throw _d.sent();
360
343
  case 12:
361
344
  parsedBody = parsedOutput.body;
362
- $metadata = deserializeMetadata(output);
363
- statusCode = $metadata.httpStatusCode ? $metadata.httpStatusCode + "" : undefined;
364
- response = new __BaseException({
365
- name: parsedBody.code || parsedBody.Code || errorCode || statusCode || "UnknowError",
366
- $fault: "client",
367
- $metadata: $metadata,
345
+ throwDefaultError({
346
+ output: output,
347
+ parsedBody: parsedBody,
348
+ exceptionCtor: __BaseException,
349
+ errorCode: errorCode,
368
350
  });
369
- throw __decorateServiceException(response, parsedBody);
351
+ _d.label = 13;
352
+ case 13: return [2];
370
353
  }
371
354
  });
372
355
  }); };
356
+ var map = __map;
373
357
  var deserializeAws_restJson1AccessDeniedExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
374
358
  var contents, data, exception;
375
359
  return __generator(this, function (_a) {
376
- contents = {};
360
+ contents = map({});
377
361
  data = parsedOutput.body;
378
- if (data.error !== undefined && data.error !== null) {
362
+ if (data.error != null) {
379
363
  contents.error = __expectString(data.error);
380
364
  }
381
- if (data.error_description !== undefined && data.error_description !== null) {
365
+ if (data.error_description != null) {
382
366
  contents.error_description = __expectString(data.error_description);
383
367
  }
384
368
  exception = new AccessDeniedException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -388,12 +372,12 @@ var deserializeAws_restJson1AccessDeniedExceptionResponse = function (parsedOutp
388
372
  var deserializeAws_restJson1AuthorizationPendingExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
389
373
  var contents, data, exception;
390
374
  return __generator(this, function (_a) {
391
- contents = {};
375
+ contents = map({});
392
376
  data = parsedOutput.body;
393
- if (data.error !== undefined && data.error !== null) {
377
+ if (data.error != null) {
394
378
  contents.error = __expectString(data.error);
395
379
  }
396
- if (data.error_description !== undefined && data.error_description !== null) {
380
+ if (data.error_description != null) {
397
381
  contents.error_description = __expectString(data.error_description);
398
382
  }
399
383
  exception = new AuthorizationPendingException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -403,12 +387,12 @@ var deserializeAws_restJson1AuthorizationPendingExceptionResponse = function (pa
403
387
  var deserializeAws_restJson1ExpiredTokenExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
404
388
  var contents, data, exception;
405
389
  return __generator(this, function (_a) {
406
- contents = {};
390
+ contents = map({});
407
391
  data = parsedOutput.body;
408
- if (data.error !== undefined && data.error !== null) {
392
+ if (data.error != null) {
409
393
  contents.error = __expectString(data.error);
410
394
  }
411
- if (data.error_description !== undefined && data.error_description !== null) {
395
+ if (data.error_description != null) {
412
396
  contents.error_description = __expectString(data.error_description);
413
397
  }
414
398
  exception = new ExpiredTokenException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -418,12 +402,12 @@ var deserializeAws_restJson1ExpiredTokenExceptionResponse = function (parsedOutp
418
402
  var deserializeAws_restJson1InternalServerExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
419
403
  var contents, data, exception;
420
404
  return __generator(this, function (_a) {
421
- contents = {};
405
+ contents = map({});
422
406
  data = parsedOutput.body;
423
- if (data.error !== undefined && data.error !== null) {
407
+ if (data.error != null) {
424
408
  contents.error = __expectString(data.error);
425
409
  }
426
- if (data.error_description !== undefined && data.error_description !== null) {
410
+ if (data.error_description != null) {
427
411
  contents.error_description = __expectString(data.error_description);
428
412
  }
429
413
  exception = new InternalServerException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -433,12 +417,12 @@ var deserializeAws_restJson1InternalServerExceptionResponse = function (parsedOu
433
417
  var deserializeAws_restJson1InvalidClientExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
434
418
  var contents, data, exception;
435
419
  return __generator(this, function (_a) {
436
- contents = {};
420
+ contents = map({});
437
421
  data = parsedOutput.body;
438
- if (data.error !== undefined && data.error !== null) {
422
+ if (data.error != null) {
439
423
  contents.error = __expectString(data.error);
440
424
  }
441
- if (data.error_description !== undefined && data.error_description !== null) {
425
+ if (data.error_description != null) {
442
426
  contents.error_description = __expectString(data.error_description);
443
427
  }
444
428
  exception = new InvalidClientException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -448,12 +432,12 @@ var deserializeAws_restJson1InvalidClientExceptionResponse = function (parsedOut
448
432
  var deserializeAws_restJson1InvalidClientMetadataExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
449
433
  var contents, data, exception;
450
434
  return __generator(this, function (_a) {
451
- contents = {};
435
+ contents = map({});
452
436
  data = parsedOutput.body;
453
- if (data.error !== undefined && data.error !== null) {
437
+ if (data.error != null) {
454
438
  contents.error = __expectString(data.error);
455
439
  }
456
- if (data.error_description !== undefined && data.error_description !== null) {
440
+ if (data.error_description != null) {
457
441
  contents.error_description = __expectString(data.error_description);
458
442
  }
459
443
  exception = new InvalidClientMetadataException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -463,12 +447,12 @@ var deserializeAws_restJson1InvalidClientMetadataExceptionResponse = function (p
463
447
  var deserializeAws_restJson1InvalidGrantExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
464
448
  var contents, data, exception;
465
449
  return __generator(this, function (_a) {
466
- contents = {};
450
+ contents = map({});
467
451
  data = parsedOutput.body;
468
- if (data.error !== undefined && data.error !== null) {
452
+ if (data.error != null) {
469
453
  contents.error = __expectString(data.error);
470
454
  }
471
- if (data.error_description !== undefined && data.error_description !== null) {
455
+ if (data.error_description != null) {
472
456
  contents.error_description = __expectString(data.error_description);
473
457
  }
474
458
  exception = new InvalidGrantException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -478,12 +462,12 @@ var deserializeAws_restJson1InvalidGrantExceptionResponse = function (parsedOutp
478
462
  var deserializeAws_restJson1InvalidRequestExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
479
463
  var contents, data, exception;
480
464
  return __generator(this, function (_a) {
481
- contents = {};
465
+ contents = map({});
482
466
  data = parsedOutput.body;
483
- if (data.error !== undefined && data.error !== null) {
467
+ if (data.error != null) {
484
468
  contents.error = __expectString(data.error);
485
469
  }
486
- if (data.error_description !== undefined && data.error_description !== null) {
470
+ if (data.error_description != null) {
487
471
  contents.error_description = __expectString(data.error_description);
488
472
  }
489
473
  exception = new InvalidRequestException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -493,12 +477,12 @@ var deserializeAws_restJson1InvalidRequestExceptionResponse = function (parsedOu
493
477
  var deserializeAws_restJson1InvalidScopeExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
494
478
  var contents, data, exception;
495
479
  return __generator(this, function (_a) {
496
- contents = {};
480
+ contents = map({});
497
481
  data = parsedOutput.body;
498
- if (data.error !== undefined && data.error !== null) {
482
+ if (data.error != null) {
499
483
  contents.error = __expectString(data.error);
500
484
  }
501
- if (data.error_description !== undefined && data.error_description !== null) {
485
+ if (data.error_description != null) {
502
486
  contents.error_description = __expectString(data.error_description);
503
487
  }
504
488
  exception = new InvalidScopeException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -508,12 +492,12 @@ var deserializeAws_restJson1InvalidScopeExceptionResponse = function (parsedOutp
508
492
  var deserializeAws_restJson1SlowDownExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
509
493
  var contents, data, exception;
510
494
  return __generator(this, function (_a) {
511
- contents = {};
495
+ contents = map({});
512
496
  data = parsedOutput.body;
513
- if (data.error !== undefined && data.error !== null) {
497
+ if (data.error != null) {
514
498
  contents.error = __expectString(data.error);
515
499
  }
516
- if (data.error_description !== undefined && data.error_description !== null) {
500
+ if (data.error_description != null) {
517
501
  contents.error_description = __expectString(data.error_description);
518
502
  }
519
503
  exception = new SlowDownException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -523,12 +507,12 @@ var deserializeAws_restJson1SlowDownExceptionResponse = function (parsedOutput,
523
507
  var deserializeAws_restJson1UnauthorizedClientExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
524
508
  var contents, data, exception;
525
509
  return __generator(this, function (_a) {
526
- contents = {};
510
+ contents = map({});
527
511
  data = parsedOutput.body;
528
- if (data.error !== undefined && data.error !== null) {
512
+ if (data.error != null) {
529
513
  contents.error = __expectString(data.error);
530
514
  }
531
- if (data.error_description !== undefined && data.error_description !== null) {
515
+ if (data.error_description != null) {
532
516
  contents.error_description = __expectString(data.error_description);
533
517
  }
534
518
  exception = new UnauthorizedClientException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -538,12 +522,12 @@ var deserializeAws_restJson1UnauthorizedClientExceptionResponse = function (pars
538
522
  var deserializeAws_restJson1UnsupportedGrantTypeExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
539
523
  var contents, data, exception;
540
524
  return __generator(this, function (_a) {
541
- contents = {};
525
+ contents = map({});
542
526
  data = parsedOutput.body;
543
- if (data.error !== undefined && data.error !== null) {
527
+ if (data.error != null) {
544
528
  contents.error = __expectString(data.error);
545
529
  }
546
- if (data.error_description !== undefined && data.error_description !== null) {
530
+ if (data.error_description != null) {
547
531
  contents.error_description = __expectString(data.error_description);
548
532
  }
549
533
  exception = new UnsupportedGrantTypeException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
@@ -554,9 +538,6 @@ var serializeAws_restJson1Scopes = function (input, context) {
554
538
  return input
555
539
  .filter(function (e) { return e != null; })
556
540
  .map(function (entry) {
557
- if (entry === null) {
558
- return null;
559
- }
560
541
  return entry;
561
542
  });
562
543
  };
@@ -4,43 +4,66 @@ import { RegisterClientCommandInput, RegisterClientCommandOutput } from "./comma
4
4
  import { StartDeviceAuthorizationCommandInput, StartDeviceAuthorizationCommandOutput } from "./commands/StartDeviceAuthorizationCommand";
5
5
  import { SSOOIDCClient } from "./SSOOIDCClient";
6
6
  /**
7
- * <p>AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client
8
- * (such as AWS CLI or a native application) to register with AWS SSO. The service also
9
- * enables the client to fetch the user’s access token upon successful authentication and
10
- * authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of
11
- * the device authorization grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>).</p>
12
- *
13
- * <p>For general information about AWS SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is AWS
14
- * Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p>
15
- *
16
- * <p>This API reference guide describes the AWS SSO OIDC operations that you can call
17
- * programatically and includes detailed information on data types and errors.</p>
18
- *
7
+ * <p>Amazon Web Services Single Sign On OpenID Connect (OIDC) is a web service that enables a client (such as Amazon Web Services CLI
8
+ * or a native application) to register with Amazon Web Services SSO. The service also enables the client to
9
+ * fetch the user’s access token upon successful authentication and authorization with
10
+ * Amazon Web Services SSO.</p>
19
11
  * <note>
20
- * <p>AWS provides SDKs that consist of libraries and sample code for various programming
21
- * languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a
22
- * convenient way to create programmatic access to AWS SSO and other AWS services. For more
23
- * information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
12
+ * <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
13
+ * <code>identitystore</code> API namespaces will continue to retain their original name for
14
+ * backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
24
15
  * </note>
16
+ * <p>
17
+ * <b>Considerations for Using This Guide</b>
18
+ * </p>
19
+ * <p>Before you begin using this guide, we recommend that you first review the following
20
+ * important information about how the Amazon Web Services SSO OIDC service works.</p>
21
+ * <ul>
22
+ * <li>
23
+ * <p>The Amazon Web Services SSO OIDC service currently implements only the portions of the OAuth 2.0
24
+ * Device Authorization Grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>) that are necessary to enable single
25
+ * sign-on authentication with the AWS CLI. Support for other OIDC flows frequently needed
26
+ * for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in
27
+ * future releases.</p>
28
+ * </li>
29
+ * <li>
30
+ * <p>The service emits only OIDC access tokens, such that obtaining a new token (For
31
+ * example, token refresh) requires explicit user re-authentication.</p>
32
+ * </li>
33
+ * <li>
34
+ * <p>The access tokens provided by this service grant access to all AWS account
35
+ * entitlements assigned to an Amazon Web Services SSO user, not just a particular application.</p>
36
+ * </li>
37
+ * <li>
38
+ * <p>The documentation in this guide does not describe the mechanism to convert the access
39
+ * token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service
40
+ * endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>Amazon Web Services SSO Portal API Reference
41
+ * Guide</i>.</p>
42
+ * </li>
43
+ * </ul>
44
+ *
45
+ * <p>For general information about Amazon Web Services SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is
46
+ * Amazon Web Services SSO?</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
25
47
  */
26
48
  export declare class SSOOIDC extends SSOOIDCClient {
27
49
  /**
28
50
  * <p>Creates and returns an access token for the authorized client. The access token issued
29
- * will be used to fetch short-term credentials for the assigned roles in the AWS
51
+ * will be used to fetch short-term credentials for the assigned roles in the Amazon Web Services
30
52
  * account.</p>
31
53
  */
32
54
  createToken(args: CreateTokenCommandInput, options?: __HttpHandlerOptions): Promise<CreateTokenCommandOutput>;
33
55
  createToken(args: CreateTokenCommandInput, cb: (err: any, data?: CreateTokenCommandOutput) => void): void;
34
56
  createToken(args: CreateTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTokenCommandOutput) => void): void;
35
57
  /**
36
- * <p>Registers a client with AWS SSO. This allows clients to initiate device authorization.
58
+ * <p>Registers a client with Amazon Web Services SSO. This allows clients to initiate device authorization.
37
59
  * The output should be persisted for reuse through many authentication requests.</p>
38
60
  */
39
61
  registerClient(args: RegisterClientCommandInput, options?: __HttpHandlerOptions): Promise<RegisterClientCommandOutput>;
40
62
  registerClient(args: RegisterClientCommandInput, cb: (err: any, data?: RegisterClientCommandOutput) => void): void;
41
63
  registerClient(args: RegisterClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterClientCommandOutput) => void): void;
42
64
  /**
43
- * <p>Initiates device authorization by requesting a pair of verification codes from the authorization service.</p>
65
+ * <p>Initiates device authorization by requesting a pair of verification codes from the
66
+ * authorization service.</p>
44
67
  */
45
68
  startDeviceAuthorization(args: StartDeviceAuthorizationCommandInput, options?: __HttpHandlerOptions): Promise<StartDeviceAuthorizationCommandOutput>;
46
69
  startDeviceAuthorization(args: StartDeviceAuthorizationCommandInput, cb: (err: any, data?: StartDeviceAuthorizationCommandOutput) => void): void;
@@ -123,24 +123,46 @@ declare type SSOOIDCClientResolvedConfigType = __SmithyResolvedConfiguration<__H
123
123
  export interface SSOOIDCClientResolvedConfig extends SSOOIDCClientResolvedConfigType {
124
124
  }
125
125
  /**
126
- * <p>AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client
127
- * (such as AWS CLI or a native application) to register with AWS SSO. The service also
128
- * enables the client to fetch the user’s access token upon successful authentication and
129
- * authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of
130
- * the device authorization grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>).</p>
131
- *
132
- * <p>For general information about AWS SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is AWS
133
- * Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p>
134
- *
135
- * <p>This API reference guide describes the AWS SSO OIDC operations that you can call
136
- * programatically and includes detailed information on data types and errors.</p>
137
- *
126
+ * <p>Amazon Web Services Single Sign On OpenID Connect (OIDC) is a web service that enables a client (such as Amazon Web Services CLI
127
+ * or a native application) to register with Amazon Web Services SSO. The service also enables the client to
128
+ * fetch the user’s access token upon successful authentication and authorization with
129
+ * Amazon Web Services SSO.</p>
138
130
  * <note>
139
- * <p>AWS provides SDKs that consist of libraries and sample code for various programming
140
- * languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a
141
- * convenient way to create programmatic access to AWS SSO and other AWS services. For more
142
- * information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
131
+ * <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
132
+ * <code>identitystore</code> API namespaces will continue to retain their original name for
133
+ * backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
143
134
  * </note>
135
+ * <p>
136
+ * <b>Considerations for Using This Guide</b>
137
+ * </p>
138
+ * <p>Before you begin using this guide, we recommend that you first review the following
139
+ * important information about how the Amazon Web Services SSO OIDC service works.</p>
140
+ * <ul>
141
+ * <li>
142
+ * <p>The Amazon Web Services SSO OIDC service currently implements only the portions of the OAuth 2.0
143
+ * Device Authorization Grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>) that are necessary to enable single
144
+ * sign-on authentication with the AWS CLI. Support for other OIDC flows frequently needed
145
+ * for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in
146
+ * future releases.</p>
147
+ * </li>
148
+ * <li>
149
+ * <p>The service emits only OIDC access tokens, such that obtaining a new token (For
150
+ * example, token refresh) requires explicit user re-authentication.</p>
151
+ * </li>
152
+ * <li>
153
+ * <p>The access tokens provided by this service grant access to all AWS account
154
+ * entitlements assigned to an Amazon Web Services SSO user, not just a particular application.</p>
155
+ * </li>
156
+ * <li>
157
+ * <p>The documentation in this guide does not describe the mechanism to convert the access
158
+ * token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service
159
+ * endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>Amazon Web Services SSO Portal API Reference
160
+ * Guide</i>.</p>
161
+ * </li>
162
+ * </ul>
163
+ *
164
+ * <p>For general information about Amazon Web Services SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is
165
+ * Amazon Web Services SSO?</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
144
166
  */
145
167
  export declare class SSOOIDCClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SSOOIDCClientResolvedConfig> {
146
168
  /**
@@ -8,7 +8,7 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat
8
8
  }
9
9
  /**
10
10
  * <p>Creates and returns an access token for the authorized client. The access token issued
11
- * will be used to fetch short-term credentials for the assigned roles in the AWS
11
+ * will be used to fetch short-term credentials for the assigned roles in the Amazon Web Services
12
12
  * account.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
@@ -7,7 +7,7 @@ export interface RegisterClientCommandInput extends RegisterClientRequest {
7
7
  export interface RegisterClientCommandOutput extends RegisterClientResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Registers a client with AWS SSO. This allows clients to initiate device authorization.
10
+ * <p>Registers a client with Amazon Web Services SSO. This allows clients to initiate device authorization.
11
11
  * The output should be persisted for reuse through many authentication requests.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
@@ -7,7 +7,8 @@ export interface StartDeviceAuthorizationCommandInput extends StartDeviceAuthori
7
7
  export interface StartDeviceAuthorizationCommandOutput extends StartDeviceAuthorizationResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Initiates device authorization by requesting a pair of verification codes from the authorization service.</p>
10
+ * <p>Initiates device authorization by requesting a pair of verification codes from the
11
+ * authorization service.</p>
11
12
  * @example
12
13
  * Use a bare-bones client and the command you need to make an API call.
13
14
  * ```javascript