AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA)
for a user, with a unique private key that Amazon Cognito generates and returns in
the API response. You can authorize an
Amazon Cognito disassociates an existing software token when you verify the new token
in a
VerifySoftwareToken API request. If you don't verify the software token and your
user pool doesn't require MFA, the user can then authenticate with user name and password
credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an
After you set up software token MFA for your user, Amazon Cognito generates a
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests
for this API operation. For this operation, you can't use IAM credentials to authorize
requests, and you can't grant IAM permissions in policies. For more information about
authorization models in Amazon Cognito, see Using
the Amazon Cognito user pools API and user pool endpoints.
AssociateSoftwareToken request with
either the user's access token, or a session string from a challenge response that
you received from Amazon Cognito.
MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs.
Complete setup with AssociateSoftwareToken and VerifySoftwareToken.
SOFTWARE_TOKEN_MFA
challenge when they authenticate. Respond to this challenge with your user's TOTP.
For .NET Core this operation is only available in asynchronous form. Please refer to AssociateSoftwareTokenAsync.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public abstract AssociateSoftwareTokenResponse AssociateSoftwareToken( AssociateSoftwareTokenRequest request )
Container for the necessary parameters to execute the AssociateSoftwareToken service method.
| Exception | Condition |
|---|---|
| ConcurrentModificationException | This exception is thrown if two or more modifications are happening concurrently. |
| ForbiddenException | This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool. |
| InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
| InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
| NotAuthorizedException | This exception is thrown when a user isn't authorized. |
| ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
| SoftwareTokenMFANotFoundException | This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5