@aws-sdk/client-cognito-identity-provider 3.100.0 → 3.109.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.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,36 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.109.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.108.1...v3.109.0) (2022-06-13)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-cognito-identity-provider
9
+
10
+
11
+
12
+
13
+
14
+ # [3.105.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.104.0...v3.105.0) (2022-06-06)
15
+
16
+
17
+ ### Features
18
+
19
+ * **clients:** support recursion detection in Lambda ([#3654](https://github.com/aws/aws-sdk-js-v3/issues/3654)) ([ecfe46e](https://github.com/aws/aws-sdk-js-v3/commit/ecfe46ea1fd8b6e3812b75b3dc6c03554fb4b3fa))
20
+
21
+
22
+
23
+
24
+
25
+ # [3.102.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.101.0...v3.102.0) (2022-05-31)
26
+
27
+
28
+ ### Features
29
+
30
+ * **client-cognito-identity-provider:** Amazon Cognito now supports IP Address propagation for all unauthenticated APIs (e.g. SignUp, ForgotPassword). ([d285512](https://github.com/aws/aws-sdk-js-v3/commit/d28551296728adfae6dfbf6d0ea8d6c903f4a059))
31
+
32
+
33
+
34
+
35
+
6
36
  # [3.100.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.99.0...v3.100.0) (2022-05-26)
7
37
 
8
38
  **Note:** Version bump only for package @aws-sdk/client-cognito-identity-provider
@@ -5,6 +5,7 @@ const config_resolver_1 = require("@aws-sdk/config-resolver");
5
5
  const middleware_content_length_1 = require("@aws-sdk/middleware-content-length");
6
6
  const middleware_host_header_1 = require("@aws-sdk/middleware-host-header");
7
7
  const middleware_logger_1 = require("@aws-sdk/middleware-logger");
8
+ const middleware_recursion_detection_1 = require("@aws-sdk/middleware-recursion-detection");
8
9
  const middleware_retry_1 = require("@aws-sdk/middleware-retry");
9
10
  const middleware_signing_1 = require("@aws-sdk/middleware-signing");
10
11
  const middleware_user_agent_1 = require("@aws-sdk/middleware-user-agent");
@@ -25,6 +26,7 @@ class CognitoIdentityProviderClient extends smithy_client_1.Client {
25
26
  this.middlewareStack.use((0, middleware_content_length_1.getContentLengthPlugin)(this.config));
26
27
  this.middlewareStack.use((0, middleware_host_header_1.getHostHeaderPlugin)(this.config));
27
28
  this.middlewareStack.use((0, middleware_logger_1.getLoggerPlugin)(this.config));
29
+ this.middlewareStack.use((0, middleware_recursion_detection_1.getRecursionDetectionPlugin)(this.config));
28
30
  this.middlewareStack.use((0, middleware_user_agent_1.getUserAgentPlugin)(this.config));
29
31
  }
30
32
  destroy() {
@@ -7641,6 +7641,10 @@ const serializeAws_json1_1CreateUserPoolClientRequest = (input, context) => {
7641
7641
  ...(input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName }),
7642
7642
  ...(input.DefaultRedirectURI !== undefined &&
7643
7643
  input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI }),
7644
+ ...(input.EnablePropagateAdditionalUserContextData !== undefined &&
7645
+ input.EnablePropagateAdditionalUserContextData !== null && {
7646
+ EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
7647
+ }),
7644
7648
  ...(input.EnableTokenRevocation !== undefined &&
7645
7649
  input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation }),
7646
7650
  ...(input.ExplicitAuthFlows !== undefined &&
@@ -8706,6 +8710,10 @@ const serializeAws_json1_1UpdateUserPoolClientRequest = (input, context) => {
8706
8710
  ...(input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName }),
8707
8711
  ...(input.DefaultRedirectURI !== undefined &&
8708
8712
  input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI }),
8713
+ ...(input.EnablePropagateAdditionalUserContextData !== undefined &&
8714
+ input.EnablePropagateAdditionalUserContextData !== null && {
8715
+ EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
8716
+ }),
8709
8717
  ...(input.EnableTokenRevocation !== undefined &&
8710
8718
  input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation }),
8711
8719
  ...(input.ExplicitAuthFlows !== undefined &&
@@ -8821,6 +8829,7 @@ const serializeAws_json1_1UserAttributeUpdateSettingsType = (input, context) =>
8821
8829
  const serializeAws_json1_1UserContextDataType = (input, context) => {
8822
8830
  return {
8823
8831
  ...(input.EncodedData !== undefined && input.EncodedData !== null && { EncodedData: input.EncodedData }),
8832
+ ...(input.IpAddress !== undefined && input.IpAddress !== null && { IpAddress: input.IpAddress }),
8824
8833
  };
8825
8834
  };
8826
8835
  const serializeAws_json1_1UsernameAttributesListType = (input, context) => {
@@ -10551,6 +10560,7 @@ const deserializeAws_json1_1UserPoolClientType = (output, context) => {
10551
10560
  ? (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(output.CreationDate)))
10552
10561
  : undefined,
10553
10562
  DefaultRedirectURI: (0, smithy_client_1.expectString)(output.DefaultRedirectURI),
10563
+ EnablePropagateAdditionalUserContextData: (0, smithy_client_1.expectBoolean)(output.EnablePropagateAdditionalUserContextData),
10554
10564
  EnableTokenRevocation: (0, smithy_client_1.expectBoolean)(output.EnableTokenRevocation),
10555
10565
  ExplicitAuthFlows: output.ExplicitAuthFlows !== undefined && output.ExplicitAuthFlows !== null
10556
10566
  ? deserializeAws_json1_1ExplicitAuthFlowsListType(output.ExplicitAuthFlows, context)
@@ -3,6 +3,7 @@ import { resolveEndpointsConfig, resolveRegionConfig, } from "@aws-sdk/config-re
3
3
  import { getContentLengthPlugin } from "@aws-sdk/middleware-content-length";
4
4
  import { getHostHeaderPlugin, resolveHostHeaderConfig, } from "@aws-sdk/middleware-host-header";
5
5
  import { getLoggerPlugin } from "@aws-sdk/middleware-logger";
6
+ import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection";
6
7
  import { getRetryPlugin, resolveRetryConfig } from "@aws-sdk/middleware-retry";
7
8
  import { resolveAwsAuthConfig } from "@aws-sdk/middleware-signing";
8
9
  import { getUserAgentPlugin, resolveUserAgentConfig, } from "@aws-sdk/middleware-user-agent";
@@ -25,6 +26,7 @@ var CognitoIdentityProviderClient = (function (_super) {
25
26
  _this.middlewareStack.use(getContentLengthPlugin(_this.config));
26
27
  _this.middlewareStack.use(getHostHeaderPlugin(_this.config));
27
28
  _this.middlewareStack.use(getLoggerPlugin(_this.config));
29
+ _this.middlewareStack.use(getRecursionDetectionPlugin(_this.config));
28
30
  _this.middlewareStack.use(getUserAgentPlugin(_this.config));
29
31
  return _this;
30
32
  }
@@ -9615,7 +9615,7 @@ var serializeAws_json1_1CreateUserImportJobRequest = function (input, context) {
9615
9615
  input.CloudWatchLogsRoleArn !== null && { CloudWatchLogsRoleArn: input.CloudWatchLogsRoleArn })), (input.JobName !== undefined && input.JobName !== null && { JobName: input.JobName })), (input.UserPoolId !== undefined && input.UserPoolId !== null && { UserPoolId: input.UserPoolId }));
9616
9616
  };
9617
9617
  var serializeAws_json1_1CreateUserPoolClientRequest = function (input, context) {
9618
- return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.AccessTokenValidity !== undefined &&
9618
+ return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.AccessTokenValidity !== undefined &&
9619
9619
  input.AccessTokenValidity !== null && { AccessTokenValidity: input.AccessTokenValidity })), (input.AllowedOAuthFlows !== undefined &&
9620
9620
  input.AllowedOAuthFlows !== null && {
9621
9621
  AllowedOAuthFlows: serializeAws_json1_1OAuthFlowsType(input.AllowedOAuthFlows, context),
@@ -9632,7 +9632,10 @@ var serializeAws_json1_1CreateUserPoolClientRequest = function (input, context)
9632
9632
  input.CallbackURLs !== null && {
9633
9633
  CallbackURLs: serializeAws_json1_1CallbackURLsListType(input.CallbackURLs, context),
9634
9634
  })), (input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName })), (input.DefaultRedirectURI !== undefined &&
9635
- input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnableTokenRevocation !== undefined &&
9635
+ input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnablePropagateAdditionalUserContextData !== undefined &&
9636
+ input.EnablePropagateAdditionalUserContextData !== null && {
9637
+ EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
9638
+ })), (input.EnableTokenRevocation !== undefined &&
9636
9639
  input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation })), (input.ExplicitAuthFlows !== undefined &&
9637
9640
  input.ExplicitAuthFlows !== null && {
9638
9641
  ExplicitAuthFlows: serializeAws_json1_1ExplicitAuthFlowsListType(input.ExplicitAuthFlows, context),
@@ -10303,7 +10306,7 @@ var serializeAws_json1_1UpdateUserAttributesRequest = function (input, context)
10303
10306
  }));
