Amazon Cognito · JSON Structure

User Pools Recovery Option Type Structure

A map containing a priority as a key, and recovery method name as a value.

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

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

Properties

Priority Name

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-recovery-option-type-structure.json",
  "name": "RecoveryOptionType",
  "description": "A map containing a priority as a key, and recovery method name as a value.",
  "type": "object",
  "properties": {
    "Priority": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PriorityType"
        },
        {
          "description": "A positive integer specifying priority of a method with 1 being the highest priority."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RecoveryOptionNameType"
        },
        {
          "description": "The recovery method for a user."
        }
      ]
    }
  },
  "required": [
    "Priority",
    "Name"
  ]
}