Associate Software Token
cognitoidentityprovider_associate_software_token | R Documentation |
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¶
Description¶
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
associate_software_token
request with either the user's access token,
or a session string from a challenge response that you received from
Amazon Cognito.
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 MFA_SETUP
or SOFTWARE_TOKEN_SETUP
challenge
each time your user signs in. Complete setup with
associate_software_token
and verify_software_token
.
After you set up software token MFA for your user, Amazon Cognito
generates a SOFTWARE_TOKEN_MFA
challenge when they authenticate.
Respond to this challenge with your user's TOTP.
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.
Usage¶
Arguments¶
AccessToken
A valid access token that Amazon Cognito issued to the user whose software token you want to generate.
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.
Value¶
A list with the following syntax: