Class: Aws::CognitoIdentityProvider::Types::SignUpResponse

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

Overview

The response from the server for a registration request.

See Also:

Constant Summary collapse

SENSITIVE = 
[:session]

Instance Attribute Summary collapse

Instance Attribute Details

#code_delivery_details ⇒ Types::CodeDeliveryDetailsType

In user pools that automatically verify and confirm new users, Amazon Cognito sends users a message with a code or link that confirms ownership of the phone number or email address that they entered. The CodeDeliveryDetails object is information about the delivery destination for that link or code.

Returns:



11153
11154
11155
11156
11157
11158
11159
11160
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 11153

class SignUpResponse < Struct.new(
  :user_confirmed,
  :code_delivery_details,
  :user_sub,
  :session)
  SENSITIVE = [:session]
  include Aws::Structure
end

#session ⇒ String

A session Id that you can pass to ConfirmSignUp when you want to immediately sign in your user with the USER_AUTH flow after they complete sign-up.

Returns:

  • (String) 


11153
11154
11155
11156
11157
11158
11159
11160
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 11153

class SignUpResponse < Struct.new(
  :user_confirmed,
  :code_delivery_details,
  :user_sub,
  :session)
  SENSITIVE = [:session]
  include Aws::Structure
end

#user_confirmed ⇒ Boolean

Indicates whether the user was automatically confirmed. You can auto-confirm users with a pre sign-up Lambda trigger.

Returns:

  • (Boolean) 


11153
11154
11155
11156
11157
11158
11159
11160
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 11153

class SignUpResponse < Struct.new(
  :user_confirmed,
  :code_delivery_details,
  :user_sub,
  :session)
  SENSITIVE = [:session]
  include Aws::Structure
end

#user_sub ⇒ String

The unique identifier of the new user, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

Returns:

  • (String) 


11153
11154
11155
11156
11157
11158
11159
11160
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 11153

class SignUpResponse < Struct.new(
  :user_confirmed,
  :code_delivery_details,
  :user_sub,
  :session)
  SENSITIVE = [:session]
  include Aws::Structure
end