MfaChallengeResponse

Fields

Password accepted; a second factor is required to finish.

4 fields

challenge_token · required

string

expires_in · required

integer

methods

array of string

mfa_required

boolean

Raw schema (JSON)

{
  "description": "Password accepted; a second factor is required to finish.\n\n``challenge_token`` is NOT an access token — it carries ``type:\n\"mfa_challenge\"`` and is rejected by ``get_current_user`` at the decode\nlayer. It is only accepted by ``POST /auth/mfa/verify``.",
  "properties": {
    "challenge_token": {
      "title": "Challenge Token",
      "type": "string"
    },
    "expires_in": {
      "title": "Expires In",
      "type": "integer"
    },
    "methods": {
      "items": {
        "type": "string"
      },
      "title": "Methods",
      "type": "array"
    },
    "mfa_required": {
      "const": true,
      "default": true,
      "title": "Mfa Required",
      "type": "boolean"
    }
  },
  "required": [
    "challenge_token",
    "expires_in"
  ],
  "title": "MfaChallengeResponse",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/auth/login — Login

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON