[ aws . cognito-idp ]

associate-software-token

Description

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.

Note

Calling AssociateSoftwareToken immediately disassociates the existing software token from the user account. If the user doesn’t subsequently verify the software token, their account is set up to authenticate without MFA. If MFA config is set to Optional at the user pool level, the user can then log in without MFA. However, if MFA is set to Required for the user pool, the user is asked to set up a new software token MFA during sign-in.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  associate-software-token
[--access-token <value>]
[--session <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--access-token (string)

The access token.

--session (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

SecretCode -> (string)

A unique generated shared secret code that is used in the time-based one-time password (TOTP) algorithm to generate a one-time code.

Session -> (string)

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.