Auth

Complete MFA login with a single-use recovery code

post/auth/login/recovery-code

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/auth/login/recovery-code
  • Auth: none required

Request body

$schemastring uri

A URL to the JSON Schema for this object.

codestring required

Single-use MFA recovery code

mfa_tokenstring required

Pending MFA challenge token

Example request

{
  "$schema": "https://example.com/api/v1/schemas/VerifyRecoveryCodeLoginInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

email_delivery_status'sent' | 'failed'

Whether the latest verification email delivery request succeeded

email_verification_emailstring

Email address receiving the verification code

email_verification_idstring

Opaque email verification challenge ID

mfa_methodsstring[] nullable

MFA verification methods available for this login challenge

mfa_tokenstring

Pending MFA token for follow-up verification

requires_email_verificationboolean required

Whether a six-digit email code must be confirmed before sign-in

requires_mfaboolean required

Whether the login requires a second factor

tokenstring

JWT authentication token

Example response

{
  "$schema": "https://example.com/api/v1/schemas/AuthOutputBody.json",
  "user": {
    "$schema": "https://example.com/api/v1/schemas/UserProfile.json"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.