AWSCognitoIdentityProviderAdminRespondToAuthChallengeRequest

Objective-C

@interface AWSCognitoIdentityProviderAdminRespondToAuthChallengeRequest

Swift

class AWSCognitoIdentityProviderAdminRespondToAuthChallengeRequest

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

Required parameters: [UserPoolId, ClientId, ChallengeName]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType *_Nullable analyticsMetadata;

    Swift

    var analyticsMetadata: AWSCognitoIdentityProviderAnalyticsMetadataType? { get set }

  • The challenge name. For more information, see AdminInitiateAuth.

    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:

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

      PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.

    • ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).

    • 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 as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.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. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.

    • MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.

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

    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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:

    • pre sign-up

    • custom message

    • post authentication

    • user migration

    • pre token generation

    • define auth challenge

    • create auth challenge

    • verify auth challenge response

    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 that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata 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 }

  • 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) AWSCognitoIdentityProviderContextDataType *_Nullable contextData;

    Swift

    var contextData: AWSCognitoIdentityProviderContextDataType? { get set }

  • The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable session;

    Swift

    var session: String? { get set }

  • The ID of the Amazon Cognito user pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userPoolId;

    Swift

    var userPoolId: String? { get set }