ICognitoIdentityProviderSignUpRequest

Interface in AWS.CognitoIdentityProvider

Interface for SignUp requests.

Ancestors

• ICognitoIdentityProviderRequest

Properties

AnalyticsMetadata

property AnalyticsMetadata: ICognitoIdentityProviderAnalyticsMetadataType

Type: ICognitoIdentityProviderAnalyticsMetadataType

Specify the Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.

ClientId

property ClientId: string

Specify the ID of the client associated with the user pool.

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.

Password

property Password: string

Specify a password for the user you want to register.

SecretHash

property SecretHash: string

Provide a key-hashed message authentication code (HMAC) calculated using the secret key of a user pool client and the username plus the client ID in the message.

TCognitoIdentityProviderSecretHashEncoder can be used to generate a value for this.

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

UserContextData

property UserContextData: ICognitoIdentityProviderUserContextDataType

Type: ICognitoIdentityProviderUserContextDataType

Contextual data about the user session, such as the device fingerprint, IP address, or location.

Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito.

Username

property Username: string

Specify the username of the user you want to register.

ValidationData

property ValidationData: TList<ICognitoIdentityProviderAttributeType>

Type: ICognitoIdentityProviderAttributeType

Specify the validation data to register the user.

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.

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 validation data to add.
AValue	Specify the value of the validation data to add.

Returns

The index of the added validation data.