10304
10307
  };
10305
10308
  var serializeAws_json1_1UpdateUserPoolClientRequest = function (input, context) {
10306
- return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.AccessTokenValidity !== undefined &&
10309
+ return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.AccessTokenValidity !== undefined &&
10307
10310
  input.AccessTokenValidity !== null && { AccessTokenValidity: input.AccessTokenValidity })), (input.AllowedOAuthFlows !== undefined &&
10308
10311
  input.AllowedOAuthFlows !== null && {
10309
10312
  AllowedOAuthFlows: serializeAws_json1_1OAuthFlowsType(input.AllowedOAuthFlows, context),
@@ -10320,7 +10323,10 @@ var serializeAws_json1_1UpdateUserPoolClientRequest = function (input, context)
10320
10323
  input.CallbackURLs !== null && {
10321
10324
  CallbackURLs: serializeAws_json1_1CallbackURLsListType(input.CallbackURLs, context),
10322
10325
  })), (input.ClientId !== undefined && input.ClientId !== null && { ClientId: input.ClientId })), (input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName })), (input.DefaultRedirectURI !== undefined &&
10323
- input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnableTokenRevocation !== undefined &&
10326
+ input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnablePropagateAdditionalUserContextData !== undefined &&
10327
+ input.EnablePropagateAdditionalUserContextData !== null && {
10328
+ EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
10329
+ })), (input.EnableTokenRevocation !== undefined &&
10324
10330
  input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation })), (input.ExplicitAuthFlows !== undefined &&
10325
10331
  input.ExplicitAuthFlows !== null && {
10326
10332
  ExplicitAuthFlows: serializeAws_json1_1ExplicitAuthFlowsListType(input.ExplicitAuthFlows, context),
@@ -10397,7 +10403,7 @@ var serializeAws_json1_1UserAttributeUpdateSettingsType = function (input, conte
10397
10403
  }));
