Amazon Cognito · JSON Structure

User Pools Confirm Device Request Structure

Confirms the device request.

Type: object Properties: 4 Required: 2
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

ConfirmDeviceRequest is a JSON Structure definition published by Amazon Cognito, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

AccessToken DeviceKey DeviceSecretVerifierConfig DeviceName

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-confirm-device-request-structure.json",
  "name": "ConfirmDeviceRequest",
  "description": "Confirms the device request.",
  "type": "object",
  "properties": {
    "AccessToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "A valid access token that Amazon Cognito issued to the user whose device you want to confirm."
        }
      ]
    },
    "DeviceKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceKeyType"
        },
        {
          "description": "The device key."
        }
      ]
    },
    "DeviceSecretVerifierConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceSecretVerifierConfigType"
        },
        {
          "description": "The configuration of the device secret verifier."
        }
      ]
    },
    "DeviceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceNameType"
        },
        {
          "description": "The device name."
        }
      ]
    }
  },
  "required": [
    "AccessToken",
    "DeviceKey"
  ]
}