Class: Aws::CognitoIdentityProvider::Types::ConfirmSignUpRequest

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

Overview

Represents the request to confirm registration of a user.

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadata ⇒ Types::AnalyticsMetadataType

The Amazon Pinpoint analytics metadata for collecting metrics for ‘ConfirmSignUp` calls.

Returns:



3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3439

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata,
  :session)
  SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data, :session]
  include Aws::Structure
end

#client_id ⇒ String

The ID of the app client associated with the user pool.

Returns:

  • (String) 


3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3439

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata,
  :session)
  SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data, :session]
  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*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note 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 send sensitive information in this parameter.

</note>

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

Returns:

  • (Hash<String,String>) 


3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3439

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata,
  :session)
  SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data, :session]
  include Aws::Structure
end

#confirmation_code ⇒ String

The confirmation code that your user pool sent in response to the ‘SignUp` request.

Returns:

  • (String) 


3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3439

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata,
  :session)
  SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data, :session]
  include Aws::Structure
end

#force_alias_creation ⇒ Boolean

When ‘true`, forces user confirmation despite any existing aliases. Defaults to `false`. A value of `true` migrates the alias from an existing user to the new user if an existing user already has the phone number or email address as an alias.

Say, for example, that an existing user has an ‘email` attribute of `[email protected]` and email is an alias in your user pool. If the new user also has an email of `[email protected]` and your `ConfirmSignUp` response sets `ForceAliasCreation` to `true`, the new user can sign in with a username of `[email protected]` and the existing user can no longer do so.

If ‘false` and an attribute belongs to an existing alias, this request returns an AliasExistsException error.

For more information about sign-in aliases, see [Customizing sign-in attributes].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases

Returns:

  • (Boolean) 


3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3439

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata,
  :session)
  SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data, :session]
  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. For more information about ‘SecretHash`, see [Computing secret hash values].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash

Returns:

  • (String) 


3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3439

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata,
  :session)
  SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data, :session]
  include Aws::Structure
end

#session ⇒ String

The optional session ID from a ‘SignUp` API request. You can sign in a user directly from the sign-up process with the `USER_AUTH` authentication flow.

Returns:

  • (String) 


3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3439

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata,
  :session)
  SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data, :session]
  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.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html

Returns:



3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3439

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata,
  :session)
  SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data, :session]
  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.

Returns:

  • (String) 


3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3439

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata,
  :session)
  SENSITIVE = [:client_id, :secret_hash, :username, :user_context_data, :session]
  include Aws::Structure
end