Amazon Cognito · Schema

AdminForgetDeviceRequest

Sends the forgot device request, as an administrator.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
UserPoolId object
Username object
DeviceKey object
View JSON Schema on GitHub

JSON Schema

user-pools-admin-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-admin-forget-device-request-schema.json",
  "title": "AdminForgetDeviceRequest",
  "description": "Sends the forgot device request, as an administrator.",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UsernameType"
        },
        {
          "description": "The user name."
        }
      ]
    },
    "DeviceKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceKeyType"
        },
        {
          "description": "The device key."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "Username",
    "DeviceKey"
  ]
}