@Generated(value="software.amazon.awssdk:codegen") public final class AdminRespondToAuthChallengeRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<AdminRespondToAuthChallengeRequest.Builder,AdminRespondToAuthChallengeRequest>
The request to respond to the authentication challenge, as an administrator.
| Modifier and Type | Class and Description |
|---|---|
static interface |
AdminRespondToAuthChallengeRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static AdminRespondToAuthChallengeRequest.Builder |
builder() |
ChallengeNameType |
challengeName()
The challenge name.
|
String |
challengeNameAsString()
The challenge name.
|
Map<String,String> |
challengeResponses()
The challenge responses.
|
String |
clientId()
The app client ID.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
static Class<? extends AdminRespondToAuthChallengeRequest.Builder> |
serializableBuilderClass() |
String |
session()
The session which should be passed both ways in challenge-response calls to the service.
|
AdminRespondToAuthChallengeRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
userPoolId()
The ID of the Amazon Cognito user pool.
|
overrideConfigurationcopypublic String userPoolId()
The ID of the Amazon Cognito user pool.
public String clientId()
The app client ID.
public ChallengeNameType challengeName()
The challenge name. For more information, see AdminInitiateAuth.
If the service returns an enum value that is not available in the current SDK version, challengeName
will return ChallengeNameType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from challengeNameAsString().
ChallengeNameTypepublic String challengeNameAsString()
The challenge name. For more information, see AdminInitiateAuth.
If the service returns an enum value that is not available in the current SDK version, challengeName
will return ChallengeNameType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from challengeNameAsString().
ChallengeNameTypepublic 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public 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.
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.public AdminRespondToAuthChallengeRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<AdminRespondToAuthChallengeRequest.Builder,AdminRespondToAuthChallengeRequest>toBuilder in class CognitoIdentityProviderRequestpublic static AdminRespondToAuthChallengeRequest.Builder builder()
public static Class<? extends AdminRespondToAuthChallengeRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.