Amazon Cognito · Schema
ContextDataType
Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity
Properties
| Name | Type | Description |
|---|---|---|
| IpAddress | object | |
| ServerName | object | |
| ServerPath | object | |
| HttpHeaders | object | |
| EncodedData | object |
JSON Schema
{
"$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-context-data-type-schema.json",
"title": "ContextDataType",
"description": "Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.",
"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"
]
}