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.

Container for the parameters to the ConfirmSignUp operation. Confirms registration of a user and handles the existing alias from a previous user.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.ConfirmSignUpRequest

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

Syntax

C# 
public class ConfirmSignUpRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The ConfirmSignUpRequest type exposes the following members

Constructors

NameDescription
Public Method ConfirmSignUpRequest()

Properties

NameTypeDescription
Public Property AnalyticsMetadata Amazon.CognitoIdentityProvider.Model.AnalyticsMetadataType

Gets and sets the property AnalyticsMetadata.

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

Public Property ClientId System.String

Gets and sets the property ClientId.

The ID of the app client associated with the user pool.

Public Property ConfirmationCode System.String

Gets and sets the property ConfirmationCode.

The confirmation code sent by a user's request to confirm registration.

Public Property ForceAliasCreation System.Boolean

Gets and sets the property ForceAliasCreation.

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

Public Property SecretHash System.String

Gets and sets the property SecretHash.

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Public Property UserContextData Amazon.CognitoIdentityProvider.Model.UserContextDataType

Gets and sets the property UserContextData.

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Public Property Username System.String

Gets and sets the property Username.

The user name of the user whose registration you wish to confirm.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms