Amazon Cognito · JSON Structure

User Pools Risk Configuration Type Structure

The risk configuration type.

Type: object Properties: 6
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

RiskConfigurationType is a JSON Structure definition published by Amazon Cognito, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

UserPoolId ClientId CompromisedCredentialsRiskConfiguration AccountTakeoverRiskConfiguration RiskExceptionConfiguration LastModifiedDate

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-risk-configuration-type-structure.json",
  "name": "RiskConfigurationType",
  "description": "The risk configuration type.",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID."
        }
      ]
    },
    "ClientId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientIdType"
        },
        {
          "description": "The app client ID."
        }
      ]
    },
    "CompromisedCredentialsRiskConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CompromisedCredentialsRiskConfigurationType"
        },
        {
          "description": "The compromised credentials risk configuration object, including the <code>EventFilter</code> and the <code>EventAction</code>."
        }
      ]
    },
    "AccountTakeoverRiskConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountTakeoverRiskConfigurationType"
        },
        {
          "description": "The account takeover risk configuration object, including the <code>NotifyConfiguration</code> object and <code>Actions</code> to take if there is an account takeover."
        }
      ]
    },
    "RiskExceptionConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RiskExceptionConfigurationType"
        },
        {
          "description": "The configuration to override the risk decision."
        }
      ]
    },
    "LastModifiedDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DateType"
        },
        {
          "description": "The date and time, in <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html\">ISO 8601</a> format, when the item was modified."
        }
      ]
    }
  }
}