AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito.

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.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to AssociateSoftwareTokenAsync.

Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public virtual AssociateSoftwareTokenResponse AssociateSoftwareToken(
         AssociateSoftwareTokenRequest request
)

Parameters

request
Type: Amazon.CognitoIdentityProvider.Model.AssociateSoftwareTokenRequest

Container for the necessary parameters to execute the AssociateSoftwareToken service method.

Return Value


The response from the AssociateSoftwareToken service method, as returned by CognitoIdentityProvider.

Exceptions

ExceptionCondition
ConcurrentModificationException This exception is thrown if two or more modifications are happening concurrently.
ForbiddenException This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.
InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.
InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException This exception is thrown when a user isn't authorized.
ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.
SoftwareTokenMFANotFoundException This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also