AWSCognitoIdentityProviderSignUpRequest

@interface AWSCognitoIdentityProviderSignUpRequest

Represents the request to register a user.

Required parameters: [ClientId, Username, Password]

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

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        AWSCognitoIdentityProviderAnalyticsMetadataType
            *_Nullable analyticsMetadata;

    Swift

    var analyticsMetadata: AWSCognitoIdentityProviderAnalyticsMetadataType? { get set }
  • The ID of the client associated with the user pool.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable clientId;

    Swift

    var clientId: String? { get set }
  • A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

    You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

    For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    Take the following limitations into consideration when you use the ClientMetadata parameter:

    • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

    • Amazon Cognito does not validate the ClientMetadata value.

    • Amazon Cognito does not encrypt the the ClientMetadata value, so don’t use it to provide sensitive information.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        NSDictionary<NSString *, NSString *> *_Nullable clientMetadata;

    Swift

    var clientMetadata: [String : String]? { get set }
  • The password of the user you wish to register.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable password;

    Swift

    var password: String? { get set }
  • 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.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable secretHash;

    Swift

    var secretHash: String? { get set }
  • An array of name-value pairs representing user attributes.

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

    Declaration

    Objective-C

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

    Swift

    var userAttributes: [AWSCognitoIdentityProviderAttributeType]? { get set }
  • 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.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        AWSCognitoIdentityProviderUserContextDataType *_Nullable userContextData;

    Swift

    var userContextData: AWSCognitoIdentityProviderUserContextDataType? { get set }
  • The user name of the user you wish to register.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable username;

    Swift

    var username: String? { get set }
  • The validation data in the request to register a user.

    Declaration

    Objective-C

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

    Swift

    var validationData: [AWSCognitoIdentityProviderAttributeType]? { get set }