[ aws . cognito-idp ]

verify-software-token

Description

Use this API to register a user’s entered TOTP code and mark the user’s software token MFA status as “verified” if successful. The request takes an access token or a session string, but not both.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  verify-software-token
[--access-token <value>]
[--session <value>]
--user-code <value>
[--friendly-device-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--access-token (string)

The access token.

--session (string)

The session which should be passed both ways in challenge-response calls to the service.

--user-code (string)

The one time password computed using the secret code returned by

--friendly-device-name (string)

The friendly device name.

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

Status -> (string)

The status of the verify software token.

Session -> (string)

The session which should be passed both ways in challenge-response calls to the service.