Amazon Cognito · Schema

RiskConfigurationType

The risk configuration type.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
UserPoolId object
ClientId object
CompromisedCredentialsRiskConfiguration object
AccountTakeoverRiskConfiguration object
RiskExceptionConfiguration object
LastModifiedDate object
View JSON Schema on GitHub

JSON Schema

user-pools-risk-configuration-type-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-risk-configuration-type-schema.json",
  "title": "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."
        }
      ]
    }
  }
}