Amazon Cognito · JSON Structure

Cognito Idp Verify Software Token Request Structure

VerifySoftwareTokenRequest schema from Amazon Cognito

Type: object Properties: 4 Required: 1
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

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

Properties

AccessToken Session UserCode FriendlyDeviceName

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

JSON Structure

Raw ↑ 
{
  "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"
  ],
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-verify-software-token-request-structure.json",
  "name": "VerifySoftwareTokenRequest",
  "description": "VerifySoftwareTokenRequest schema from Amazon Cognito"
}