/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace CognitoIdentityProvider { namespace Model { /** *

Initiates the authentication request.

*/ class InitiateAuthRequest : public CognitoIdentityProviderRequest { public: AWS_COGNITOIDENTITYPROVIDER_API 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_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override; AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The authentication flow for this call to run. The API action will depend on * this value. For example:

REFRESH_TOKEN_AUTH takes * in a valid refresh token and returns new tokens.
* USER_SRP_AUTH takes in USERNAME and SRP_A * and returns the SRP variables to be used for next challenge execution.
USER_PASSWORD_AUTH takes in USERNAME and * PASSWORD and returns the next challenge or tokens.

Valid values include:

USER_SRP_AUTH: * Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: * Authentication flow for refreshing the access token and ID token by supplying a * valid refresh token.
CUSTOM_AUTH: Custom * authentication flow.
USER_PASSWORD_AUTH: Non-SRP * authentication flow; user name and password are passed directly. If a user * migration Lambda trigger is set, this flow will invoke the user migration Lambda * if it doesn't find the user name in the user pool.

* ADMIN_NO_SRP_AUTH isn't a valid value.

*/ inline const AuthFlowType& GetAuthFlow() const{ return m_authFlow; } /** *

The authentication flow for this call to run. The API action will depend on * this value. For example:

REFRESH_TOKEN_AUTH takes * in a valid refresh token and returns new tokens.
* USER_SRP_AUTH takes in USERNAME and SRP_A * and returns the SRP variables to be used for next challenge execution.
USER_PASSWORD_AUTH takes in USERNAME and * PASSWORD and returns the next challenge or tokens.

Valid values include:

USER_SRP_AUTH: * Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: * Authentication flow for refreshing the access token and ID token by supplying a * valid refresh token.
CUSTOM_AUTH: Custom * authentication flow.
USER_PASSWORD_AUTH: Non-SRP * authentication flow; user name and password are passed directly. If a user * migration Lambda trigger is set, this flow will invoke the user migration Lambda * if it doesn't find the user name in the user pool.

* ADMIN_NO_SRP_AUTH isn't a valid value.

*/ inline bool AuthFlowHasBeenSet() const { return m_authFlowHasBeenSet; } /** *

The authentication flow for this call to run. The API action will depend on * this value. For example:

REFRESH_TOKEN_AUTH takes * in a valid refresh token and returns new tokens.
* USER_SRP_AUTH takes in USERNAME and SRP_A * and returns the SRP variables to be used for next challenge execution.
USER_PASSWORD_AUTH takes in USERNAME and * PASSWORD and returns the next challenge or tokens.

Valid values include:

USER_SRP_AUTH: * Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: * Authentication flow for refreshing the access token and ID token by supplying a * valid refresh token.
CUSTOM_AUTH: Custom * authentication flow.
USER_PASSWORD_AUTH: Non-SRP * authentication flow; user name and password are passed directly. If a user * migration Lambda trigger is set, this flow will invoke the user migration Lambda * if it doesn't find the user name in the user pool.

* ADMIN_NO_SRP_AUTH isn't a valid value.

*/ inline void SetAuthFlow(const AuthFlowType& value) { m_authFlowHasBeenSet = true; m_authFlow = value; } /** *

The authentication flow for this call to run. The API action will depend on * this value. For example:

REFRESH_TOKEN_AUTH takes * in a valid refresh token and returns new tokens.
* USER_SRP_AUTH takes in USERNAME and SRP_A * and returns the SRP variables to be used for next challenge execution.
USER_PASSWORD_AUTH takes in USERNAME and * PASSWORD and returns the next challenge or tokens.

Valid values include:

USER_SRP_AUTH: * Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: * Authentication flow for refreshing the access token and ID token by supplying a * valid refresh token.
CUSTOM_AUTH: Custom * authentication flow.
USER_PASSWORD_AUTH: Non-SRP * authentication flow; user name and password are passed directly. If a user * migration Lambda trigger is set, this flow will invoke the user migration Lambda * if it doesn't find the user name in the user pool.

* ADMIN_NO_SRP_AUTH isn't a valid value.

*/ inline void SetAuthFlow(AuthFlowType&& value) { m_authFlowHasBeenSet = true; m_authFlow = std::move(value); } /** *

The authentication flow for this call to run. The API action will depend on * this value. For example:

REFRESH_TOKEN_AUTH takes * in a valid refresh token and returns new tokens.
* USER_SRP_AUTH takes in USERNAME and SRP_A * and returns the SRP variables to be used for next challenge execution.
USER_PASSWORD_AUTH takes in USERNAME and * PASSWORD and returns the next challenge or tokens.

Valid values include:

USER_SRP_AUTH: * Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: * Authentication flow for refreshing the access token and ID token by supplying a * valid refresh token.
CUSTOM_AUTH: Custom * authentication flow.
USER_PASSWORD_AUTH: Non-SRP * authentication flow; user name and password are passed directly. If a user * migration Lambda trigger is set, this flow will invoke the user migration Lambda * if it doesn't find the user name in the user pool.

* ADMIN_NO_SRP_AUTH isn't a valid value.

*/ inline InitiateAuthRequest& WithAuthFlow(const AuthFlowType& value) { SetAuthFlow(value); return *this;} /** *

The authentication flow for this call to run. The API action will depend on * this value. For example:

REFRESH_TOKEN_AUTH takes * in a valid refresh token and returns new tokens.
* USER_SRP_AUTH takes in USERNAME and SRP_A * and returns the SRP variables to be used for next challenge execution.
USER_PASSWORD_AUTH takes in USERNAME and * PASSWORD and returns the next challenge or tokens.

Valid values include:

USER_SRP_AUTH: * Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: * Authentication flow for refreshing the access token and ID token by supplying a * valid refresh token.
CUSTOM_AUTH: Custom * authentication flow.
USER_PASSWORD_AUTH: Non-SRP * authentication flow; user name and password are passed directly. If a user * migration Lambda trigger is set, this flow will invoke the user migration Lambda * if it doesn't find the user name in the user pool.

* ADMIN_NO_SRP_AUTH isn't a valid value.

*/ inline InitiateAuthRequest& WithAuthFlow(AuthFlowType&& value) { SetAuthFlow(std::move(value)); return *this;} /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline const Aws::Map& GetAuthParameters() const{ return m_authParameters; } /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline bool AuthParametersHasBeenSet() const { return m_authParametersHasBeenSet; } /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline void SetAuthParameters(const Aws::Map& value) { m_authParametersHasBeenSet = true; m_authParameters = value; } /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline void SetAuthParameters(Aws::Map&& value) { m_authParametersHasBeenSet = true; m_authParameters = std::move(value); } /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline InitiateAuthRequest& WithAuthParameters(const Aws::Map& value) { SetAuthParameters(value); return *this;} /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline InitiateAuthRequest& WithAuthParameters(Aws::Map&& value) { SetAuthParameters(std::move(value)); return *this;} /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline InitiateAuthRequest& AddAuthParameters(const Aws::String& key, const Aws::String& value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(key, value); return *this; } /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline InitiateAuthRequest& AddAuthParameters(Aws::String&& key, const Aws::String& value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(std::move(key), value); return *this; } /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline InitiateAuthRequest& AddAuthParameters(const Aws::String& key, Aws::String&& value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(key, std::move(value)); return *this; } /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline InitiateAuthRequest& AddAuthParameters(Aws::String&& key, Aws::String&& value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(std::move(key), std::move(value)); return *this; } /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline InitiateAuthRequest& AddAuthParameters(const char* key, Aws::String&& value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(key, std::move(value)); return *this; } /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline InitiateAuthRequest& AddAuthParameters(Aws::String&& key, const char* value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(std::move(key), value); return *this; } /** *

The authentication parameters. These are inputs corresponding to the * AuthFlow that you're invoking. The required values depend on the * value of AuthFlow:

For USER_SRP_AUTH: * USERNAME (required), SRP_A (required), * SECRET_HASH (required if the app client is configured with a client * secret), DEVICE_KEY.
For * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN * (required), SECRET_HASH (required if the app client is configured * with a client secret), DEVICE_KEY.
For * CUSTOM_AUTH: USERNAME (required), * SECRET_HASH (if app client is configured with client secret), * DEVICE_KEY. To start the authentication flow with password * verification, include ChallengeName: SRP_A and SRP_A: (The * SRP_A Value).

*/ inline InitiateAuthRequest& AddAuthParameters(const char* key, const char* value) { m_authParametersHasBeenSet = true; m_authParameters.emplace(key, value); return *this; } /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

You create custom workflows * by assigning Lambda functions to user pool triggers. When you use the * InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are * specified for various triggers. The ClientMetadata value is passed as input to * the functions for only the following triggers:

Pre signup
*
Pre authentication
User migration

When Amazon Cognito invokes the functions for these triggers, it passes * a JSON payload, which the function receives as input. This payload contains a * validationData attribute, which provides the data that you assigned * to the ClientMetadata parameter in your InitiateAuth request. In your function * code in Lambda, you can process the validationData value to enhance * your workflow for your specific needs.

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline const Aws::Map& GetClientMetadata() const{ return m_clientMetadata; } /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline bool ClientMetadataHasBeenSet() const { return m_clientMetadataHasBeenSet; } /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline void SetClientMetadata(const Aws::Map& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata = value; } /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline void SetClientMetadata(Aws::Map&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata = std::move(value); } /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline InitiateAuthRequest& WithClientMetadata(const Aws::Map& value) { SetClientMetadata(value); return *this;} /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline InitiateAuthRequest& WithClientMetadata(Aws::Map&& value) { SetClientMetadata(std::move(value)); return *this;} /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline InitiateAuthRequest& AddClientMetadata(const Aws::String& key, const Aws::String& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, value); return *this; } /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline InitiateAuthRequest& AddClientMetadata(Aws::String&& key, const Aws::String& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), value); return *this; } /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline InitiateAuthRequest& AddClientMetadata(const Aws::String& key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, std::move(value)); return *this; } /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline InitiateAuthRequest& AddClientMetadata(Aws::String&& key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), std::move(value)); return *this; } /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline InitiateAuthRequest& AddClientMetadata(const char* key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, std::move(value)); return *this; } /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline InitiateAuthRequest& AddClientMetadata(Aws::String&& key, const char* value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), value); return *this; } /** *

A map of custom key-value pairs that you can provide as input for certain * custom workflows that this action triggers.

Pre signup
*
Pre authentication
User migration

When you use the InitiateAuth API * action, Amazon Cognito also invokes the functions for the following triggers, * but it doesn't provide the ClientMetadata value as input:

Post * authentication
Custom message
Pre token * generation
Create auth challenge
Define auth * challenge
Verify auth challenge

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.

*/ inline InitiateAuthRequest& AddClientMetadata(const char* key, const char* value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, 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 InitiateAuthRequest& WithClientId(const Aws::String& value) { SetClientId(value); return *this;} /** *

The app client ID.

*/ inline InitiateAuthRequest& WithClientId(Aws::String&& value) { SetClientId(std::move(value)); return *this;} /** *

The app client ID.

*/ inline InitiateAuthRequest& WithClientId(const char* value) { SetClientId(value); return *this;} /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * InitiateAuth calls.

*/ inline const AnalyticsMetadataType& GetAnalyticsMetadata() const{ return m_analyticsMetadata; } /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * InitiateAuth calls.

*/ inline bool AnalyticsMetadataHasBeenSet() const { return m_analyticsMetadataHasBeenSet; } /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * InitiateAuth calls.

*/ inline void SetAnalyticsMetadata(const AnalyticsMetadataType& value) { m_analyticsMetadataHasBeenSet = true; m_analyticsMetadata = value; } /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * InitiateAuth calls.

*/ inline void SetAnalyticsMetadata(AnalyticsMetadataType&& value) { m_analyticsMetadataHasBeenSet = true; m_analyticsMetadata = std::move(value); } /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * InitiateAuth calls.

*/ inline InitiateAuthRequest& WithAnalyticsMetadata(const AnalyticsMetadataType& value) { SetAnalyticsMetadata(value); return *this;} /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * InitiateAuth calls.

*/ inline InitiateAuthRequest& WithAnalyticsMetadata(AnalyticsMetadataType&& value) { SetAnalyticsMetadata(std::move(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 const UserContextDataType& GetUserContextData() const{ return m_userContextData; } /** *

*/ inline bool UserContextDataHasBeenSet() const { return m_userContextDataHasBeenSet; } /** *

*/ inline void SetUserContextData(const UserContextDataType& value) { m_userContextDataHasBeenSet = true; m_userContextData = value; } /** *

*/ inline void SetUserContextData(UserContextDataType&& value) { m_userContextDataHasBeenSet = true; m_userContextData = std::move(value); } /** *

*/ inline InitiateAuthRequest& WithUserContextData(const UserContextDataType& value) { SetUserContextData(value); return *this;} /** *

*/ inline InitiateAuthRequest& WithUserContextData(UserContextDataType&& value) { SetUserContextData(std::move(value)); return *this;} private: AuthFlowType m_authFlow; bool m_authFlowHasBeenSet = false; Aws::Map m_authParameters; bool m_authParametersHasBeenSet = false; Aws::Map m_clientMetadata; bool m_clientMetadataHasBeenSet = false; Aws::String m_clientId; bool m_clientIdHasBeenSet = false; AnalyticsMetadataType m_analyticsMetadata; bool m_analyticsMetadataHasBeenSet = false; UserContextDataType m_userContextData; bool m_userContextDataHasBeenSet = false; }; } // namespace Model } // namespace CognitoIdentityProvider } // namespace Aws

See Also: