enablePropagateAdditionalUserContextData
When EnablePropagateAdditionalUserContextData
is true, Amazon Cognito accepts an IpAddress
value that you send in the UserContextData
parameter. The UserContextData
parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData
when you sign in Amazon Cognito native users with the InitiateAuth
and RespondToAuthChallenge
API operations.
When EnablePropagateAdditionalUserContextData
is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData
doesn't affect whether you can send a source IP address in a ContextData
parameter with the authenticated API operations AdminInitiateAuth
and AdminRespondToAuthChallenge
.
You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.