Class AdminRespondToAuthChallengeRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AdminRespondToAuthChallengeRequest.Builder,
AdminRespondToAuthChallengeRequest>
The request to respond to the authentication challenge, as an administrator.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AnalyticsMetadataType
The analytics metadata for collecting Amazon Pinpoint metrics forAdminRespondToAuthChallenge
calls.builder()
final ChallengeNameType
The challenge name.final String
The challenge name.The responses to the challenge that you received in the previous request.final String
clientId()
The app client ID.A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.final ContextDataType
Contextual data about your user session, such as the device fingerprint, IP address, or location.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the ChallengeResponses property.final boolean
For responses, this returns true if the service returned a value for the ClientMetadata property.final int
hashCode()
static Class
<? extends AdminRespondToAuthChallengeRequest.Builder> final String
session()
The session that should be passed both ways in challenge-response calls to the service.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The ID of the Amazon Cognito user pool.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
userPoolId
The ID of the Amazon Cognito user pool.
- Returns:
- The ID of the Amazon Cognito user pool.
-
clientId
The app client ID.
- Returns:
- The app client ID.
-
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 returnChallengeNameType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchallengeNameAsString()
.- Returns:
- The challenge name. For more information, see AdminInitiateAuth.
- See Also:
-
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 returnChallengeNameType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchallengeNameAsString()
.- Returns:
- The challenge name. For more information, see AdminInitiateAuth.
- See Also:
-
hasChallengeResponses
public final boolean hasChallengeResponses()For responses, this returns true if the service returned a value for the ChallengeResponses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
challengeResponses
The responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.
You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret.
- SMS_MFA
-
"ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"}
- PASSWORD_VERIFIER
-
"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}
Add
"DEVICE_KEY"
when you sign in with a remembered device. - CUSTOM_CHALLENGE
-
"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}
Add
"DEVICE_KEY"
when you sign in with a remembered device. - NEW_PASSWORD_REQUIRED
-
"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}
To set any required attributes that
InitiateAuth
returned in anrequiredAttributes
parameter, add"userAttributes.[attribute_name]": "[attribute_value]"
. 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. InRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theUpdateUserAttributes
API operation to modify the value of any additional attributes. - SOFTWARE_TOKEN_MFA
-
"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses": {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": [authenticator_code]}
- DEVICE_SRP_AUTH
-
"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A": "[srp_a]"}
- DEVICE_PASSWORD_VERIFIER
-
"ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses": {"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}
- MFA_SETUP
-
"ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"
- SELECT_MFA_TYPE
-
"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"}
For more information about
SECRET_HASH
, see Computing secret hash values. For information aboutDEVICE_KEY
, see Working with user devices in your user pool.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasChallengeResponses()
method.- Returns:
- The responses to the challenge that you received in the previous request. Each challenge has its own
required response parameters. The following examples are partial JSON request bodies that highlight
challenge-response parameters.
You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret.
- SMS_MFA
-
"ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"}
- PASSWORD_VERIFIER
-
"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}
Add
"DEVICE_KEY"
when you sign in with a remembered device. - CUSTOM_CHALLENGE
-
"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}
Add
"DEVICE_KEY"
when you sign in with a remembered device. - NEW_PASSWORD_REQUIRED
-
"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}
To set any required attributes that
InitiateAuth
returned in anrequiredAttributes
parameter, add"userAttributes.[attribute_name]": "[attribute_value]"
. 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. InRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theUpdateUserAttributes
API operation to modify the value of any additional attributes. - SOFTWARE_TOKEN_MFA
-
"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses": {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": [authenticator_code]}
- DEVICE_SRP_AUTH
-
"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A": "[srp_a]"}
- DEVICE_PASSWORD_VERIFIER
-
"ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses": {"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}
- MFA_SETUP
-
"ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"
- SELECT_MFA_TYPE
-
"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"}
For more information about
SECRET_HASH
, see Computing secret hash values. For information aboutDEVICE_KEY
, see Working with user devices in your user pool.
-
session
The session that should be passed both ways in challenge-response calls to the service. If an
InitiateAuth
orRespondToAuthChallenge
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 nextRespondToAuthChallenge
API call.- Returns:
- The session that should be passed both ways in challenge-response calls to the service. If an
InitiateAuth
orRespondToAuthChallenge
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 nextRespondToAuthChallenge
API call.
-
analyticsMetadata
The analytics metadata for collecting Amazon Pinpoint metrics for
AdminRespondToAuthChallenge
calls.- Returns:
- The analytics metadata for collecting Amazon Pinpoint metrics for
AdminRespondToAuthChallenge
calls.
-
contextData
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.
- Returns:
- 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.
-
hasClientMetadata
public final boolean hasClientMetadata()For responses, this returns true if the service returned a value for the ClientMetadata property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
clientMetadata
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 theclientMetadata
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasClientMetadata()
method.- Returns:
- 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 theclientMetadata
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.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AdminRespondToAuthChallengeRequest.Builder,
AdminRespondToAuthChallengeRequest> - Specified by:
toBuilder
in classCognitoIdentityProviderRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AdminRespondToAuthChallengeRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-