SetRiskConfigurationRequest Class

Container for the parameters to the SetRiskConfiguration operation. Configures threat protection for a user pool or app client. Sets configuration for the following.

Responses to risks with adaptive authentication
Responses to vulnerable passwords with compromised-credentials detection
Notifications to users who have had risky activity detected
IP-address denylist and allowlist

To set the risk configuration for the user pool to defaults, send this request with only the UserPoolId parameter. To reset the threat protection settings of an app client to be inherited from the user pool, send UserPoolId and ClientId parameters only. To change threat protection to audit-only or off, update the value of UserPoolAddOns in an UpdateUserPool request. To activate this setting, your user pool must be on the Plus tier.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.SetRiskConfigurationRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public class SetRiskConfigurationRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The SetRiskConfigurationRequest type exposes the following members

Constructors

	Name	Description
	SetRiskConfigurationRequest()

Properties

Name	Type	Description
AccountTakeoverRiskConfiguration	Amazon.CognitoIdentityProvider.Model.AccountTakeoverRiskConfigurationType	Gets and sets the property AccountTakeoverRiskConfiguration. The settings for automated responses and notification templates for adaptive authentication with threat protection.
ClientId	System.String	Gets and sets the property ClientId. The ID of the app client where you want to set a risk configuration. If `ClientId` is null, then the risk configuration is mapped to `UserPoolId`. When the client ID is null, the same risk configuration is applied to all the clients in the userPool. When you include a `ClientId` parameter, Amazon Cognito maps the configuration to the app client. When you include both `ClientId` and `UserPoolId`, Amazon Cognito maps the configuration to the app client only.
CompromisedCredentialsRiskConfiguration	Amazon.CognitoIdentityProvider.Model.CompromisedCredentialsRiskConfigurationType	Gets and sets the property CompromisedCredentialsRiskConfiguration. The configuration of automated reactions to detected compromised credentials. Includes settings for blocking future sign-in requests and for the types of password-submission events you want to monitor.
RiskExceptionConfiguration	Amazon.CognitoIdentityProvider.Model.RiskExceptionConfigurationType	Gets and sets the property RiskExceptionConfiguration. A set of IP-address overrides to threat protection. You can set up IP-address always-block and always-allow lists.
UserPoolId	System.String	Gets and sets the property UserPoolId. The ID of the user pool where you want to set a risk configuration. If you include `UserPoolId` in your request, don't include `ClientId`. When the client ID is null, the same risk configuration is applied to all the clients in the userPool. When you include both `ClientId` and `UserPoolId`, Amazon Cognito maps the configuration to the app client only.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5