Skip to content

Commit d285512

Browse files
author
awstools
committed
feat(client-cognito-identity-provider): Amazon Cognito now supports IP Address propagation for all unauthenticated APIs (e.g. SignUp, ForgotPassword).
1 parent b363ebe commit d285512

File tree

6 files changed

+197
-81
lines changed

6 files changed

+197
-81
lines changed

clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1537,15 +1537,22 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient {
15371537
}
15381538

15391539
/**
1540-
* <p>Returns a unique generated shared secret key code for the user account. The request
1541-
* takes an access token or a session string, but not both.</p>
1540+
* <p>Begins setup of time-based one-time password multi-factor authentication (TOTP MFA)
1541+
* for a user, with a unique private key that Amazon Cognito generates and returns in the API
1542+
* response. You can authorize an <code>AssociateSoftwareToken</code> request with either
1543+
* the user's access token, or a session string from a challenge response that you received
1544+
* from Amazon Cognito.</p>
15421545
* <note>
1543-
* <p>Calling AssociateSoftwareToken immediately disassociates the existing software
1544-
* token from the user account. If the user doesn't subsequently verify the software
1545-
* token, their account is set up to authenticate without MFA. If MFA config is set to
1546-
* Optional at the user pool level, the user can then log in without MFA. However, if
1547-
* MFA is set to Required for the user pool, the user is asked to set up a new software
1548-
* token MFA during sign-in.</p>
1546+
* <p>Amazon Cognito disassociates an existing software token when you verify the new token in a
1547+
* <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
1548+
* token and your user pool doesn't require MFA, the user can then authenticate with
1549+
* user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito
1550+
* generates an <code>MFA_SETUP</code> or <code>SOFTWARE_TOKEN_SETUP</code> challenge
1551+
* each time your user signs. Complete setup with <code>AssociateSoftwareToken</code>
1552+
* and <code>VerifySoftwareToken</code>.</p>
1553+
* <p>After you set up software token MFA for your user, Amazon Cognito generates a
1554+
* <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
1555+
* this challenge with your user's TOTP.</p>
15491556
* </note>
15501557
*/
15511558
public associateSoftwareToken(

clients/client-cognito-identity-provider/src/commands/AssociateSoftwareTokenCommand.ts

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,22 @@ export interface AssociateSoftwareTokenCommandInput extends AssociateSoftwareTok
2828
export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTokenResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns a unique generated shared secret key code for the user account. The request
32-
* takes an access token or a session string, but not both.</p>
31+
* <p>Begins setup of time-based one-time password multi-factor authentication (TOTP MFA)
32+
* for a user, with a unique private key that Amazon Cognito generates and returns in the API
33+
* response. You can authorize an <code>AssociateSoftwareToken</code> request with either
34+
* the user's access token, or a session string from a challenge response that you received
35+
* from Amazon Cognito.</p>
3336
* <note>
34-
* <p>Calling AssociateSoftwareToken immediately disassociates the existing software
35-
* token from the user account. If the user doesn't subsequently verify the software
36-
* token, their account is set up to authenticate without MFA. If MFA config is set to
37-
* Optional at the user pool level, the user can then log in without MFA. However, if
38-
* MFA is set to Required for the user pool, the user is asked to set up a new software
39-
* token MFA during sign-in.</p>
37+
* <p>Amazon Cognito disassociates an existing software token when you verify the new token in a
38+
* <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
39+
* token and your user pool doesn't require MFA, the user can then authenticate with
40+
* user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito
41+
* generates an <code>MFA_SETUP</code> or <code>SOFTWARE_TOKEN_SETUP</code> challenge
42+
* each time your user signs. Complete setup with <code>AssociateSoftwareToken</code>
43+
* and <code>VerifySoftwareToken</code>.</p>
44+
* <p>After you set up software token MFA for your user, Amazon Cognito generates a
45+
* <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
46+
* this challenge with your user's TOTP.</p>
4047
* </note>
4148
* @example
4249
* Use a bare-bones client and the command you need to make an API call.

0 commit comments

Comments
 (0)