cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/AdminInitiateAuthRequest

AdminInitiateAuthRequest

class AdminInitiateAuthRequest

Initiates the authorization request, as an administrator.

Types

Builder

class Builder

Companion

object Companion

Properties

analyticsMetadata

val analyticsMetadata: AnalyticsMetadataType?

The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.

authFlow

val authFlow: AuthFlowType?

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

authParameters

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

clientId

val clientId: String?

The app client ID.

clientMetadata

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

contextData

val contextData: ContextDataType?

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.

userPoolId

val userPoolId: String?

The ID of the Amazon Cognito user pool.

Functions

copy

inline fun copy(block: AdminInitiateAuthRequest.Builder.() -> Unit = {}): AdminInitiateAuthRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String