Class: Aws::CognitoIdentityProvider::Types::ConfirmSignUpRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::ConfirmSignUpRequest
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
Represents the request to confirm registration of a user.
Constant Summary collapse
- SENSITIVE =
[:client_id, :secret_hash, :username, :user_context_data]
Instance Attribute Summary collapse
-
#analytics_metadata ⇒ Types::AnalyticsMetadataType
The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmSignUp
calls. -
#client_id ⇒ String
The ID of the app client associated with the user pool.
-
#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.
-
#confirmation_code ⇒ String
The confirmation code sent by a user's request to confirm registration.
-
#force_alias_creation ⇒ Boolean
Boolean to be specified to force user confirmation irrespective of existing alias.
-
#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.
-
#user_context_data ⇒ Types::UserContextDataType
Contextual data about your user session, such as the device fingerprint, IP address, or location.
-
#username ⇒ String
The username of the user that you want to query or modify.
Instance Attribute Details
#analytics_metadata ⇒ Types::AnalyticsMetadataType
The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmSignUp
calls.
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2642 class ConfirmSignUpRequest < Struct.new( :client_id, :secret_hash, :username, :confirmation_code, :force_alias_creation, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data] include Aws::Structure end |
#client_id ⇒ String
The ID of the app client associated with the user pool.
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2642 class ConfirmSignUpRequest < Struct.new( :client_id, :secret_hash, :username, :confirmation_code, :force_alias_creation, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :username, :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 ConfirmSignUp API action, Amazon
Cognito invokes the function that is assigned to the post
confirmation trigger. When Amazon Cognito invokes this function, 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
ConfirmSignUp 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.
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.
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2642 class ConfirmSignUpRequest < Struct.new( :client_id, :secret_hash, :username, :confirmation_code, :force_alias_creation, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data] include Aws::Structure end |
#confirmation_code ⇒ String
The confirmation code sent by a user's request to confirm registration.
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2642 class ConfirmSignUpRequest < Struct.new( :client_id, :secret_hash, :username, :confirmation_code, :force_alias_creation, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data] include Aws::Structure end |
#force_alias_creation ⇒ Boolean
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.
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2642 class ConfirmSignUpRequest < Struct.new( :client_id, :secret_hash, :username, :confirmation_code, :force_alias_creation, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :username, :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.
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2642 class ConfirmSignUpRequest < Struct.new( :client_id, :secret_hash, :username, :confirmation_code, :force_alias_creation, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :username, :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.
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2642 class ConfirmSignUpRequest < Struct.new( :client_id, :secret_hash, :username, :confirmation_code, :force_alias_creation, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data] include Aws::Structure end |
#username ⇒ String
The username of the user that you want to query or modify. The value
of this parameter is typically your user's username, but it can be
any of their alias attributes. If username
isn't an alias
attribute in your user pool, this value must be the sub
of a local
user or the username of a user from a third-party IdP.
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2642 class ConfirmSignUpRequest < Struct.new( :client_id, :secret_hash, :username, :confirmation_code, :force_alias_creation, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data] include Aws::Structure end |