SignUpRequest

Represents the request to register a user.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.

Link copied to clipboard

The ID of the app client where the user wants to sign up.

Link copied to clipboard

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

Link copied to clipboard

The user's proposed password. The password must comply with the password requirements of your user pool.

Link copied to clipboard

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. For more information about SecretHash, see Computing secret hash values.

Link copied to clipboard

An array of name-value pairs representing user attributes.

Link copied to clipboard

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection 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.

Link copied to clipboard

The username of the user that you want to sign up. The value of this parameter is typically a username, but can be any alias attribute in your user pool.

Link copied to clipboard

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

Functions

Link copied to clipboard
inline fun copy(block: SignUpRequest.Builder.() -> Unit = {}): SignUpRequest
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String