Amazon Cognito · Schema

RecoveryOptionType

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

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
Priority object
Name object
View JSON Schema on GitHub

JSON Schema

user-pools-recovery-option-type-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-recovery-option-type-schema.json",
  "title": "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"
  ]
}