10398
10404
  };
10399
10405
  var serializeAws_json1_1UserContextDataType = function (input, context) {
10400
- return __assign({}, (input.EncodedData !== undefined && input.EncodedData !== null && { EncodedData: input.EncodedData }));
10406
+ return __assign(__assign({}, (input.EncodedData !== undefined && input.EncodedData !== null && { EncodedData: input.EncodedData })), (input.IpAddress !== undefined && input.IpAddress !== null && { IpAddress: input.IpAddress }));
10401
10407
  };
10402
10408
  var serializeAws_json1_1UsernameAttributesListType = function (input, context) {
10403
10409
  return input
@@ -12101,6 +12107,7 @@ var deserializeAws_json1_1UserPoolClientType = function (output, context) {
12101
12107
  ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.CreationDate)))
12102
12108
  : undefined,
12103
12109
  DefaultRedirectURI: __expectString(output.DefaultRedirectURI),
12110
+ EnablePropagateAdditionalUserContextData: __expectBoolean(output.EnablePropagateAdditionalUserContextData),
12104
12111
  EnableTokenRevocation: __expectBoolean(output.EnableTokenRevocation),
12105
12112
  ExplicitAuthFlows: output.ExplicitAuthFlows !== undefined && output.ExplicitAuthFlows !== null
