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 AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito.
A valid access token that Amazon Cognito issued to the user whose software token you want to generate.
Match pattern:
[A-Za-z0-9-_=.]+
Session
stringÂ
optional
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.
>= 20 characters<= 2048 characters
Examples
Responses
🟢200Success
application/json
Body
SecretCode
string <password>
optional
A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.
>= 16 characters
Match pattern:
[A-Za-z0-9]+
Session
stringÂ
optional
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.
