MfaEnrollmentRequiredResponse

Fields

Password accepted; workspace policy requires MFA and the user has none.

4 fields

enrollment_token · required

string

expires_in · required

integer

mfa_enrollment_required

boolean

required_for_role

string or null

Raw schema (JSON)

{
  "description": "Password accepted; workspace policy requires MFA and the user has none.\n\n``enrollment_token`` carries ``type: \"mfa_enroll\"`` and is accepted only by\nthe two enrollment endpoints.",
  "properties": {
    "enrollment_token": {
      "title": "Enrollment Token",
      "type": "string"
    },
    "expires_in": {
      "title": "Expires In",
      "type": "integer"
    },
    "mfa_enrollment_required": {
      "const": true,
      "default": true,
      "title": "Mfa Enrollment Required",
      "type": "boolean"
    },
    "required_for_role": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Required For Role"
    }
  },
  "required": [
    "enrollment_token",
    "expires_in"
  ],
  "title": "MfaEnrollmentRequiredResponse",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/auth/invitations/accept — Accept Invitation
• POST /api/v1/auth/login — Login

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON