Amazon Cognito Identity Provider

Deletes a user's registered time-based one-time password (TOTP) multi-factor authentication (MFA) factor, also known as a software token. After this operation, the user can no longer sign in with TOTP MFA, and can register a new TOTP factor with AssociateSoftwareToken. Use this operation when a user loses access to their TOTP-generating device, for example, a lost or reset phone, and needs to register a new one.

See also: AWS API Documentation

Request Syntax

client.admin_delete_software_token(
    UserPoolId='string',
    Username='string'
)

type UserPoolId:

string

param UserPoolId:

[REQUIRED]

The ID of the user pool where you want to delete the user's software token.

type Username:

string

param Username:

[REQUIRED]

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --