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.
Container for the parameters to the AssociateSoftwareToken operation.
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.
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class AssociateSoftwareTokenRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AssociateSoftwareTokenRequest type exposes the following members
Name | Description | |
---|---|---|
AssociateSoftwareTokenRequest() |
Name | Type | Description | |
---|---|---|---|
AccessToken | System.String |
Gets and sets the property AccessToken. A valid access token that Amazon Cognito issued to the user whose software token you want to generate. |
|
Session | System.String |
Gets and sets the property Session. The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5