cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/ForgotPasswordRequest/Builder

Builder

class Builder

Properties

Link copied to clipboard
var analyticsMetadata: AnalyticsMetadataType?

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

Link copied to clipboard
var clientId: String?

The ID of the client associated with the user pool.

Link copied to clipboard
var clientMetadata: Map<String, String>?

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
var secretHash: String?

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.

Link copied to clipboard
var userContextData: UserContextDataType?

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.

Link copied to clipboard
var username: String?

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.