Class: Aws::CognitoIdentityProvider::Types::AdminCreateUserConfigType

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

Overview

The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

This data type is a request and response parameter of

CreateUserPool][1

and [UpdateUserPool], and a response parameter

of [DescribeUserPool].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_admin_create_user_only ⇒ Boolean

The setting for allowing self-service sign-up. When ‘true`, only administrators can create new user profiles. When `false`, users can register themselves and create a new user profile with the

SignUp][1

operation.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html

Returns:

  • (Boolean) 


381
382
383
384
385
386
387
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 381

class AdminCreateUserConfigType < Struct.new(
  :allow_admin_create_user_only,
  :unused_account_validity_days,
  :invite_message_template)
  SENSITIVE = []
  include Aws::Structure
end

#invite_message_template ⇒ Types::MessageTemplateType

The template for the welcome message to new users. This template must include the ‘####` temporary password placeholder if you are creating users with passwords. If your users don’t have passwords, you can omit the placeholder.

See also [Customizing User Invitation Messages].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization

Returns:



381
382
383
384
385
386
387
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 381

class AdminCreateUserConfigType < Struct.new(
  :allow_admin_create_user_only,
  :unused_account_validity_days,
  :invite_message_template)
  SENSITIVE = []
  include Aws::Structure
end

#unused_account_validity_days ⇒ Integer

This parameter is no longer in use. Configure the duration of temporary passwords with the ‘TemporaryPasswordValidityDays` parameter of [PasswordPolicyType]. For older user pools that have a `UnusedAccountValidityDays` configuration, that value is effective until you set a value for `TemporaryPasswordValidityDays`.

The password expiration limit in days for administrator-created users. When this time expires, the user can’t sign in with their temporary password. To reset the account after that time limit, you must call ‘AdminCreateUser` again, specifying `RESEND` for the `MessageAction` parameter.

The default value for this parameter is 7.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_PasswordPolicyType.html

Returns:

  • (Integer) 


381
382
383
384
385
386
387
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 381

class AdminCreateUserConfigType < Struct.new(
  :allow_admin_create_user_only,
  :unused_account_validity_days,
  :invite_message_template)
  SENSITIVE = []
  include Aws::Structure
end