Login: TFA Options
Display available TFA (Two-Factor Authentication) options for a user during login.
2 minute read
Login: TFA Options
Title: Login: TFA Options
| Type | object |
| Required | No |
| Additional properties | Not allowed |
Description: Display available TFA (Two-Factor Authentication) options for a user during login.
Example:
{
"option_name": {
"otp": "One-Time Password",
"webauthn": "WebAuthn"
},
"options": [
"otp",
"webauthn"
]
}
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - option_name | No | object or null | No | - | TFA Option Names |
| - options | No | array of string or null | No | - | TFA Options |
1. Property Login: TFA Options > option_name
Title: TFA Option Names
| Type | object or null |
| Required | No |
Description: Map of TFA option IDs to human-readable names
Example:
{
"otp": "One-Time Password",
"webauthn": "WebAuthn"
}
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | string | No | - | - |
1.1. Property Login: TFA Options > option_name > additionalProperties
| Type | string |
| Required | No |
2. Property Login: TFA Options > options
Title: TFA Options
| Type | array of string or null |
| Required | No |
Description: List of available TFA option IDs for the user
Examples:
"otp"
"webauthn"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| options items | - |
2.1. Login: TFA Options > options > options items
| Type | string |
| Required | No |