AdminCreateUserConfigType Class | AWS SDK for .NET V3

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 and UpdateUserPool, and a response parameter of DescribeUserPool.

Inheritance Hierarchy

System.Object
Amazon.CognitoIdentityProvider.Model.AdminCreateUserConfigType

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public class AdminCreateUserConfigType

The AdminCreateUserConfigType type exposes the following members

Constructors

	Name	Description
	AdminCreateUserConfigType()

Properties

Name Type Description

Name	Type	Description
AllowAdminCreateUserOnly	System.Boolean	Gets and sets the property AllowAdminCreateUserOnly. 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 operation.
InviteMessageTemplate	Amazon.CognitoIdentityProvider.Model.MessageTemplateType	Gets and sets the property InviteMessageTemplate. 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.
UnusedAccountValidityDays	System.Int32	Gets and sets the property UnusedAccountValidityDays. 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.

AllowAdminCreateUserOnly

System.Boolean

Gets and sets the property AllowAdminCreateUserOnly.

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 operation.

InviteMessageTemplate

Amazon.CognitoIdentityProvider.Model.MessageTemplateType

Gets and sets the property InviteMessageTemplate.

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.

UnusedAccountValidityDays

System.Int32

Gets and sets the property UnusedAccountValidityDays.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5