/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include The request to respond to the authentication challenge, as an
* administrator.See Also:
AWS
* API Reference
The ID of the Amazon Cognito user pool.
*/ inline const Aws::String& GetUserPoolId() const{ return m_userPoolId; } /** *The ID of the Amazon Cognito user pool.
*/ inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; } /** *The ID of the Amazon Cognito user pool.
*/ inline void SetUserPoolId(const Aws::String& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = value; } /** *The ID of the Amazon Cognito user pool.
*/ inline void SetUserPoolId(Aws::String&& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = std::move(value); } /** *The ID of the Amazon Cognito user pool.
*/ inline void SetUserPoolId(const char* value) { m_userPoolIdHasBeenSet = true; m_userPoolId.assign(value); } /** *The ID of the Amazon Cognito user pool.
*/ inline AdminRespondToAuthChallengeRequest& WithUserPoolId(const Aws::String& value) { SetUserPoolId(value); return *this;} /** *The ID of the Amazon Cognito user pool.
*/ inline AdminRespondToAuthChallengeRequest& WithUserPoolId(Aws::String&& value) { SetUserPoolId(std::move(value)); return *this;} /** *The ID of the Amazon Cognito user pool.
*/ inline AdminRespondToAuthChallengeRequest& WithUserPoolId(const char* value) { SetUserPoolId(value); return *this;} /** *The app client ID.
*/ inline const Aws::String& GetClientId() const{ return m_clientId; } /** *The app client ID.
*/ inline bool ClientIdHasBeenSet() const { return m_clientIdHasBeenSet; } /** *The app client ID.
*/ inline void SetClientId(const Aws::String& value) { m_clientIdHasBeenSet = true; m_clientId = value; } /** *The app client ID.
*/ inline void SetClientId(Aws::String&& value) { m_clientIdHasBeenSet = true; m_clientId = std::move(value); } /** *The app client ID.
*/ inline void SetClientId(const char* value) { m_clientIdHasBeenSet = true; m_clientId.assign(value); } /** *The app client ID.
*/ inline AdminRespondToAuthChallengeRequest& WithClientId(const Aws::String& value) { SetClientId(value); return *this;} /** *The app client ID.
*/ inline AdminRespondToAuthChallengeRequest& WithClientId(Aws::String&& value) { SetClientId(std::move(value)); return *this;} /** *The app client ID.
*/ inline AdminRespondToAuthChallengeRequest& WithClientId(const char* value) { SetClientId(value); return *this;} /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline const ChallengeNameType& GetChallengeName() const{ return m_challengeName; } /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline bool ChallengeNameHasBeenSet() const { return m_challengeNameHasBeenSet; } /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline void SetChallengeName(const ChallengeNameType& value) { m_challengeNameHasBeenSet = true; m_challengeName = value; } /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline void SetChallengeName(ChallengeNameType&& value) { m_challengeNameHasBeenSet = true; m_challengeName = std::move(value); } /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline AdminRespondToAuthChallengeRequest& WithChallengeName(const ChallengeNameType& value) { SetChallengeName(value); return *this;} /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline AdminRespondToAuthChallengeRequest& WithChallengeName(ChallengeNameType&& value) { SetChallengeName(std::move(value)); return *this;} /** *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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
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).
PASSWORD_VERIFIER
requires
* DEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
: PASSWORD
,
* USERNAME
, SECRET_HASH
(if app client is configured
* with client secret).
NEW_PASSWORD_REQUIRED
:
* NEW_PASSWORD
, USERNAME
, SECRET_HASH
(if
* app client is configured with client secret). To set any required attributes
* that Amazon Cognito returned as requiredAttributes
in the
* AdminInitiateAuth
response, add a
* userAttributes.attributename
parameter. 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. In
* AdminRespondToAuthChallenge
, set a value for any keys that Amazon
* Cognito returned in the requiredAttributes
parameter, then use the
* AdminUpdateUserAttributes
API operation to modify the value of any
* additional attributes.
MFA_SETUP
* requires USERNAME
, plus you must use the session value returned by
* VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the
* user's actual username, not an alias (such as an email address or phone number).
* To make this simpler, the AdminInitiateAuth
response includes the
* actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute.
* This happens even if you specified an alias in your call to
* AdminInitiateAuth
.
The session that should be passed both ways in challenge-response calls to
* the service. If an InitiateAuth
or
* RespondToAuthChallenge
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 next
* RespondToAuthChallenge
API call.
The session that should be passed both ways in challenge-response calls to
* the service. If an InitiateAuth
or
* RespondToAuthChallenge
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 next
* RespondToAuthChallenge
API call.
The session that should be passed both ways in challenge-response calls to
* the service. If an InitiateAuth
or
* RespondToAuthChallenge
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 next
* RespondToAuthChallenge
API call.
The session that should be passed both ways in challenge-response calls to
* the service. If an InitiateAuth
or
* RespondToAuthChallenge
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 next
* RespondToAuthChallenge
API call.
The session that should be passed both ways in challenge-response calls to
* the service. If an InitiateAuth
or
* RespondToAuthChallenge
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 next
* RespondToAuthChallenge
API call.
The session that should be passed both ways in challenge-response calls to
* the service. If an InitiateAuth
or
* RespondToAuthChallenge
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 next
* RespondToAuthChallenge
API call.
The session that should be passed both ways in challenge-response calls to
* the service. If an InitiateAuth
or
* RespondToAuthChallenge
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 next
* RespondToAuthChallenge
API call.
The session that should be passed both ways in challenge-response calls to
* the service. If an InitiateAuth
or
* RespondToAuthChallenge
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 next
* RespondToAuthChallenge
API call.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge
calls.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge
calls.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge
calls.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge
calls.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge
calls.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge
calls.
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.
*/ inline const ContextDataType& GetContextData() const{ return m_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.
*/ inline bool ContextDataHasBeenSet() const { return m_contextDataHasBeenSet; } /** *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.
*/ inline void SetContextData(const ContextDataType& value) { m_contextDataHasBeenSet = true; m_contextData = value; } /** *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.
*/ inline void SetContextData(ContextDataType&& value) { m_contextDataHasBeenSet = true; m_contextData = std::move(value); } /** *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.
*/ inline AdminRespondToAuthChallengeRequest& WithContextData(const ContextDataType& value) { SetContextData(value); return *this;} /** *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.
*/ inline AdminRespondToAuthChallengeRequest& WithContextData(ContextDataType&& value) { SetContextData(std::move(value)); return *this;} /** *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 the clientMetadata
* 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.
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 the clientMetadata
* 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.
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 the clientMetadata
* 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.
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 the clientMetadata
* 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.
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 the clientMetadata
* 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.
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 the clientMetadata
* 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.
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 the clientMetadata
* 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.
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 the clientMetadata
* 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.
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 the clientMetadata
* 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.
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 the clientMetadata
* 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.
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 the clientMetadata
* 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.
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 the clientMetadata
* 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.
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 the clientMetadata
* 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.