Generate WebAuthn recovery token

Generate a recovery token for a WebAuthn account

POST/{apiBasePath}/{tenantId}/webauthn/recover/account/token

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

tenantIdstring

The tenant against which the request is made. If left empty, the default tenant will be used.

Header parameters

ridstring

The WebAuthn recipe ID

Request body

application/json

emailemailrequired

Email address

Responses

200Recovery token generation response

One of:

object

statusstatusOK

Success status indicator

Allowed:OK

generalErrorResponse

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

object

statusstring

Allowed:RECOVER_ACCOUNT_NOT_ALLOWED

reasonstring

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the usertenantIdpath*The tenant against which the request is made. If left empty, the default tenant will be used.ridheaderThe WebAuthn recipe ID

Bodyapplication/json

emailstring*Email address

Request

curl -X POST "/auth/public/webauthn/recover/account/token" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "[email protected]"
}'

const response = await fetch("/auth/public/webauthn/recover/account/token", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "email": "[email protected]"
})
});

import requests

response = requests.post(
    "/auth/public/webauthn/recover/account/token",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "email": "[email protected]"
},
)

Response

{
  "status": "OK"
}

"Not Found"

"Internal Error"