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.
Use this API to register a user's entered time-based one-time password (TOTP) code
and mark the user's software token MFA status as "verified" if successful. The request
takes an access token or a session string, but not both.
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.
For .NET Core this operation is only available in asynchronous form. Please refer to VerifySoftwareTokenAsync.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public virtual VerifySoftwareTokenResponse VerifySoftwareToken( VerifySoftwareTokenRequest request )
Container for the necessary parameters to execute the VerifySoftwareToken service method.
| Exception | Condition |
|---|---|
| CodeMismatchException | This exception is thrown if the provided code doesn't match what the server was expecting. |
| EnableSoftwareTokenMFAException | This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA). |
| 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. |
| InvalidUserPoolConfigurationException | This exception is thrown when the user pool configuration is not valid. |
| NotAuthorizedException | This exception is thrown when a user isn't authorized. |
| PasswordResetRequiredException | This exception is thrown when a password reset is required. |
| 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. |
| TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
| UserNotConfirmedException | This exception is thrown when a user isn't confirmed successfully. |
| UserNotFoundException | This exception is thrown when a user isn't found. |
.NET Framework:
Supported in: 4.5 and newer, 3.5