Amazon Cognito · JSON Structure

Cognito Idp Context Data Type Structure

Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Type: object Properties: 5 Required: 4
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

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

Properties

IpAddress ServerName ServerPath HttpHeaders EncodedData

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

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "IpAddress": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The source IP address of your user's device."
        }
      ]
    },
    "ServerName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "Your server endpoint where this API is invoked."
        }
      ]
    },
    "ServerPath": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "Your server path where this API is invoked."
        }
      ]
    },
    "HttpHeaders": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HttpHeaderList"
        },
        {
          "description": "HttpHeaders received on your server in same order."
        }
      ]
    },
    "EncodedData": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint\">Adding user device and session data to API requests</a>."
        }
      ]
    }
  },
  "required": [
    "IpAddress",
    "ServerName",
    "ServerPath",
    "HttpHeaders"
  ],
  "description": "Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-context-data-type-structure.json",
  "name": "ContextDataType"
}