AWSCognitoIdentityProviderRespondToAuthChallengeRequest
Objective-C
@interface AWSCognitoIdentityProviderRespondToAuthChallengeRequest
Swift
class AWSCognitoIdentityProviderRespondToAuthChallengeRequest
The request to respond to an authentication challenge.
Required parameters: [ClientId, ChallengeName]
-
The Amazon Pinpoint analytics metadata that contributes to your metrics for
RespondToAuthChallenge
calls.Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType *_Nullable analyticsMetadata;
Swift
var analyticsMetadata: AWSCognitoIdentityProviderAnalyticsMetadataType? { get set }
-
The challenge name. For more information, see InitiateAuth.
ADMIN_NO_SRP_AUTH
isn’t a valid value.Declaration
Objective-C
@property (nonatomic) AWSCognitoIdentityProviderChallengeNameType challengeName;
Swift
var challengeName: AWSCognitoIdentityProviderChallengeNameType { get set }
-
The challenge responses. These are inputs corresponding to the value of
ChallengeName
, for example:SECRET_HASH
(if app client is configured with client secret) applies to all of the inputs that follow (includingSOFTWARE_TOKEN_MFA
).SMS_MFA
:SMS_MFA_CODE
,USERNAME
.PASSWORD_VERIFIER
:PASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
,TIMESTAMP
,USERNAME
.PASSWORD_VERIFIER
requiresDEVICE_KEY
when you sign in with a remembered device.NEW_PASSWORD_REQUIRED
:NEW_PASSWORD
,USERNAME
,SECRET_HASH
(if app client is configured with client secret). To set any required attributes that Amazon Cognito returned asrequiredAttributes
in theInitiateAuth
response, add auserAttributes.attributename
parameter. This parameter can also set values for writable attributes that aren’t required by your user pool.In a
NEW_PASSWORD_REQUIRED
challenge response, you can’t modify a required attribute that already has a value. InRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theUpdateUserAttributes
API operation to modify the value of any additional attributes.SOFTWARE_TOKEN_MFA
:USERNAME
andSOFTWARE_TOKEN_MFA_CODE
are required attributes.DEVICE_SRP_AUTH
requiresUSERNAME
,DEVICE_KEY
,SRP_A
(andSECRET_HASH
).DEVICE_PASSWORD_VERIFIER
requires everything thatPASSWORD_VERIFIER
requires, plusDEVICE_KEY
.MFA_SETUP
requiresUSERNAME
, plus you must use the session value returned byVerifySoftwareToken
in theSession
parameter.
Declaration
Objective-C
@property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable challengeResponses;
Swift
var challengeResponses: [String : String]? { get set }
-
The app client ID.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable clientId;
Swift
var clientId: String? { get set }
-
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a
clientMetadata
attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process theclientMetadata
value to enhance your workflow for your specific needs.For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won’t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn’t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don’t use Amazon Cognito to provide sensitive information.
Declaration
Objective-C
@property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable clientMetadata;
Swift
var clientMetadata: [String : String]? { get set }
-
The session that should be passed both ways in challenge-response calls to the service. If
InitiateAuth
orRespondToAuthChallenge
API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the nextRespondToAuthChallenge
API call.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable session;
Swift
var session: String? { get set }
-
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.
Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType *_Nullable userContextData;
Swift
var userContextData: AWSCognitoIdentityProviderUserContextDataType? { get set }