AWSCognitoIdentityProviderSignUpRequest Class Reference

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

Overview

Represents the request to register a user.

Required parameters: [ClientId, Username, Password]

  analyticsMetadata

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

@property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType *analyticsMetadata

Declared In

AWSCognitoIdentityProviderModel.h

  clientId

The ID of the client associated with the user pool.

@property (nonatomic, strong) NSString *clientId

Declared In

AWSCognitoIdentityProviderModel.h

  password

The password of the user you wish to register.

@property (nonatomic, strong) NSString *password

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

  userAttributes

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

@property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType*> *userAttributes

Declared In

AWSCognitoIdentityProviderModel.h

  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.

@property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType *userContextData

Declared In

AWSCognitoIdentityProviderModel.h

  username

The user name of the user you wish to register.

@property (nonatomic, strong) NSString *username

Declared In

AWSCognitoIdentityProviderModel.h

  validationData

The validation data in the request to register a user.

@property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType*> *validationData

Declared In

AWSCognitoIdentityProviderModel.h