12106
12113
  ? deserializeAws_json1_1ExplicitAuthFlowsListType(output.ExplicitAuthFlows, context)
@@ -483,15 +483,22 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
483
483
  adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
484
484
  adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
485
485
  /**
486
- * <p>Returns a unique generated shared secret key code for the user account. The request
487
- * takes an access token or a session string, but not both.</p>
486
+ * <p>Begins setup of time-based one-time password multi-factor authentication (TOTP MFA)
487
+ * for a user, with a unique private key that Amazon Cognito generates and returns in the API
488
+ * response. You can authorize an <code>AssociateSoftwareToken</code> request with either
489
+ * the user's access token, or a session string from a challenge response that you received
490
+ * from Amazon Cognito.</p>
488
491
  * <note>
489
- * <p>Calling AssociateSoftwareToken immediately disassociates the existing software
490
- * token from the user account. If the user doesn't subsequently verify the software
491
- * token, their account is set up to authenticate without MFA. If MFA config is set to
492
- * Optional at the user pool level, the user can then log in without MFA. However, if
493
- * MFA is set to Required for the user pool, the user is asked to set up a new software
494
- * token MFA during sign-in.</p>
492
+ * <p>Amazon Cognito disassociates an existing software token when you verify the new token in a
493
+ * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html"> VerifySoftwareToken</a> API request. If you don't verify the software
494
+ * token and your user pool doesn't require MFA, the user can then authenticate with
495
+ * user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito
496
+ * generates an <code>MFA_SETUP</code> or <code>SOFTWARE_TOKEN_SETUP</code> challenge
497
+ * each time your user signs. Complete setup with <code>AssociateSoftwareToken</code>
498
+ * and <code>VerifySoftwareToken</code>.</p>
499
+ * <p>After you set up software token MFA for your user, Amazon Cognito generates a
500
+ * <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
501
+ * this challenge with your user's TOTP.</p>
495
502
  * </note>
496
503
  */
497
504
  associateSoftwareToken(args: AssociateSoftwareTokenCommandInput, options?: __HttpHandlerOptions): Promise<AssociateSoftwareTokenCommandOutput>;
@@ -7,15 +7,22 @@ export interface AssociateSoftwareTokenCommandInput extends AssociateSoftwareTok
7
7
  export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTokenResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Returns a unique generated shared secret key code for the user account. The request
11
- * takes an access token or a session string, but not both.</p>
10
+ * <p>Begins setup of time-based one-time password multi-factor authentication (TOTP MFA)
11
+ * for a user, with a unique private key that Amazon Cognito generates and returns in the API
12
+ * response. You can authorize an <code>AssociateSoftwareToken</code> request with either
13
+ * the user's access token, or a session string from a challenge response that you received
14
+ * from Amazon Cognito.</p>
12
15
  * <note>
13
- * <p>Calling AssociateSoftwareToken immediately disassociates the existing software
14
- * token from the user account. If the user doesn't subsequently verify the software
15
- * token, their account is set up to authenticate without MFA. If MFA config is set to
16
- * Optional at the user pool level, the user can then log in without MFA. However, if
17
- * MFA is set to Required for the user pool, the user is asked to set up a new software
18
- * token MFA during sign-in.</p>
16
+ * <p>Amazon Cognito disassociates an existing software token when you verify the new token in a
17
+ * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html"> VerifySoftwareToken</a> API request. If you don't verify the software
18
+ * token and your user pool doesn't require MFA, the user can then authenticate with
19
+ * user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito
20
+ * generates an <code>MFA_SETUP</code> or <code>SOFTWARE_TOKEN_SETUP</code> challenge
21
+ * each time your user signs. Complete setup with <code>AssociateSoftwareToken</code>
22
+ * and <code>VerifySoftwareToken</code>.</p>
23
+ * <p>After you set up software token MFA for your user, Amazon Cognito generates a
24
+ * <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
25
+ * this challenge with your user's TOTP.</p>
19
26
  * </note>
20
27
  * @example
21
28
  * Use a bare-bones client and the command you need to make an API call.