Amazon Cognito · Schema

ForgetDeviceRequest

Represents the request to forget the device.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
AccessToken object
DeviceKey object
View JSON Schema on GitHub

JSON Schema

user-pools-forget-device-request-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-forget-device-request-schema.json",
  "title": "ForgetDeviceRequest",
  "description": "Represents the request to forget the device.",
  "type": "object",
  "properties": {
    "AccessToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "A valid access token that Amazon Cognito issued to the user whose registered device you want to forget."
        }
      ]
    },
    "DeviceKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceKeyType"
        },
        {
          "description": "The device key."
        }
      ]
    }
  },
  "required": [
    "DeviceKey"
  ]
}