1023 lines
68 KiB
C
1023 lines
68 KiB
C
|
/**
|
|||
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|||
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
#pragma once
|
|||
|
|
#include <aws/cognito-idp/CognitoIdentityProvider_EXPORTS.h>
|
|||
|
|
#include <aws/cognito-idp/CognitoIdentityProviderRequest.h>
|
|||
|
|
#include <aws/cognito-idp/model/AuthFlowType.h>
|
|||
|
|
#include <aws/core/utils/memory/stl/AWSMap.h>
|
|||
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|||
|
|
#include <aws/cognito-idp/model/AnalyticsMetadataType.h>
|
|||
|
|
#include <aws/cognito-idp/model/UserContextDataType.h>
|
|||
|
|
#include <utility>
|
|||
|
|
|
|||
|
|
namespace Aws
|
|||
|
|
{
|
|||
|
|
namespace CognitoIdentityProvider
|
|||
|
|
{
|
|||
|
|
namespace Model
|
|||
|
|
{
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Initiates the authentication request.</p><p><h3>See Also:</h3> <a
|
|||
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/InitiateAuthRequest">AWS
|
|||
|
|
* API Reference</a></p>
|
|||
|
|
*/
|
|||
|
|
class AWS_COGNITOIDENTITYPROVIDER_API InitiateAuthRequest : public CognitoIdentityProviderRequest
|
|||
|
|
{
|
|||
|
|
public:
|
|||
|
|
InitiateAuthRequest();
|
|||
|
|
|
|||
|
|
// Service request name is the Operation name which will send this request out,
|
|||
|
|
// each operation should has unique request name, so that we can get operation's name from this request.
|
|||
|
|
// Note: this is not true for response, multiple operations may have the same response name,
|
|||
|
|
// so we can not get operation's name from response.
|
|||
|
|
inline virtual const char* GetServiceRequestName() const override { return "InitiateAuth"; }
|
|||
|
|
|
|||
|
|
Aws::String SerializePayload() const override;
|
|||
|
|
|
|||
|
|
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication flow for this call to execute. The API action will depend
|
|||
|
|
* on this value. For example: </p> <ul> <li> <p> <code>REFRESH_TOKEN_AUTH</code>
|
|||
|
|
* will take in a valid refresh token and return new tokens.</p> </li> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and
|
|||
|
|
* <code>SRP_A</code> and return the SRP variables to be used for next challenge
|
|||
|
|
* execution.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code> will take in
|
|||
|
|
* <code>USERNAME</code> and <code>PASSWORD</code> and return the next challenge or
|
|||
|
|
* tokens.</p> </li> </ul> <p>Valid values include:</p> <ul> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password
|
|||
|
|
* (SRP) protocol.</p> </li> <li> <p>
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow
|
|||
|
|
* for refreshing the access token and ID token by supplying a valid refresh
|
|||
|
|
* token.</p> </li> <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication
|
|||
|
|
* flow.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code>: Non-SRP authentication
|
|||
|
|
* flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda
|
|||
|
|
* trigger is set, this flow will invoke the user migration Lambda if the USERNAME
|
|||
|
|
* is not found in the user pool. </p> </li> <li> <p>
|
|||
|
|
* <code>ADMIN_USER_PASSWORD_AUTH</code>: Admin-based user password authentication.
|
|||
|
|
* This replaces the <code>ADMIN_NO_SRP_AUTH</code> authentication flow. In this
|
|||
|
|
* flow, Cognito receives the password in the request instead of using the SRP
|
|||
|
|
* process to verify passwords.</p> </li> </ul> <p> <code>ADMIN_NO_SRP_AUTH</code>
|
|||
|
|
* is not a valid value.</p>
|
|||
|
|
*/
|
|||
|
|
inline const AuthFlowType& GetAuthFlow() const{ return m_authFlow; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication flow for this call to execute. The API action will depend
|
|||
|
|
* on this value. For example: </p> <ul> <li> <p> <code>REFRESH_TOKEN_AUTH</code>
|
|||
|
|
* will take in a valid refresh token and return new tokens.</p> </li> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and
|
|||
|
|
* <code>SRP_A</code> and return the SRP variables to be used for next challenge
|
|||
|
|
* execution.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code> will take in
|
|||
|
|
* <code>USERNAME</code> and <code>PASSWORD</code> and return the next challenge or
|
|||
|
|
* tokens.</p> </li> </ul> <p>Valid values include:</p> <ul> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password
|
|||
|
|
* (SRP) protocol.</p> </li> <li> <p>
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow
|
|||
|
|
* for refreshing the access token and ID token by supplying a valid refresh
|
|||
|
|
* token.</p> </li> <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication
|
|||
|
|
* flow.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code>: Non-SRP authentication
|
|||
|
|
* flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda
|
|||
|
|
* trigger is set, this flow will invoke the user migration Lambda if the USERNAME
|
|||
|
|
* is not found in the user pool. </p> </li> <li> <p>
|
|||
|
|
* <code>ADMIN_USER_PASSWORD_AUTH</code>: Admin-based user password authentication.
|
|||
|
|
* This replaces the <code>ADMIN_NO_SRP_AUTH</code> authentication flow. In this
|
|||
|
|
* flow, Cognito receives the password in the request instead of using the SRP
|
|||
|
|
* process to verify passwords.</p> </li> </ul> <p> <code>ADMIN_NO_SRP_AUTH</code>
|
|||
|
|
* is not a valid value.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool AuthFlowHasBeenSet() const { return m_authFlowHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication flow for this call to execute. The API action will depend
|
|||
|
|
* on this value. For example: </p> <ul> <li> <p> <code>REFRESH_TOKEN_AUTH</code>
|
|||
|
|
* will take in a valid refresh token and return new tokens.</p> </li> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and
|
|||
|
|
* <code>SRP_A</code> and return the SRP variables to be used for next challenge
|
|||
|
|
* execution.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code> will take in
|
|||
|
|
* <code>USERNAME</code> and <code>PASSWORD</code> and return the next challenge or
|
|||
|
|
* tokens.</p> </li> </ul> <p>Valid values include:</p> <ul> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password
|
|||
|
|
* (SRP) protocol.</p> </li> <li> <p>
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow
|
|||
|
|
* for refreshing the access token and ID token by supplying a valid refresh
|
|||
|
|
* token.</p> </li> <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication
|
|||
|
|
* flow.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code>: Non-SRP authentication
|
|||
|
|
* flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda
|
|||
|
|
* trigger is set, this flow will invoke the user migration Lambda if the USERNAME
|
|||
|
|
* is not found in the user pool. </p> </li> <li> <p>
|
|||
|
|
* <code>ADMIN_USER_PASSWORD_AUTH</code>: Admin-based user password authentication.
|
|||
|
|
* This replaces the <code>ADMIN_NO_SRP_AUTH</code> authentication flow. In this
|
|||
|
|
* flow, Cognito receives the password in the request instead of using the SRP
|
|||
|
|
* process to verify passwords.</p> </li> </ul> <p> <code>ADMIN_NO_SRP_AUTH</code>
|
|||
|
|
* is not a valid value.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetAuthFlow(const AuthFlowType& value) { m_authFlowHasBeenSet = true; m_authFlow = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication flow for this call to execute. The API action will depend
|
|||
|
|
* on this value. For example: </p> <ul> <li> <p> <code>REFRESH_TOKEN_AUTH</code>
|
|||
|
|
* will take in a valid refresh token and return new tokens.</p> </li> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and
|
|||
|
|
* <code>SRP_A</code> and return the SRP variables to be used for next challenge
|
|||
|
|
* execution.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code> will take in
|
|||
|
|
* <code>USERNAME</code> and <code>PASSWORD</code> and return the next challenge or
|
|||
|
|
* tokens.</p> </li> </ul> <p>Valid values include:</p> <ul> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password
|
|||
|
|
* (SRP) protocol.</p> </li> <li> <p>
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow
|
|||
|
|
* for refreshing the access token and ID token by supplying a valid refresh
|
|||
|
|
* token.</p> </li> <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication
|
|||
|
|
* flow.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code>: Non-SRP authentication
|
|||
|
|
* flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda
|
|||
|
|
* trigger is set, this flow will invoke the user migration Lambda if the USERNAME
|
|||
|
|
* is not found in the user pool. </p> </li> <li> <p>
|
|||
|
|
* <code>ADMIN_USER_PASSWORD_AUTH</code>: Admin-based user password authentication.
|
|||
|
|
* This replaces the <code>ADMIN_NO_SRP_AUTH</code> authentication flow. In this
|
|||
|
|
* flow, Cognito receives the password in the request instead of using the SRP
|
|||
|
|
* process to verify passwords.</p> </li> </ul> <p> <code>ADMIN_NO_SRP_AUTH</code>
|
|||
|
|
* is not a valid value.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetAuthFlow(AuthFlowType&& value) { m_authFlowHasBeenSet = true; m_authFlow = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication flow for this call to execute. The API action will depend
|
|||
|
|
* on this value. For example: </p> <ul> <li> <p> <code>REFRESH_TOKEN_AUTH</code>
|
|||
|
|
* will take in a valid refresh token and return new tokens.</p> </li> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and
|
|||
|
|
* <code>SRP_A</code> and return the SRP variables to be used for next challenge
|
|||
|
|
* execution.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code> will take in
|
|||
|
|
* <code>USERNAME</code> and <code>PASSWORD</code> and return the next challenge or
|
|||
|
|
* tokens.</p> </li> </ul> <p>Valid values include:</p> <ul> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password
|
|||
|
|
* (SRP) protocol.</p> </li> <li> <p>
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow
|
|||
|
|
* for refreshing the access token and ID token by supplying a valid refresh
|
|||
|
|
* token.</p> </li> <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication
|
|||
|
|
* flow.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code>: Non-SRP authentication
|
|||
|
|
* flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda
|
|||
|
|
* trigger is set, this flow will invoke the user migration Lambda if the USERNAME
|
|||
|
|
* is not found in the user pool. </p> </li> <li> <p>
|
|||
|
|
* <code>ADMIN_USER_PASSWORD_AUTH</code>: Admin-based user password authentication.
|
|||
|
|
* This replaces the <code>ADMIN_NO_SRP_AUTH</code> authentication flow. In this
|
|||
|
|
* flow, Cognito receives the password in the request instead of using the SRP
|
|||
|
|
* process to verify passwords.</p> </li> </ul> <p> <code>ADMIN_NO_SRP_AUTH</code>
|
|||
|
|
* is not a valid value.</p>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithAuthFlow(const AuthFlowType& value) { SetAuthFlow(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication flow for this call to execute. The API action will depend
|
|||
|
|
* on this value. For example: </p> <ul> <li> <p> <code>REFRESH_TOKEN_AUTH</code>
|
|||
|
|
* will take in a valid refresh token and return new tokens.</p> </li> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and
|
|||
|
|
* <code>SRP_A</code> and return the SRP variables to be used for next challenge
|
|||
|
|
* execution.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code> will take in
|
|||
|
|
* <code>USERNAME</code> and <code>PASSWORD</code> and return the next challenge or
|
|||
|
|
* tokens.</p> </li> </ul> <p>Valid values include:</p> <ul> <li> <p>
|
|||
|
|
* <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password
|
|||
|
|
* (SRP) protocol.</p> </li> <li> <p>
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow
|
|||
|
|
* for refreshing the access token and ID token by supplying a valid refresh
|
|||
|
|
* token.</p> </li> <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication
|
|||
|
|
* flow.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code>: Non-SRP authentication
|
|||
|
|
* flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda
|
|||
|
|
* trigger is set, this flow will invoke the user migration Lambda if the USERNAME
|
|||
|
|
* is not found in the user pool. </p> </li> <li> <p>
|
|||
|
|
* <code>ADMIN_USER_PASSWORD_AUTH</code>: Admin-based user password authentication.
|
|||
|
|
* This replaces the <code>ADMIN_NO_SRP_AUTH</code> authentication flow. In this
|
|||
|
|
* flow, Cognito receives the password in the request instead of using the SRP
|
|||
|
|
* process to verify passwords.</p> </li> </ul> <p> <code>ADMIN_NO_SRP_AUTH</code>
|
|||
|
|
* is not a valid value.</p>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithAuthFlow(AuthFlowType&& value) { SetAuthFlow(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::Map<Aws::String, Aws::String>& GetAuthParameters() const{ return m_authParameters; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline bool AuthParametersHasBeenSet() const { return m_authParametersHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline void SetAuthParameters(const Aws::Map<Aws::String, Aws::String>& value) { m_authParametersHasBeenSet = true; m_authParameters = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline void SetAuthParameters(Aws::Map<Aws::String, Aws::String>&& value) { m_authParametersHasBeenSet = true; m_authParameters = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithAuthParameters(const Aws::Map<Aws::String, Aws::String>& value) { SetAuthParameters(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithAuthParameters(Aws::Map<Aws::String, Aws::String>&& value) { SetAuthParameters(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddAuthParameters(const Aws::String& key, const Aws::String& value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(key, value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddAuthParameters(Aws::String&& key, const Aws::String& value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(std::move(key), value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddAuthParameters(const Aws::String& key, Aws::String&& value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(key, std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddAuthParameters(Aws::String&& key, Aws::String&& value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(std::move(key), std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddAuthParameters(const char* key, Aws::String&& value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(key, std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddAuthParameters(Aws::String&& key, const char* value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(std::move(key), value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|||
|
|
* <code>AuthFlow</code> that you are invoking. The required values depend on the
|
|||
|
|
* value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>:
|
|||
|
|
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (required if the app client is configured with a client
|
|||
|
|
* secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|||
|
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|||
|
|
* with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For
|
|||
|
|
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|||
|
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|||
|
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|||
|
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|||
|
|
* SRP_A Value)</code>.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddAuthParameters(const char* key, const char* value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(key, value); return *this; }
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::Map<Aws::String, Aws::String>& GetClientMetadata() const{ return m_clientMetadata; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline bool ClientMetadataHasBeenSet() const { return m_clientMetadataHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline void SetClientMetadata(const Aws::Map<Aws::String, Aws::String>& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline void SetClientMetadata(Aws::Map<Aws::String, Aws::String>&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithClientMetadata(const Aws::Map<Aws::String, Aws::String>& value) { SetClientMetadata(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithClientMetadata(Aws::Map<Aws::String, Aws::String>&& value) { SetClientMetadata(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddClientMetadata(const Aws::String& key, const Aws::String& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddClientMetadata(Aws::String&& key, const Aws::String& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddClientMetadata(const Aws::String& key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddClientMetadata(Aws::String&& key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddClientMetadata(const char* key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddClientMetadata(Aws::String&& key, const char* value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of custom key-value pairs that you can provide as input for certain
|
|||
|
|
* custom workflows that this action triggers.</p> <p>You create custom workflows
|
|||
|
|
* by assigning AWS Lambda functions to user pool triggers. When you use the
|
|||
|
|
* InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that
|
|||
|
|
* are specified for various triggers. The ClientMetadata value is passed as input
|
|||
|
|
* to the functions for only the following triggers:</p> <ul> <li> <p>Pre
|
|||
|
|
* signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p>
|
|||
|
|
* </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it
|
|||
|
|
* passes a JSON payload, which the function receives as input. This payload
|
|||
|
|
* contains a <code>validationData</code> attribute, which provides the data that
|
|||
|
|
* you assigned to the ClientMetadata parameter in your InitiateAuth request. In
|
|||
|
|
* your function code in AWS Lambda, you can process the
|
|||
|
|
* <code>validationData</code> value to enhance your workflow for your specific
|
|||
|
|
* needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
|
|||
|
|
* invokes the functions for the following triggers, but it does not provide the
|
|||
|
|
* ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
|
|||
|
|
* <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
|
|||
|
|
* <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
|
|||
|
|
* <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
|
|||
|
|
* User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
|
|||
|
|
* Guide</i>.</p> <p>Take the following limitations into consideration when
|
|||
|
|
* you use the ClientMetadata parameter:</p> <ul> <li> <p>Amazon Cognito does not
|
|||
|
|
* store the ClientMetadata value. This data is available only to AWS Lambda
|
|||
|
|
* triggers that are assigned to a user pool to support custom workflows. If your
|
|||
|
|
* user pool configuration does not include triggers, the ClientMetadata parameter
|
|||
|
|
* serves no purpose.</p> </li> <li> <p>Amazon Cognito does not validate the
|
|||
|
|
* ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
|
|||
|
|
* ClientMetadata value, so don't use it to provide sensitive information.</p>
|
|||
|
|
* </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& AddClientMetadata(const char* key, const char* value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, value); return *this; }
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The app client ID.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetClientId() const{ return m_clientId; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The app client ID.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool ClientIdHasBeenSet() const { return m_clientIdHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The app client ID.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetClientId(const Aws::String& value) { m_clientIdHasBeenSet = true; m_clientId = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The app client ID.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetClientId(Aws::String&& value) { m_clientIdHasBeenSet = true; m_clientId = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The app client ID.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetClientId(const char* value) { m_clientIdHasBeenSet = true; m_clientId.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The app client ID.</p>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithClientId(const Aws::String& value) { SetClientId(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The app client ID.</p>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithClientId(Aws::String&& value) { SetClientId(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The app client ID.</p>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithClientId(const char* value) { SetClientId(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Pinpoint analytics metadata for collecting metrics for
|
|||
|
|
* <code>InitiateAuth</code> calls.</p>
|
|||
|
|
*/
|
|||
|
|
inline const AnalyticsMetadataType& GetAnalyticsMetadata() const{ return m_analyticsMetadata; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Pinpoint analytics metadata for collecting metrics for
|
|||
|
|
* <code>InitiateAuth</code> calls.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool AnalyticsMetadataHasBeenSet() const { return m_analyticsMetadataHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Pinpoint analytics metadata for collecting metrics for
|
|||
|
|
* <code>InitiateAuth</code> calls.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetAnalyticsMetadata(const AnalyticsMetadataType& value) { m_analyticsMetadataHasBeenSet = true; m_analyticsMetadata = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Pinpoint analytics metadata for collecting metrics for
|
|||
|
|
* <code>InitiateAuth</code> calls.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetAnalyticsMetadata(AnalyticsMetadataType&& value) { m_analyticsMetadataHasBeenSet = true; m_analyticsMetadata = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Pinpoint analytics metadata for collecting metrics for
|
|||
|
|
* <code>InitiateAuth</code> calls.</p>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithAnalyticsMetadata(const AnalyticsMetadataType& value) { SetAnalyticsMetadata(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Pinpoint analytics metadata for collecting metrics for
|
|||
|
|
* <code>InitiateAuth</code> calls.</p>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithAnalyticsMetadata(AnalyticsMetadataType&& value) { SetAnalyticsMetadata(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Contextual data such as the user's device fingerprint, IP address, or
|
|||
|
|
* location used for evaluating the risk of an unexpected event by Amazon Cognito
|
|||
|
|
* advanced security.</p>
|
|||
|
|
*/
|
|||
|
|
inline const UserContextDataType& GetUserContextData() const{ return m_userContextData; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Contextual data such as the user's device fingerprint, IP address, or
|
|||
|
|
* location used for evaluating the risk of an unexpected event by Amazon Cognito
|
|||
|
|
* advanced security.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool UserContextDataHasBeenSet() const { return m_userContextDataHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Contextual data such as the user's device fingerprint, IP address, or
|
|||
|
|
* location used for evaluating the risk of an unexpected event by Amazon Cognito
|
|||
|
|
* advanced security.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetUserContextData(const UserContextDataType& value) { m_userContextDataHasBeenSet = true; m_userContextData = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Contextual data such as the user's device fingerprint, IP address, or
|
|||
|
|
* location used for evaluating the risk of an unexpected event by Amazon Cognito
|
|||
|
|
* advanced security.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetUserContextData(UserContextDataType&& value) { m_userContextDataHasBeenSet = true; m_userContextData = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Contextual data such as the user's device fingerprint, IP address, or
|
|||
|
|
* location used for evaluating the risk of an unexpected event by Amazon Cognito
|
|||
|
|
* advanced security.</p>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithUserContextData(const UserContextDataType& value) { SetUserContextData(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Contextual data such as the user's device fingerprint, IP address, or
|
|||
|
|
* location used for evaluating the risk of an unexpected event by Amazon Cognito
|
|||
|
|
* advanced security.</p>
|
|||
|
|
*/
|
|||
|
|
inline InitiateAuthRequest& WithUserContextData(UserContextDataType&& value) { SetUserContextData(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
private:
|
|||
|
|
|
|||
|
|
AuthFlowType m_authFlow;
|
|||
|
|
bool m_authFlowHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::Map<Aws::String, Aws::String> m_authParameters;
|
|||
|
|
bool m_authParametersHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::Map<Aws::String, Aws::String> m_clientMetadata;
|
|||
|
|
bool m_clientMetadataHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::String m_clientId;
|
|||
|
|
bool m_clientIdHasBeenSet;
|
|||
|
|
|
|||
|
|
AnalyticsMetadataType m_analyticsMetadata;
|
|||
|
|
bool m_analyticsMetadataHasBeenSet;
|
|||
|
|
|
|||
|
|
UserContextDataType m_userContextData;
|
|||
|
|
bool m_userContextDataHasBeenSet;
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
} // namespace Model
|
|||
|
|
} // namespace CognitoIdentityProvider
|
|||
|
|
} // namespace Aws
|