Amazon Cognito · JSON Structure

User Pools Verify User Attribute Request Structure

Represents the request to verify user attributes.

Type: object Properties: 3 Required: 3
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

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

Properties

AccessToken AttributeName Code

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-verify-user-attribute-request-structure.json",
  "name": "VerifyUserAttributeRequest",
  "description": "Represents the request to verify user attributes.",
  "type": "object",
  "properties": {
    "AccessToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify."
        }
      ]
    },
    "AttributeName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AttributeNameType"
        },
        {
          "description": "The attribute name in the request to verify user attributes."
        }
      ]
    },
    "Code": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConfirmationCodeType"
        },
        {
          "description": "The verification code in the request to verify user attributes."
        }
      ]
    }
  },
  "required": [
    "AccessToken",
    "AttributeName",
    "Code"
  ]
}