AWSCognitoIdentityProviderRespondToAuthChallengeRequest Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSCognitoIdentityProviderModel.h
AWSCognitoIdentityProviderModel.m

Overview

The request to respond to an authentication challenge.

Required parameters: [ClientId, ChallengeName]

  analyticsMetadata

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

@property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType *analyticsMetadata

Declared In

AWSCognitoIdentityProviderModel.h

  challengeName

The challenge name. For more information, see .

ADMIN_NO_SRP_AUTH is not a valid value.

@property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName

Declared In

AWSCognitoIdentityProviderModel.h

  challengeResponses

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

  • SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).

@property (nonatomic, strong) NSDictionary<NSString*NSString*> *challengeResponses

Declared In

AWSCognitoIdentityProviderModel.h

  clientId

The app client ID.

@property (nonatomic, strong) NSString *clientId

Declared In

AWSCognitoIdentityProviderModel.h

  session

The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

@property (nonatomic, strong) NSString *session

Declared In

AWSCognitoIdentityProviderModel.h

  userContextData

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

@property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType *userContextData

Declared In

AWSCognitoIdentityProviderModel.h