/auth/totp/recovery-codes

POST

const url = 'https://example.com/api/v1/auth/totp/recovery-codes';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"code":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/auth/totp/recovery-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example" }'

Authorizations

bearer

Request Body^required

application/json

object

code

required

string

/^\d{6}$/

Example^generated

{
  "code": "example"
}

Responses

200

Default Response

application/json

object

totpEnabled

required

boolean

totpUnreadable

required

boolean

recoveryCodesRemaining

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

recoveryCodes

required

Array<string>

Example^generated

{
  "totpEnabled": true,
  "totpUnreadable": true,
  "recoveryCodesRemaining": 1,
  "recoveryCodes": [
    "example"
  ]
}

/auth/totp/recovery-codes

Authorizations

Request Bodyrequired

Examplegenerated

Responses

200

Examplegenerated

Request Body^required

Example^generated

Example^generated