REST APIEnterpriseUser

GET

Get the recovery codes for the given recovery code set ID. Requires the user_manage scope. Session must be unlocked using the Unlock endpoint, prior to hitting this route.

Path Params

  • recoveryCodeSetId string required
    The ID of the recovery code set

    at least 1 characters · matches ^[0-9a-f]{32}$

Responses

200
OK

Response Body

object

  • id string required

    matches ^[0-9a-f]{32}$

  • created string date-time required
    ISO 8601 string representation of date
  • codes array of objects required

    10 to 10 items

    codes object
    • code string required
      The recovery code
    • isActive boolean required
      Whether the recovery code is active
401
Unauthorized

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
404
Not Found

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id