Enroll WebAuthn
The schema for enrolling a user in WebAuthn (Web Authentication) for two-factor authentication.
less than a minute
Enroll WebAuthn
- 1. Property
Enroll WebAuthn > error - 2. Property
Enroll WebAuthn > message - 3. Property
Enroll WebAuthn > options
Title: Enroll WebAuthn
| Type | object |
| Required | No |
| Additional properties | Not allowed |
Description: The schema for enrolling a user in WebAuthn (Web Authentication) for two-factor authentication.
Example:
{
"error": "Invalid credentials",
"message": "Logout successful",
"options": "<opaque string to be sent to the browser>"
}
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - error | No | string | No | - | Error |
| - message | No | string | No | - | Message |
| - options | No | string | No | - | WebAuthn Options |
1. Property Enroll WebAuthn > error
Title: Error
| Type | string |
| Required | No |
Description: Human-readable message to be displayed about an error that occurred
Example:
"Invalid credentials"
2. Property Enroll WebAuthn > message
Title: Message
| Type | string |
| Required | No |
Description: Human-readable message to display to the user. It being present is not indicative of an error
Example:
"Logout successful"
3. Property Enroll WebAuthn > options
Title: WebAuthn Options
| Type | string |
| Required | No |
Description: WebAuthn options for the user to enroll a new device