Amazon Cognito Identity Provider
API Reference (API Version 2016-04-18)

AssociateSoftwareToken

Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.

Request Syntax

{ "AccessToken": "string", "Session": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AccessToken

The access token.

Type: String

Pattern: [A-Za-z0-9-_=.]+

Required: No

Session

The session which 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.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

Response Syntax

{ "SecretCode": "string", "Session": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SecretCode

A unique generated shared secret code that is used in the TOTP algorithm to generate a one time code.

Type: String

Length Constraints: Minimum length of 16.

Pattern: [A-Za-z0-9]+

Session

The session which 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.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalErrorException

This exception is thrown when Amazon Cognito encounters an internal error.

HTTP Status Code: 500

InvalidParameterException

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

HTTP Status Code: 400

NotAuthorizedException

This exception is thrown when a user is not authorized.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when the Amazon Cognito service cannot find the requested resource.

HTTP Status Code: 400

SoftwareTokenMFANotFoundException

This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled for the user pool.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: