public static interface AdminRespondToAuthChallengeRequest.Builder extends CognitoIdentityProviderRequest.Builder, CopyableBuilder<AdminRespondToAuthChallengeRequest.Builder,AdminRespondToAuthChallengeRequest>
Modifier and Type | Method and Description |
---|---|
AdminRespondToAuthChallengeRequest.Builder |
challengeName(ChallengeNameType challengeName)
The challenge name.
|
AdminRespondToAuthChallengeRequest.Builder |
challengeName(String challengeName)
The challenge name.
|
AdminRespondToAuthChallengeRequest.Builder |
challengeResponses(Map<String,String> challengeResponses)
The challenge responses.
|
AdminRespondToAuthChallengeRequest.Builder |
clientId(String clientId)
The app client ID.
|
AdminRespondToAuthChallengeRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
AdminRespondToAuthChallengeRequest.Builder |
session(String session)
The session which should be passed both ways in challenge-response calls to the service.
|
AdminRespondToAuthChallengeRequest.Builder |
userPoolId(String userPoolId)
The ID of the Amazon Cognito user pool.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
AdminRespondToAuthChallengeRequest.Builder userPoolId(String userPoolId)
The ID of the Amazon Cognito user pool.
userPoolId
- The ID of the Amazon Cognito user pool.AdminRespondToAuthChallengeRequest.Builder clientId(String clientId)
The app client ID.
clientId
- The app client ID.AdminRespondToAuthChallengeRequest.Builder challengeName(String challengeName)
The challenge name. For more information, see AdminInitiateAuth.
challengeName
- The challenge name. For more information, see AdminInitiateAuth.ChallengeNameType
,
ChallengeNameType
AdminRespondToAuthChallengeRequest.Builder challengeName(ChallengeNameType challengeName)
The challenge name. For more information, see AdminInitiateAuth.
challengeName
- The challenge name. For more information, see AdminInitiateAuth.ChallengeNameType
,
ChallengeNameType
AdminRespondToAuthChallengeRequest.Builder challengeResponses(Map<String,String> 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
.
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
.
AdminRespondToAuthChallengeRequest.Builder session(String 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.
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.AdminRespondToAuthChallengeRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.