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

Builder

class Builder

Properties

Link copied to clipboard
var analyticsMetadata: AnalyticsMetadataType?

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

Link copied to clipboard
var authFlow: AuthFlowType?

The authentication flow for this call to run. The API action will depend on this value. For example:

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

The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow:

Link copied to clipboard
var clientId: String?

The app client ID.

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

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

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.