Amazon Cognito · Schema

EventContextDataType

Specifies the user context data captured at the time of an event request.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
IpAddress object
DeviceName object
Timezone object
City object
Country object
View JSON Schema on GitHub

JSON Schema

user-pools-event-context-data-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-event-context-data-type-schema.json",
  "title": "EventContextDataType",
  "description": "Specifies the user context data captured at the time of an event request.",
  "type": "object",
  "properties": {
    "IpAddress": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The source IP address of your user's device."
        }
      ]
    },
    "DeviceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The user's device name."
        }
      ]
    },
    "Timezone": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The user's time zone."
        }
      ]
    },
    "City": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The user's city."
        }
      ]
    },
    "Country": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The user's country."
        }
      ]
    }
  }
}