Amazon Cognito · JSON Structure

User Pools Account Takeover Action Type Structure

Account takeover action type.

Type: object Properties: 2 Required: 2
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

AccountTakeoverActionType is a JSON Structure definition published by Amazon Cognito, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Notify EventAction

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-account-takeover-action-type-structure.json",
  "name": "AccountTakeoverActionType",
  "description": "Account takeover action type.",
  "type": "object",
  "properties": {
    "Notify": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountTakeoverActionNotifyType"
        },
        {
          "description": "Flag specifying whether to send a notification."
        }
      ]
    },
    "EventAction": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountTakeoverEventActionType"
        },
        {
          "description": "<p>The action to take in response to the account takeover action. Valid values are as follows:</p> <ul> <li> <p> <code>BLOCK</code> Choosing this action will block the request.</p> </li> <li> <p> <code>MFA_IF_CONFIGURED</code> Present an MFA challenge if user has configured it, else allow the request.</p> </li> <li> <p> <code>MFA_REQUIRED</code> Present an MFA challenge if user has configured it, else block the request.</p> </li> <li> <p> <code>NO_ACTION</code> Allow the user to sign in.</p> </li> </ul>"
        }
      ]
    }
  },
  "required": [
    "Notify",
    "EventAction"
  ]
}