Container for the parameters to the AdminDeleteSoftwareToken operation.
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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
In this article ▶
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
Amazon.CognitoIdentityProvider.Model.AdminDeleteSoftwareTokenRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class AdminDeleteSoftwareTokenRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AdminDeleteSoftwareTokenRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AdminDeleteSoftwareTokenRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Username | System.String |
Gets and sets the property Username.
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
|
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool where you want to delete the user's software token. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer