Enroll OTP
Enroll a user in One-Time Password (OTP) authentication.
less than a minute
Enroll OTP
- 1. Property
Enroll OTP > error - 2. Property
Enroll OTP > message - 3. Property
Enroll OTP > otp_secret - 4. Property
Enroll OTP > otp_url
Title: Enroll OTP
| Type | object |
| Required | No |
| Additional properties | Not allowed |
Description: Enroll a user in One-Time Password (OTP) authentication.
Example:
{
"error": "Invalid credentials",
"message": "Logout successful",
"otp_secret": "JBSWY3DPEHPK3PXP",
"otp_url": "otpauth://totp/Example:alice@google.com?secret=JBSWY3DPEHPK3PXP&issuer=Example"
}
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - error | No | string | No | - | Error |
| - message | No | string | No | - | Message |
| - otp_secret | No | string | No | - | OTP Secret |
| - otp_url | No | string | No | - | OTP URL |
1. Property Enroll OTP > 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 OTP > 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 OTP > otp_secret
Title: OTP Secret
| Type | string |
| Required | No |
Description: Secret for the OTP authenticator app
4. Property Enroll OTP > otp_url
Title: OTP URL
| Type | string |
| Required | No |
Description: URL to configure the OTP authenticator app