ICognitoIdentityProviderAdminCreateUserRequest

Interface in AWS.CognitoIdentityProvider

Interface for AdminCreateUser requests.

Ancestors

• ICognitoIdentityProviderRequest

Properties

ClientMetadata

property ClientMetadata: TDictionary<string, string>

Specifies a map of key-value pairs that you can provide as input for any custom workflows that this action triggers.

Use AddClientMetadata to populate values.

DesiredDeliveryMediums

property DesiredDeliveryMediums: TList<string>

Specifies a list of desired delivery mediums for the welcome message.

Valid values: EMAIL | SMS. Default value is SMS.

ForceAliasCreation

property ForceAliasCreation: TOptional<Boolean>

Specify this only if the phone_number_verified or email_verified attribute is set to True. Otherwise it is ignored.

When set to True and the phone number or email address specified in the UserAttributes parameter 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. The previous user will no longer be able to log in using that alias. When set to False, the API throws an ECognitoIdentityProviderAliasExistsException error if the alias already exists. The default value is False.

MessageAction

property MessageAction: string

Specify what action to take when the user exists.

Valid values:

TemporaryPassword

property TemporaryPassword: string

Specify a temporary password for the user.

The password must conform to the password policy specified for the user pool. The temporary password is valid only once. The user will be required to specify a new password after signing in for the first time. If this value is not specified, Amazon Cognito will generate a password. The temporary password can only be used until the user account expiration limit specified on the user pool. To reset the account after the time limit, you must call AdminCreateUser again specifying RESEND for the MessageAction parameter.

UserAttributes

property UserAttributes: TList<ICognitoIdentityProviderAttributeType>

Type: ICognitoIdentityProviderAttributeType

Specifies a list of name-value pairs containing user attributes and attribute values to be set for the user to be created.

For custom attributes, you must prefix the attribute name with custom:.

Username

property Username: string

Specify a Username.

Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After creation, the username can't be changed.

UserPoolId

property UserPoolId: string

Specify the ID of the user pool.

ValidationData

property ValidationData: TList<ICognitoIdentityProviderAttributeType>

Type: ICognitoIdentityProviderAttributeType

Specifies a list of name-value pairs containing user attributes and attribute values that can be used for custom validation.

To configure custom validation, you must create a Pre Sign-up AWS Lambda trigger for the user pool.

Methods

AddClientMetadata

procedure AddClientMetadata(const AKey, AValue: string);

Add a key-value pair to ClientMetadata.

Parameters

Name	Description
AKey	Specify a key for the value.
AValue	Specify a value.

AddDesiredDeliveryMedium

function AddDesiredDeliveryMedium(const ADesiredDeliveryMedium: string): Integer;

Add a medium to DesiredDeliveryMediums.

Parameters

Name	Description
ADesiredDeliveryMedium	Specify a medium to add to DesiredDeliveryMediums. Valid values:|.

Returns

The index of the added value.

AddUserAttribute

function AddUserAttribute(const AName: string; const AValue: string = ''): Integer;

Add a name-value pair to UserAttributes.

Parameters

Name	Description
AName	Specify the name of the user attribute to add.
AValue	Specify the value of the user attribute to add.

Returns

The index of the added user attribute.

AddValidationData

function AddValidationData(const AName: string; const AValue: string = ''): Integer;

Add a name-value pair to ValidationData.

Parameters

Name	Description
AName	Specify the name of the attribute to add.
AValue	Specify the value of the attribute to add.

Returns

The index of the added attribute.