For a completed MFA enrollment regenerate the recovery codes

Changed on Jun 7, 2024

Allows regeneration of recovery codes of an MFA enrollment. Requires a current valid time based one time password to interact with. Available after a completed MFA enrollment. This replaces all existing recovery codes.

post/current-identity/mfa/recovery-codes

Request

Base URL
https://demo.ziti.dev/edge/client/v1
Auth
- API key in header zt-session
- or OAuth 2
  Authorization code/oidc/authorize
  Token URL/oidc/token
  Scopesopenid
TypeScript
https://skmtc.dev/openziti/apis/ziti-edge-client/docs/current-identity/mfa/recovery-codes/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

codestring required

Response

Base empty response

dataobject required

Example response

{
  "data": {},
  "meta": {
    "apiEnrollmentVersion": "apiEnrollmentVersion",
    "apiVersion": "apiVersion",
    "filterableFields": [
      "filterableFields",
      "filterableFields"
    ],
    "pagination": {
      "limit": 0.8008281904610115,
      "offset": 6.027456183070403,
      "totalCount": 1.4658129805029452
    }
  }
}

Changes

Jun 7, 202426670d8bbc37 Revision changes
- breaking
  removed the required property from the response with the status
- info
  added the required property to the response with the status
May 29, 2024cce2800c1357 Revision changes
- breaking
  removed the required property from the response with the status
- warning
  the optional response header WWW-Authenticate removed for the status 200
- warning
  the optional response header WWW-Authenticate removed for the status 401
- warning
  the optional response header WWW-Authenticate removed for the status 404
- info
  added the required property to the response with the status

Operation history