@Generated(value="software.amazon.awssdk:codegen") public class AdminInitiateAuthResponse extends CognitoIdentityProviderResponse implements ToCopyableBuilder<AdminInitiateAuthResponse.Builder,AdminInitiateAuthResponse>
Initiates the authentication response, as an administrator.
Modifier and Type | Class and Description |
---|---|
static interface |
AdminInitiateAuthResponse.Builder |
Modifier and Type | Method and Description |
---|---|
AuthenticationResultType |
authenticationResult()
The result of the authentication response.
|
static AdminInitiateAuthResponse.Builder |
builder() |
ChallengeNameType |
challengeName()
The name of the challenge which you are responding to with this call.
|
String |
challengeNameString()
The name of the challenge which you are responding to with this call.
|
Map<String,String> |
challengeParameters()
The challenge parameters.
|
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
SdkResponse . |
int |
hashCode() |
static Class<? extends AdminInitiateAuthResponse.Builder> |
serializableBuilderClass() |
String |
session()
The session which should be passed both ways in challenge-response calls to the service.
|
AdminInitiateAuthResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public ChallengeNameType challengeName()
The name of the challenge which you are responding to with this call. This is returned to you in the
AdminInitiateAuth
response if you need to pass another challenge.
SMS_MFA
: Next challenge is to supply an SMS_MFA_CODE
, delivered via SMS.
PASSWORD_VERIFIER
: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE
,
PASSWORD_CLAIM_SECRET_BLOCK
, and TIMESTAMP
after the client-side SRP calculations.
CUSTOM_CHALLENGE
: This is returned if your custom authentication flow determines that the user
should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH
: If device tracking was enabled on your user pool and the previous challenges were
passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER
: Similar to PASSWORD_VERIFIER
, but for devices only.
ADMIN_NO_SRP_AUTH
: This is returned if you need to authenticate with USERNAME
and
PASSWORD
directly. An app client must be enabled to use this flow.
NEW_PASSWORD_REQUIRED
: For users which are required to change their passwords after successful first
login. This challenge should be passed with NEW_PASSWORD
and any other required attributes.
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 challengeNameString()
.
AdminInitiateAuth
response if you need to pass another challenge.
SMS_MFA
: Next challenge is to supply an SMS_MFA_CODE
, delivered via SMS.
PASSWORD_VERIFIER
: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE
,
PASSWORD_CLAIM_SECRET_BLOCK
, and TIMESTAMP
after the client-side SRP
calculations.
CUSTOM_CHALLENGE
: This is returned if your custom authentication flow determines that the
user should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH
: If device tracking was enabled on your user pool and the previous
challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER
: Similar to PASSWORD_VERIFIER
, but for devices only.
ADMIN_NO_SRP_AUTH
: This is returned if you need to authenticate with USERNAME
and PASSWORD
directly. An app client must be enabled to use this flow.
NEW_PASSWORD_REQUIRED
: For users which are required to change their passwords after
successful first login. This challenge should be passed with NEW_PASSWORD
and any other
required attributes.
ChallengeNameType
public String challengeNameString()
The name of the challenge which you are responding to with this call. This is returned to you in the
AdminInitiateAuth
response if you need to pass another challenge.
SMS_MFA
: Next challenge is to supply an SMS_MFA_CODE
, delivered via SMS.
PASSWORD_VERIFIER
: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE
,
PASSWORD_CLAIM_SECRET_BLOCK
, and TIMESTAMP
after the client-side SRP calculations.
CUSTOM_CHALLENGE
: This is returned if your custom authentication flow determines that the user
should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH
: If device tracking was enabled on your user pool and the previous challenges were
passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER
: Similar to PASSWORD_VERIFIER
, but for devices only.
ADMIN_NO_SRP_AUTH
: This is returned if you need to authenticate with USERNAME
and
PASSWORD
directly. An app client must be enabled to use this flow.
NEW_PASSWORD_REQUIRED
: For users which are required to change their passwords after successful first
login. This challenge should be passed with NEW_PASSWORD
and any other required attributes.
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 challengeNameString()
.
AdminInitiateAuth
response if you need to pass another challenge.
SMS_MFA
: Next challenge is to supply an SMS_MFA_CODE
, delivered via SMS.
PASSWORD_VERIFIER
: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE
,
PASSWORD_CLAIM_SECRET_BLOCK
, and TIMESTAMP
after the client-side SRP
calculations.
CUSTOM_CHALLENGE
: This is returned if your custom authentication flow determines that the
user should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH
: If device tracking was enabled on your user pool and the previous
challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER
: Similar to PASSWORD_VERIFIER
, but for devices only.
ADMIN_NO_SRP_AUTH
: This is returned if you need to authenticate with USERNAME
and PASSWORD
directly. An app client must be enabled to use this flow.
NEW_PASSWORD_REQUIRED
: For users which are required to change their passwords after
successful first login. This challenge should be passed with NEW_PASSWORD
and any other
required attributes.
ChallengeNameType
public String session()
The session which should be passed both ways in challenge-response calls to the service. If
AdminInitiateAuth
or AdminRespondToAuthChallenge
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 AdminRespondToAuthChallenge
API call.
AdminInitiateAuth
or AdminRespondToAuthChallenge
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 AdminRespondToAuthChallenge
API call.public Map<String,String> challengeParameters()
The challenge parameters. These are returned to you in the AdminInitiateAuth
response if you need to
pass another challenge. The responses in this parameter should be used to compute inputs to the next call (
AdminRespondToAuthChallenge
).
All challenges require USERNAME
and SECRET_HASH
(if applicable).
The value of the USER_IF_FOR_SRP
attribute will be the user's actual username, not an alias (such as
email address or phone number), even if you specified an alias in your call to AdminInitiateAuth
.
This is because, in the AdminRespondToAuthChallenge
API ChallengeResponses
, the
USERNAME
attribute cannot be an alias.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
AdminInitiateAuth
response if you
need to pass another challenge. The responses in this parameter should be used to compute inputs to the
next call (AdminRespondToAuthChallenge
).
All challenges require USERNAME
and SECRET_HASH
(if applicable).
The value of the USER_IF_FOR_SRP
attribute will be the user's actual username, not an alias
(such as email address or phone number), even if you specified an alias in your call to
AdminInitiateAuth
. This is because, in the AdminRespondToAuthChallenge
API
ChallengeResponses
, the USERNAME
attribute cannot be an alias.
public AuthenticationResultType authenticationResult()
The result of the authentication response. This is only returned if the caller does not need to pass another
challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName
,
ChallengeParameters
, and Session
are returned.
ChallengeName
, ChallengeParameters
, and Session
are returned.public AdminInitiateAuthResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<AdminInitiateAuthResponse.Builder,AdminInitiateAuthResponse>
toBuilder
in class AwsResponse
public static AdminInitiateAuthResponse.Builder builder()
public static Class<? extends AdminInitiateAuthResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. 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 SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- 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.