Amazon Cognito · Schema

AdminForgetDeviceRequest

Sends the forgot device request, as an administrator.

AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

Properties

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

JSON Schema

cognito-idp-admin-forget-device-request-schema.json Raw ↑
{
  "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"
  ],
  "description": "Sends the forgot device request, as an administrator.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-schema/cognito-idp-admin-forget-device-request-schema.json",
  "title": "AdminForgetDeviceRequest"
}