Amazon Cognito · Schema

VerifySoftwareTokenRequest

VerifySoftwareTokenRequest schema from Amazon Cognito API

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
AccessToken object
Session object
UserCode object
FriendlyDeviceName object
View JSON Schema on GitHub

JSON Schema

user-pools-verify-software-token-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-verify-software-token-request-schema.json",
  "title": "VerifySoftwareTokenRequest",
  "description": "VerifySoftwareTokenRequest schema from Amazon Cognito API",
  "type": "object",
  "properties": {
    "AccessToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "A valid access token that Amazon Cognito issued to the user whose software token you want to verify."
        }
      ]
    },
    "Session": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SessionType"
        },
        {
          "description": "The session that should be passed both ways in challenge-response calls to the service."
        }
      ]
    },
    "UserCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SoftwareTokenMFAUserCodeType"
        },
        {
          "description": "The one- time password computed using the secret code returned by <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html\">AssociateSoftwareToken</a>."
        }
      ]
    },
    "FriendlyDeviceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The friendly device name."
        }
      ]
    }
  },
  "required": [
    "UserCode"
  ]
}