AWSCognitoIdentityProviderAdminRespondToAuthChallengeRequest Class Reference

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

Overview

The request to respond to the authentication challenge, as an administrator.

Required parameters: [UserPoolId, ClientId, ChallengeName]

  analyticsMetadata

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

@property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType *analyticsMetadata

Declared In

AWSCognitoIdentityProviderModel.h

  challengeName

The challenge name. For more information, see .

@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).

  • ADMIN_NO_SRP_AUTH: PASSWORD, 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).

The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.

@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

  contextData

@property (nonatomic, strong) AWSCognitoIdentityProviderContextDataType *contextData

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

  userPoolId

The ID of the Amazon Cognito user pool.

@property (nonatomic, strong) NSString *userPoolId

Declared In

AWSCognitoIdentityProviderModel.h