Class: Aws::CognitoIdentityProvider::Types::SignUpRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the request to register a user.

See Also:

Constant Summary collapse

SENSITIVE = 
[:client_id, :secret_hash, :username, :password, :user_context_data]

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadata ⇒ Types::AnalyticsMetadataType

The Amazon Pinpoint analytics metadata that contributes to your metrics for ‘SignUp` calls.

Returns:



8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8182

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  include Aws::Structure
end

#client_id ⇒ String

The ID of the client associated with the user pool.

Returns:

  • (String) 


8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8182

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  include Aws::Structure
end

#client_metadata ⇒ Hash<String,String>

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 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 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*.

<note markdown=“1”> When you use the ClientMetadata parameter, remember that Amazon Cognito won’t do the following:

* Store the ClientMetadata value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don’t use Amazon Cognito to provide sensitive information.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

  • (Hash<String,String>) 


8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8182

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  include Aws::Structure
end

#password ⇒ String

The password of the user you want to register.

Returns:

  • (String) 


8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8182

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  include Aws::Structure
end

#secret_hash ⇒ String

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.

Returns:

  • (String) 


8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8182

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  include Aws::Structure
end

#user_attributes ⇒ Array<Types::AttributeType>

An array of name-value pairs representing user attributes.

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

Returns:



8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8182

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  include Aws::Structure
end

#user_context_data ⇒ Types::UserContextDataType

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

Returns:



8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8182

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  include Aws::Structure
end

#username ⇒ String

The username of the user that you want to sign up. The value of this parameter is typically a username, but can be any alias attribute in your user pool.

Returns:

  • (String) 


8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8182

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  include Aws::Structure
end

#validation_data ⇒ Array<Types::AttributeType>

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don’t need to retain.

Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.

For more information about the pre sign-up Lambda trigger, see [Pre sign-up Lambda trigger].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html

Returns:



8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8182

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  include Aws::Structure
end