AWSCognitoIdentityProviderConfirmSignUpRequest Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSCognitoIdentityProviderModel.h
AWSCognitoIdentityProviderModel.m

Overview

Represents the request to confirm registration of a user.

Required parameters: [ClientId, Username, ConfirmationCode]

  clientId

The ID of the client associated with the user pool.

@property (nonatomic, strong) NSString *clientId

Declared In

AWSCognitoIdentityProviderModel.h

  confirmationCode

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

@property (nonatomic, strong) NSString *confirmationCode

Declared In

AWSCognitoIdentityProviderModel.h

  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.

@property (nonatomic, strong) NSNumber *forceAliasCreation

Declared In

AWSCognitoIdentityProviderModel.h

  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.

@property (nonatomic, strong) NSString *secretHash

Declared In

AWSCognitoIdentityProviderModel.h

  username

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

@property (nonatomic, strong) NSString *username

Declared In

AWSCognitoIdentityProviderModel.h