You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass ConfirmSignUpRequest data as a hash:

{
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  username: "UsernameType", # required
  confirmation_code: "ConfirmationCodeType", # required
  force_alias_creation: false,
}

Represents the request to confirm registration of a user.

Instance Attribute Summary collapse

Instance Attribute Details

#client_idString

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

Returns:

  • (String)


1640
1641
1642
1643
1644
1645
1646
1647
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1640

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation)
  include Aws::Structure
end

#confirmation_codeString

The confirmation code sent by a user's request to confirm registration.

Returns:

  • (String)


1640
1641
1642
1643
1644
1645
1646
1647
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1640

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation)
  include Aws::Structure
end

#force_alias_creationBoolean

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.

Returns:

  • (Boolean)


1640
1641
1642
1643
1644
1645
1646
1647
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1640

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation)
  include Aws::Structure
end

#secret_hashString

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)


1640
1641
1642
1643
1644
1645
1646
1647
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1640

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation)
  include Aws::Structure
end

#usernameString

The user name of the user whose registration you wish to confirm.

Returns:

  • (String)


1640
1641
1642
1643
1644
1645
1646
1647
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1640

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation)
  include Aws::Structure
end