/

POST

Describes the risk configuration.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "ClientId": "string"
}'

Response Example

200 - Example 1

{
    "RiskConfiguration": {
        "UserPoolId": "string",
        "ClientId": "string",
        "CompromisedCredentialsRiskConfiguration": {
            "EventFilter": [],
            "Actions": {
                "EventAction": "BLOCK"
            }
        },
        "AccountTakeoverRiskConfiguration": {
            "NotifyConfiguration": {
                "From": "string",
                "ReplyTo": "string",
                "SourceArn": "string",
                "BlockEmail": {
                    "Subject": "string",
                    "HtmlBody": "string",
                    "TextBody": "string"
                },
                "NoActionEmail": {},
                "MfaEmail": {}
            },
            "Actions": {
                "LowAction": {
                    "Notify": true,
                    "EventAction": "BLOCK"
                },
                "MediumAction": {},
                "HighAction": {}
            }
        },
        "RiskExceptionConfiguration": {
            "BlockedIPRangeList": [],
            "SkippedIPRangeList": []
        },
        "LastModifiedDate": "string"
    }
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

UserPoolId

string

required

The user pool ID.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

ClientId

string <password>

optional

The app client ID.

>= 1 characters<= 128 characters

Match pattern:

[\w+]+

Examples

Responses

🟢200Success

application/json

Body

RiskConfiguration

object

required

The risk configuration.

UserPoolId

string

optional

The user pool ID.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

ClientId

string <password>

optional

The app client ID.

>= 1 characters<= 128 characters

Match pattern:

[\w+]+

CompromisedCredentialsRiskConfiguration

object

optional

The compromised credentials risk configuration object, including the EventFilter and the EventAction.

AccountTakeoverRiskConfiguration

object

optional

The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.

RiskExceptionConfiguration

object

optional

The configuration to override the risk decision.

LastModifiedDate

string <date-time>

optional

The last modified date.

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482TooManyRequestsException

🟠483NotAuthorizedException

🟠484UserPoolAddOnNotEnabledException

🟠485InternalErrorException

Modified at 2023-08-15 07:11:06