SignUpRequest

import type { SignUpRequest } from "https://aws-api.deno.dev/v0.4/services/cognitoidentityserviceprovider.ts?docs=full";

Represents the request to register a user.

interface SignUpRequest {

AnalyticsMetadata?: AnalyticsMetadataType | null;

ClientId: string;

ClientMetadata?: {

[key: string]: string | null | undefined;

} | null;

Password: string;

SecretHash?: string | null;

UserAttributes?: AttributeType[] | null;

UserContextData?: UserContextDataType | null;

Username: string;

ValidationData?: AttributeType[] | null;

}

§Properties

AnalyticsMetadata?: AnalyticsMetadataType | null

[src]

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

ClientId: string

[src]

The ID of the client associated with the user pool.

ClientMetadata?: {

[key: string]: string | null | undefined;

} | null

[src]

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

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Note: When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: - Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - Validate the ClientMetadata value. - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Password: string

[src]

The password of the user you want to register.

SecretHash?: string | null

[src]

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

UserAttributes?: AttributeType[] | null

[src]

An array of name-value pairs representing user attributes.

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

UserContextData?: UserContextDataType | null

[src]

Contextual data about your 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 when it makes API requests.

Username: string

[src]

The user name of the user you want to register.

ValidationData?: AttributeType[] | null

[src]

The validation data in the request to register a user.