Container for the parameters to the VerifySoftwareToken operation.
Registers the current user's time-based one-time password (TOTP) authenticator with
a code generated in their authenticator app from a private key that's supplied by
your user pool. Marks 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
Amazon.CognitoIdentityProvider.Model.VerifySoftwareTokenRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class VerifySoftwareTokenRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The VerifySoftwareTokenRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
VerifySoftwareTokenRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AccessToken | System.String |
Gets and sets the property AccessToken.
A valid access token that Amazon Cognito issued to the currently signed-in user. Must
include a scope claim for |
|
|
FriendlyDeviceName | System.String |
Gets and sets the property FriendlyDeviceName. A friendly name for the device that's running the TOTP authenticator. |
|
|
Session | System.String |
Gets and sets the property Session.
The session ID from an |
|
|
UserCode | System.String |
Gets and sets the property UserCode. A TOTP that the user generated in their configured authenticator app. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5