@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class InitiateAuthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Initiates the authentication response.
| Constructor and Description |
|---|
InitiateAuthResult() |
| Modifier and Type | Method and Description |
|---|---|
InitiateAuthResult |
addChallengeParametersEntry(String key,
String value)
Add a single ChallengeParameters entry
|
InitiateAuthResult |
clearChallengeParametersEntries()
Removes all the entries added into ChallengeParameters.
|
InitiateAuthResult |
clone() |
boolean |
equals(Object obj) |
AuthenticationResultType |
getAuthenticationResult()
The result of the authentication response.
|
String |
getChallengeName()
The name of the challenge that you're responding to with this call.
|
Map<String,String> |
getChallengeParameters()
The challenge parameters.
|
String |
getSession()
The session that should pass both ways in challenge-response calls to the service.
|
int |
hashCode() |
void |
setAuthenticationResult(AuthenticationResultType authenticationResult)
The result of the authentication response.
|
void |
setChallengeName(ChallengeNameType challengeName)
The name of the challenge that you're responding to with this call.
|
void |
setChallengeName(String challengeName)
The name of the challenge that you're responding to with this call.
|
void |
setChallengeParameters(Map<String,String> challengeParameters)
The challenge parameters.
|
void |
setSession(String session)
The session that should pass both ways in challenge-response calls to the service.
|
String |
toString()
Returns a string representation of this object.
|
InitiateAuthResult |
withAuthenticationResult(AuthenticationResultType authenticationResult)
The result of the authentication response.
|
InitiateAuthResult |
withChallengeName(ChallengeNameType challengeName)
The name of the challenge that you're responding to with this call.
|
InitiateAuthResult |
withChallengeName(String challengeName)
The name of the challenge that you're responding to with this call.
|
InitiateAuthResult |
withChallengeParameters(Map<String,String> challengeParameters)
The challenge parameters.
|
InitiateAuthResult |
withSession(String session)
The session that should pass both ways in challenge-response calls to the service.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadatapublic void setChallengeName(String challengeName)
The name of the challenge that you're responding to with this call. This name is returned in the
AdminInitiateAuth response if you must pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
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 activated 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.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first
login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types
activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to
RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS
MFA, an administrator should help the user to add a phone number to their account, and then the user should call
InitiateAuth again to restart sign-in.
challengeName - The name of the challenge that you're responding to with this call. This name is returned in the
AdminInitiateAuth response if you must pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
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 activated 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.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful
first login. This challenge should be passed with NEW_PASSWORD and any other required
attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA
types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP
value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an
input to RespondToAuthChallenge with challenge name MFA_SETUP to complete
sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account,
and then the user should call InitiateAuth again to restart sign-in.
ChallengeNameTypepublic String getChallengeName()
The name of the challenge that you're responding to with this call. This name is returned in the
AdminInitiateAuth response if you must pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
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 activated 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.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first
login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types
activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to
RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS
MFA, an administrator should help the user to add a phone number to their account, and then the user should call
InitiateAuth again to restart sign-in.
AdminInitiateAuth response if you must pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
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 activated 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.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful
first login. This challenge should be passed with NEW_PASSWORD and any other required
attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The
MFA types activated for the user pool will be listed in the challenge parameters
MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an
input to RespondToAuthChallenge with challenge name MFA_SETUP to complete
sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account,
and then the user should call InitiateAuth again to restart sign-in.
ChallengeNameTypepublic InitiateAuthResult withChallengeName(String challengeName)
The name of the challenge that you're responding to with this call. This name is returned in the
AdminInitiateAuth response if you must pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
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 activated 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.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first
login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types
activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to
RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS
MFA, an administrator should help the user to add a phone number to their account, and then the user should call
InitiateAuth again to restart sign-in.
challengeName - The name of the challenge that you're responding to with this call. This name is returned in the
AdminInitiateAuth response if you must pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
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 activated 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.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful
first login. This challenge should be passed with NEW_PASSWORD and any other required
attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA
types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP
value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an
input to RespondToAuthChallenge with challenge name MFA_SETUP to complete
sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account,
and then the user should call InitiateAuth again to restart sign-in.
ChallengeNameTypepublic void setChallengeName(ChallengeNameType challengeName)
The name of the challenge that you're responding to with this call. This name is returned in the
AdminInitiateAuth response if you must pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
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 activated 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.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first
login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types
activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to
RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS
MFA, an administrator should help the user to add a phone number to their account, and then the user should call
InitiateAuth again to restart sign-in.
challengeName - The name of the challenge that you're responding to with this call. This name is returned in the
AdminInitiateAuth response if you must pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
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 activated 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.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful
first login. This challenge should be passed with NEW_PASSWORD and any other required
attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA
types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP
value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an
input to RespondToAuthChallenge with challenge name MFA_SETUP to complete
sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account,
and then the user should call InitiateAuth again to restart sign-in.
ChallengeNameTypepublic InitiateAuthResult withChallengeName(ChallengeNameType challengeName)
The name of the challenge that you're responding to with this call. This name is returned in the
AdminInitiateAuth response if you must pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
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 activated 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.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first
login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types
activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to
RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS
MFA, an administrator should help the user to add a phone number to their account, and then the user should call
InitiateAuth again to restart sign-in.
challengeName - The name of the challenge that you're responding to with this call. This name is returned in the
AdminInitiateAuth response if you must pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
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 activated 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.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful
first login. This challenge should be passed with NEW_PASSWORD and any other required
attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA
types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP
value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an
input to RespondToAuthChallenge with challenge name MFA_SETUP to complete
sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account,
and then the user should call InitiateAuth again to restart sign-in.
ChallengeNameTypepublic void setSession(String session)
The session that should pass both ways in challenge-response calls to the service. If the caller must pass
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 that should pass both ways in challenge-response calls to the service. If the caller must pass
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 String getSession()
The session that should pass both ways in challenge-response calls to the service. If the caller must pass
another challenge, they return a session with other challenge parameters. This session should be passed as it is
to the next RespondToAuthChallenge API call.
RespondToAuthChallenge API call.public InitiateAuthResult withSession(String session)
The session that should pass both ways in challenge-response calls to the service. If the caller must pass
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 that should pass both ways in challenge-response calls to the service. If the caller must pass
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 Map<String,String> getChallengeParameters()
The challenge parameters. These are returned in the InitiateAuth response if you must pass another
challenge. The responses in this parameter should be used to compute inputs to the next call (
RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
InitiateAuth response if you must pass
another challenge. The responses in this parameter should be used to compute inputs to the next call (
RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
public void setChallengeParameters(Map<String,String> challengeParameters)
The challenge parameters. These are returned in the InitiateAuth response if you must pass another
challenge. The responses in this parameter should be used to compute inputs to the next call (
RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
challengeParameters - The challenge parameters. These are returned in the InitiateAuth response if you must pass
another challenge. The responses in this parameter should be used to compute inputs to the next call (
RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
public InitiateAuthResult withChallengeParameters(Map<String,String> challengeParameters)
The challenge parameters. These are returned in the InitiateAuth response if you must pass another
challenge. The responses in this parameter should be used to compute inputs to the next call (
RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
challengeParameters - The challenge parameters. These are returned in the InitiateAuth response if you must pass
another challenge. The responses in this parameter should be used to compute inputs to the next call (
RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
public InitiateAuthResult addChallengeParametersEntry(String key, String value)
public InitiateAuthResult clearChallengeParametersEntries()
public void setAuthenticationResult(AuthenticationResultType authenticationResult)
The result of the authentication response. This result is only returned if the caller doesn't need to pass
another challenge. If the caller does need to pass another challenge before it gets tokens,
ChallengeName, ChallengeParameters, and Session are returned.
authenticationResult - The result of the authentication response. This result is only returned if the caller doesn't need to pass
another challenge. If the caller does need to pass another challenge before it gets tokens,
ChallengeName, ChallengeParameters, and Session are returned.public AuthenticationResultType getAuthenticationResult()
The result of the authentication response. This result is only returned if the caller doesn't 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 InitiateAuthResult withAuthenticationResult(AuthenticationResultType authenticationResult)
The result of the authentication response. This result is only returned if the caller doesn't need to pass
another challenge. If the caller does need to pass another challenge before it gets tokens,
ChallengeName, ChallengeParameters, and Session are returned.
authenticationResult - The result of the authentication response. This result is only returned if the caller doesn't need to pass
another challenge. If the caller does need to pass another challenge before it gets tokens,
ChallengeName, ChallengeParameters, and Session are returned.public String toString()
toString in class ObjectObject.toString()public InitiateAuthResult clone()
Copyright © 2022. All rights reserved.