Skip to content

Verify Software Token

cognitoidentityprovider_verify_software_token R Documentation

Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful

Description

Use this API to register a user's entered time-based one-time password (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.

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

cognitoidentityprovider_verify_software_token(AccessToken, Session,
  UserCode, FriendlyDeviceName)

Arguments

AccessToken

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

Session

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

UserCode

[required] The one- time password computed using the secret code returned by associate_software_token.

FriendlyDeviceName

The friendly device name.

Value

A list with the following syntax: 

list(
  Status = "SUCCESS"|"ERROR",
  Session = "string"
)

Request syntax

svc$verify_software_token(
  AccessToken = "string",
  Session = "string",
  UserCode = "string",
  FriendlyDeviceName = "string"
)